Retrieves a list of blacklisted phone numbers

Method	get.blacklist_phone_numbers
Description	Retrieves a list of blacklisted phone numbers
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".
limit	number	no	Maximum number of records to return. See the "Paging" section.
offset	number	no	Number of records to skip before returning results. Default: 0. See the "Paging" section.
filter	object	no	Filtering criteria. See the "Filters" section.
fields	array	no	Fields to include in the response. See the "Viewing returned data" section.
sort	array	no	Sorting criteria. See the "Data sorting" section.

Response parameters

Name	Type	Filtering	Sorting	Description
id	number	yes	yes	Unique ID of the blacklist entry
phone_number	string	yes	yes	Blacklisted phone number
add_user_name	string	yes	yes	Name of the user who added the phone number to the blacklist
add_comment	string	yes	yes	Comment added when the phone number was blacklisted
add_date_time	iso8601	yes	yes	Date and time when the phone number was added to the blacklist. Format: YYYY-MM-DD hh:mm:ss

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "get.blacklist_phone_numbers",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "offset": "number",
        "limit": "number",
        "filter": {},
        "sort": [
            {
                "field": "string",
                "order": "string"
            }
        ],
        "fields": [
            "string"
        ]
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {},
        "data": [
            {
                "id": "number",
                "phone_number": "string",
                "add_user_name": "string",
                "add_comment": "string",
                "add_date_time": "iso8601"
            }
        ]
    }
}

List of returned errors

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