| Method | get.blacklist_phone_numbers |
|---|---|
| Description | Getting blacklisted phone numbers |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agentTo obtain a list of client users, you must use the method "get.customer_users" |
limit |
number | no | Number of records returned. See section "Paging" |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
filter |
object | no | See section "Filtering Criteria" |
fields |
array | no | See "View of Returned Data" |
sort |
array | no | See section "Sorting data" |
Response parameters
| Name | Type | Filtering | Sorting | Description |
|---|---|---|---|---|
id |
number | yes | yes | Unique identifier of the phone number in the blacklist |
phone_number |
string | yes | yes | 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 left when adding a phone number to the blacklist |
add_date_time |
iso8601 | yes | yes | Date and time of adding the phone number to the black list.YYYY-MM-DD hh:mm:ss |
JSON request structure```json
{ "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"
]
} }
### JSON response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": [
{
"id": "number",
"phone_number": "string",
"add_user_name": "string",
"add_comment": "string",
"add_date_time": "iso8601"
}
],
"metadata": "object"
}
}
List of returned errors
See the section "List of errors for methods with the verb get"