| Method | disable.virtual_numbers |
|---|---|
| Description | Disabling a virtual number |
| Available to | Agent, Client |
Request parameters
| Title | Type | Required | Description |
|---|---|---|---|
access_token |
string | yes | Authentication session key |
virtual_phone_number |
string | no | Virtual number. One of the parameters virtual_phone_number or number_capacity_ids must be filled in |
number_capacity_ids |
array | no | ID of the virtual number in the CallGear number capacity. One of the parameters virtual_phone_number or number_capacity_ids must be filled in |
user_id |
number | no | Unique user identifier of the agent client on behalf of which the request is made Is required for the agent |
It is impossible to disable numbers that are associated with advertising campaigns. By disabling a number with the "uis" type, all settings associated with it are deleted
JSON request structure```json
{ "jsonrpc": "2.0", "id": "number", "method": "disable.virtual_numbers", "params": { "access_token": "string", "user_id": "number", "virtual_phone_number": "string" } }
### JSON response structure```json
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"success": true
}
}
List of returned errors
| Error text | Error code | Error mnemonics |
|---|---|---|
| You have interdependent entities | -32602 | dependency_error |
| Virtual phone number {virtual_phone_number} not found. | -32007 | virtual_phone_number_not_found |
See the section "List of errors for methods with the verb get"