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"


mandatory

999123123

List of MSISD's which you want the action to apply to

"criteriaPrimary"


mandatory

SERVICE_KEY
or
CONTENT_TYPE

Criteria by which blacklist will be executed

"valuePrimary"


mandatory

f31a355df6dad07e49ba474db7ff9b07
or
GAMING

Value of the criteria

"criteriaSecondary"


mandatory

NONE

this is not needed to explain now, for now just send value NONE

"valueSecondary"


mandatory

NONE

this is not needed to explain now, for now just send value NONE

"reason"


mandatory for ADD method

user initiated blacklist
or
suspicious activity

Classic text field where reason for blacklist can be written down

"blacklisted"

(check method)

true
false

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

[
{
"msisdn": "666123123",
"blacklisted": false
},
{
"msisdn": "444123123",
"blacklisted": true
}
]

You will get the list of all MSIDNs sent in request, with the info if each of them is blacklisted or not.

ADD


{
"successful":[
"666123123",
"444123123"
],
"failed": null
}

You will get the list of all MSIDNs sent in request, divided into 2 lists: successful and unsuccessful,
showing which ones were blacklisted successfully and which are not.

REMOVE


{
"successful": [
"666123123",
"232345645"
],
"failed": 444123123
}

You will get the list of all MSIDNs sent in request, divided into 2 lists: successful and unsuccessful,
showing which ones were un-blacklisted successfully and which are not.