POST /ott/v1/registration
Register a property for a specific OTT platform. If you try to register a Messenger Page ID or LINE Channel ID resource that already exists in Marketing Cloud, the details in the request payload override the details in Marketing Cloud.
Name | Type | | Description |
---|
ottPlatformName | string | Required | Indicate the name of the OTT network the resource is being registered with values: line, messenger. |
ottPlatformAttributes | object | Required | Object containing OTT platform attributes. |
ottPlatformAttributes.applicationId | string | | Facebook Application Id. Required for registering Messenger resource. |
ottPlatformAttributes.applicationSecret | string | | Facebook Application Secret. Required for registering Messenger resource. |
ottPlatformAttributes.pageId | string | | Facebook Page Id. Required for registering Messenger resource. |
ottPlatformAttributes.pageName | string | | Facebook Page Name. Required for registering Messenger resource. |
ottPlatformAttributes.pageAccessToken | string | | Access Token required to authenticate send messages requests to OTT networks. |
ottPlatformAttributes.endpointUrl | string | | Send API url of the OTT network. |
ottPlatformAttributes.callbackVerifyToken | string | | Facebook Verify Token need to verify callback events. |
ottPlatformAttributes.isActive | integer | | Indicate 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.channelSecret | string | | LINE channel secret. Required for registering LINE resource. |
ottPlatformAttributes.customerConnectSecret | string | | LINE Customer Connect Secret needed for validating LINE inbound events when using Switcher API. |
ottPlatformAttributes.isTransactional | integer | | Indicate if LINE channel is Transactional or Reseller with values: 0 (Reseller), 1 (Transactional). |
ottPlatformAttributes.isTestChannel | integer | | Indicate if LINE channel is a Test channel with values: 0 (Not a test channel), 1 (test channel). |
Status | Name | Type | Description |
---|
201 | | | success |
| | | |
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. |
Message | Details |
---|
OttPlatformName is invalid | The ottPlatformName is invalid in the request payload. The only supported values are line and messenger . |
OttPlatformAttributes is invalid | The ottPlatformAttribute object is empty or missing in the request payload. |
EndpointUrl must be provided | endpointUrl is empty or missing in the registration request payload. |
IsActive must be provided | isActive is empty or missing in the registration request payload. |
ApplicationId must be provided | MESSENGER only: applicationId is empty or missing in the registration request payload. |
ApplicationSecret must be provided | MESSENGER only: applicationSecret is empty or missing in the registration request payload. |
PageId must be provided | MESSENGER only: pageId is empty or missing in the registration request payload. |
PageName must be provided | MESSENGER only: pageName is empty or missing in the registration request payload. |
PageAccessToken must be provided | MESSENGER only: pageAccessToken is empty or missing in the registration request payload. |
CallbackVerifyToken must be provided | MESSENGER only: callbackVerifyToken is empty or missing in the registration request payload. |
ChannelId must be provided | LINE only: channelId is empty or missing in the registration request payload. |
ChannelName must be provided | LINE only: channelName is empty or missing in the registration request payload. |
ChannelSecret must be provided | LINE only: channelSecret is empty or missing in the registration request payload. |
isTransactional must be provided | LINE only: isTransactional is empty or missing in the registration request payload. |
isTestChannel must be provided | LINE only: isTestChannel is empty or missing in the registration request payload. |