GET /ott/v1/registration/{platform}/{ottPropertyId}

Overview

Retrieves information about a registered OTT property by Platform and ID.

URL Parameters

Name	Type		Description
platform	string	Required	OTT Platform Name of the property.
ottPropertyId	string	Required	ID of the OTT property

Responses

Status	Name	Type	Description
200			Success
	ottPlatformName	string	Indicates the name of the OTT network the resource is being registered with values: line, messenger.
	ottPlatformAttributes	object	Object containing OTT platform attributes.
	ottPlatformAttributes.applicationId	string	Facebook Application Id.
	ottPlatformAttributes.pageId	string	Facebook Page Id.
	ottPlatformAttributes.pageName	string	Facebook Page Name.
	ottPlatformAttributes.endpointUrl	string	Send API url of the OTT network.
	ottPlatformAttributes.isActive	integer	Indicates if the OTT resource is active with values: 0 (Inactive), 1 (Active).
	ottPlatformAttributes.channelId	string	LINE channel Id. Required for registering LINE resource.
	ottPlatformAttributes.channelName	string	LINE channel name. Required for registering LINE resource.
	ottPlatformAttributes.isTransactional	integer	Indicates if LINE channel is Transactional or Reseller with values: 0 (Reseller), 1 (Transactional).
	ottPlatformAttributes.isTestChannel	integer	Indicates if LINE channel is a Test channel with values: 0 (Not a test channel), 1 (test channel).

400			Bad Request
	message	string	Error message.
	errorcode	number	Error code.
	documentation	string	Documentation for the error code.
	validationErrors	array	Validation errors in the request payload.

403			Forbidden
	message	string	Error message.
	errorcode	number	Error code.
	documentation	string	Documentation for the error code.

404			Not Found
	message	string	Error message.
	errorcode	number	Error code.
	documentation	string	Documentation for the error code.

Usage

Example Request: Retrieve a Messenger Resource

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2GET /ott/v1/registration/messenger/1732555047025799
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response: Retrieve a Messenger Resource

1HTTP/1.1 200 OK
2
3{
4    "ottPlatformName" : "messenger",
5    "ottPlatformAttributes" : {
6        "applicationId" : "1093076390764037",
7        "pageId" : "1732555047025799",
8        "pageName" : "SFMC Engineers",
9        "endpointUrl" : "https://example.com/1732555047025799",
10        "isTransactional" : true,
11        "isTestChannel": false,
12        "isActive": true,
13        "apiVersion" : "v2.0"
14    }
15}

Example Request: Retrieve a LINE Resource

1Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
2GET /ott/v1/registration/line/1093076390764037
3Content-Type: application/json
4Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response: Retrieve a LINE Resource

1HTTP/1.1 200 OK
2
3{
4    "ottPlatformName" : "line",
5    "ottPlatformAttributes" : {
6        "channelId" : "1093076390764037",
7        "channelName" : "SFMC Engineers",
8        "endpointUrl" : "https://example.com/1732555047025799",
9        "isTransactional" : true,
10        "isTestChannel": false,
11        "isActive": true,
12        "apiVersion" : "v2.0"
13    }
14}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!