GET /ott/v1/registration/{platform}

Retrieves paginated collection of registered OTT properties by OTT Platform.

NameTypeDescription
platformstringRequiredOTT Platform Name of property
$pagenumberPage number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the $pagesize parameter.
$pagesizenumberNumber of results per page to return. Typically provided along with the $page parameter.
StatusNameTypeDescription
200  success
 countstringTotal count of the number of resources registered for a specific OTT network.
 pagestringPage Number of the results returned.
 pageSizestringPage size of the results returned.
 linksobjectPagination links.
 links.selfobjectLink to the current page of result set.
 links.self.hrefstringURL to the current page of the result set.
 links.previousobjectLink to the previous page of result set.
 links.previous.hrefstringURL to the previous page of the result set.
 links.nextobjectLink to the next page of result set.
 links.next.hrefstringURL to the next page of the result set.
 itemsarrayIndicates the name of the OTT network the resource is being registered with values: line, messenger.
 items.ottPlatformNamestringIndicate the name of the OTT network the resource is being registered with values: line, messenger.
 items.ottPlatformAttributesobjectObject containing OTT platform attributes.
 items.ottPlatformAttributes.applicationIdstringFacebook Application Id. Required for registering Messenger resource.
 items.ottPlatformAttributes.pageIdstringFacebook Page Id. Required for registering Messenger resource.
 items.ottPlatformAttributes.pageNamestringFacebook Page Name. Required for registering Messenger resource.
 items.ottPlatformAttributes.endpointUrlstringSend API url of the OTT network.
 items.ottPlatformAttributes.isActiveintegerIndicate if the OTT resource is active with values: 0 (Inactive), 1 (Active).
 items.ottPlatformAttributes.channelIdstringLINE channel Id. Required for registering LINE resource.
 items.ottPlatformAttributes.channelNamestringLINE channel name. Required for registering LINE resource.
 items.ottPlatformAttributes.isTransactionalintegerIndicate if LINE channel is Transactional or Reseller with values: 0 (Reseller), 1 (Transactional).
 items.ottPlatformAttributes.isTestChannelintegerIndicate if LINE channel is a Test channel with values: 0 (Not a test channel), 1 (test channel).
    
400  Bad Request
 messagestringError message.
 errorcodenumberError code.
 documentationstringDocumentation for the error code.
 validationErrorsarrayValidation errors in the request payload.
    
403  Forbidden
 messagestringError message.
 errorcodenumberError code.
 documentationstringDocumentation for the error code.
    
404  Not Found
 messagestringError message.
 errorcodenumberError code.
 documentationstringDocumentation for the error code.