POST /ott/v1/registration

Overview

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.

JSON Parameters

NameTypeDescription
ottPlatformNamestringRequiredIndicate the name of the OTT network the resource is being registered with values: line, messenger.
ottPlatformAttributesobjectRequiredObject containing OTT platform attributes.
ottPlatformAttributes.applicationIdstringFacebook Application Id. Required for registering Messenger resource.
ottPlatformAttributes.applicationSecretstringFacebook Application Secret. Required for registering Messenger resource.
ottPlatformAttributes.pageIdstringFacebook Page Id. Required for registering Messenger resource.
ottPlatformAttributes.pageNamestringFacebook Page Name. Required for registering Messenger resource.
ottPlatformAttributes.pageAccessTokenstringAccess Token required to authenticate send messages requests to OTT networks.
ottPlatformAttributes.endpointUrlstringSend API url of the OTT network.
ottPlatformAttributes.callbackVerifyTokenstringFacebook Verify Token need to verify callback events.
ottPlatformAttributes.isActiveintegerIndicate if the OTT resource is active with values: 0 (Inactive), 1 (Active).
ottPlatformAttributes.channelIdstringLINE channel Id. Required for registering LINE resource.
ottPlatformAttributes.channelNamestringLINE channel name. Required for registering LINE resource
ottPlatformAttributes.channelSecretstringLINE channel secret. Required for registering LINE resource.
ottPlatformAttributes.customerConnectSecretstringLINE Customer Connect Secret needed for validating LINE inbound events when using Switcher API.
ottPlatformAttributes.isTransactionalintegerIndicate if LINE channel is Transactional or Reseller with values: 0 (Reseller), 1 (Transactional).
ottPlatformAttributes.isTestChannelintegerIndicate if LINE channel is a Test channel with values: 0 (Not a test channel), 1 (test channel).

Usage

Example Request: Register a Messenger Resource

Example Request: Register a LINE Resource

Example Success Response

Example Error Response

Possible Errors

MessageDetails
OttPlatformName is invalidThe ottPlatformName is invalid in the request payload. The only supported values are line and messenger.
OttPlatformAttributes is invalidThe ottPlatformAttribute object is empty or missing in the request payload.
EndpointUrl must be providedendpointUrl is empty or missing in the registration request payload.
IsActive must be providedisActive is empty or missing in the registration request payload.
ApplicationId must be providedMESSENGER only: applicationId is empty or missing in the registration request payload.
ApplicationSecret must be providedMESSENGER only: applicationSecret is empty or missing in the registration request payload.
PageId must be providedMESSENGER only: pageId is empty or missing in the registration request payload.
PageName must be providedMESSENGER only: pageName is empty or missing in the registration request payload.
PageAccessToken must be providedMESSENGER only: pageAccessToken is empty or missing in the registration request payload.
CallbackVerifyToken must be providedMESSENGER only: callbackVerifyToken is empty or missing in the registration request payload.
ChannelId must be providedLINE only: channelId is empty or missing in the registration request payload.
ChannelName must be providedLINE only: channelName is empty or missing in the registration request payload.
ChannelSecret must be providedLINE only: channelSecret is empty or missing in the registration request payload.
isTransactional must be providedLINE only: isTransactional is empty or missing in the registration request payload.
isTestChannel must be providedLINE only: isTestChannel is empty or missing in the registration request payload.