Deprecated
This JSON-RPC method is deprecated.
This method returns the 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 the broadcaster.
Parameters
Name | Type | Description |
---|---|---|
publisherToken* | string | Your publisher token |
Result Parameters
Name | Type | Description |
---|---|---|
terms | object | Terms and conditions |
broadcaster_terms | object | Terms and conditions set by broadcaster |
broadcaster_marketing | object | Marketing agreements set by broadcaster |
API Request/Response
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",
"label": "I accept the <a href=\"https:\/\/cleeng.com\/cleeng-user-agreement\" target=\"_blank\">Terms and Conditions<\/a> of Cleeng.",
"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"
}
ErrorCodes
Code | Description |
---|---|
3 | Invalid publisher token |
23 | User does not exist |
24 | Broadcaster did not set their consent definitions |