These docs are for v2.0. Click to read the latest docs for v2.1.

getAccessibleTags

Returns the list of tags for which the customer has entitlements (access rights). Use the response of this method to allow playback of video content (or offers) that have matching tags.

Entitlement checks are used as a base for reporting. You can see the recommended approach to using the entitlement methods here.

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken* stringYou can find your publisher token at api-keys page.
customerToken* stringToken that identifies the customer (see Must know about API).

Result Parameters

NameTypeDescription
tagsarrayList of tags

API Request/Response

Request

{
  "method":"getAccessibleTags",
  "params":{
     "publisherToken":"PpcZyAQbMF1yA33lcyv2OpYedaMDPtOB90sGGdxr9VDzYt",
     "customerToken":"V4AliQtKrz8ggbf3KE7W62ysYw9F-ITFHoxlkiy574rcxWG4g"
  },
  "jsonrpc":"2.0",
  "id":1
}

Response

{
  "result":{
    "tags":[
      "live",
      "vod"
    ]
  },
  "id":"1",
  "error":null,
  "jsonrpc":"2.0"
}

ErrorCodes

CodeDescription
1 Invalid customer token
3Invalid publisher token
5Access denied
11Invalid arguments