getConsentDefinitions()


This method returns broadcaster’s consents, along with their URL and the current version number. By default it will return terms and privacy consents, broadcaster_terms or broadcaster_marketing are set by broadcaster.

Parameters:

Name Type Description
publisherToken string Your publisher token

- required parameter

Response Parameters:

Name Type Description
terms object Terms and conditions
privacy object Pesonal data storage policy
broadcaster_terms object Terms and conditions set by broadcaster
broadcaster_marketing object Marketing agreements set by broadcaster

Error Codes:

Code Description
3 Invalid publisher token
23 User does not exist
24 Broadcaster did not set their consent definitions

Request:

{
    "method": "getConsentDefinitions",
    "params": {
        "publisherToken": "bD3TVNJYH1WTAErQxKpjl1k7fmAKZsIK0rKKtp5TdMgORmlg"
    },
    "jsonrpc": "2.0",
    "id": 1
}

Response:

{
    "result": {
        "terms": {
            "broadcasterId": 0,
            "name": "terms",
            "version": "1",
            "value": "https:\/\/cleeng.com\/legal",
            "required": true
        },
        "privacy": {
            "broadcasterId": 0,
            "name": "privacy",
            "version": "1",
            "value": "https:\/\/cleeng.com\/privacy",
            "required": true
        },
        "broadcaster_terms": {
            "broadcasterId": 123456789,
            "name": "broadcaster_terms",
            "version": "1",
            "value": "https:\/\/example.capture\/terms",
            "required": true
        },
        "broadcaster_marketing": {
            "broadcasterId": 123456789,
            "name": "broadcaster_marketing",
            "version": "1.7",
            "value": "Test value string",
            "required": false
        }
    },
    "id": "1",
    "jsonrpc": "2.0"
}

Remember! you can always check it by yourself using API Console - getConsentDefinitions()

Back to Customer API


We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.