Skip to content

Adds a phone number to the blacklist

Method create.phone_number_to_blacklist
Description Adds a phone number to the blacklist
Who has access Agents and clients

Request parameters

Name Type Required Description
access_token string yes Session key used to authenticate the request
user_id number no Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users".
phone_number string yes Phone number to add to the blacklist
add_comment string no Comment to associate with the blacklist entry

Response parameters

Name Type Required Description
id number yes Unique ID of the blacklist entry
phone_number string yes Phone number added to the blacklist

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "create.phone_number_to_blacklist",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "phone_number": "string",
        "add_comment": "string"
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": {
            "id": "number",
            "phone_number": "string"
        }
    }
}

List of returned errors

See the "List of errors for create methods" section.