Blacklist API
For Blacklist API you must use HTTP POST method in application/json format, sent to the following URL with parameters described below.
URL to which request should be posted
https://api.centili.com/v1/subscribers/subscribers/blacklist/check
https://api.centili.com/v1/subscribers/blacklist/add
https://api.centili.com/v1/subscribers/subscribers/blacklist/remove
Example 1 of POST request
https://api.centili.com/v1/subscribers/subscribers/blacklist/check
Method: POST
Content type: application/json
{
“msisdns” : [“999123123"],
“criteriaPrimary” : “SERVICE_KEY”,
“valuePrimary” : “testtest”,
“criteriaSecondary” : “NONE”,
“valueSecondary” : “NONE”,
“reason” : “some reason”
}
Example 2 of POST request
https://api.centili.com/v1/subscribers/blacklist/add
Method: POST
Content type: application/json
{
“msisdns” : [“999123123"],
“criteriaPrimary” : “CONTENT_TYPE”,
“valuePrimary” : “GAMING”,
“criteriaSecondary” : “NONE”,
“valueSecondary” : “NONE”,
“reason” : “some reason”
}
All parameters which You can send in request, or get in response
Parameter | Request | Response | Example of param value | Info |
---|---|---|---|---|
"msisdns" |
| 999123123 | List of MSISD's which you want the action to apply to | |
"criteriaPrimary" |
| SERVICE_KEY | Criteria by which blacklist will be executed | |
"valuePrimary" |
| f31a355df6dad07e49ba474db7ff9b07 | Value of the criteria | |
"criteriaSecondary" |
| NONE | this is not needed to explain now, for now just send value NONE | |
"valueSecondary" |
| NONE | this is not needed to explain now, for now just send value NONE | |
"reason" |
| user initiated blacklist | Classic text field where reason for blacklist can be written down | |
"blacklisted" | (check method) | true | Response parameter for CHECK method, which shows the info if each of MSIDNs is blacklisted or not. | |
"successful" | (add or remove method) | list of MSIDNs | List of all MSIDNs sent in ADD or REMOVE method request, which are successful (blacklisted or removed blacklist successfully) | |
"failed" | (add or remove method) | list of MSIDNs | List of all MSIDNs sent in ADD or REMOVE method request, which are failed (blacklisting or removing blacklist failed) |
Possible responses
For which request? | Response | Meaning |
---|---|---|
CHECK | [ | You will get the list of all MSIDNs sent in request, with the info if each of them is blacklisted or not. |
ADD | { | You will get the list of all MSIDNs sent in request, divided into 2 lists: successful and unsuccessful, |
REMOVE | { | You will get the list of all MSIDNs sent in request, divided into 2 lists: successful and unsuccessful, |
Updated over 1 year ago