Подключение виртуального номера
| Метод | enable.virtual_numbers |
|---|---|
| Описание | Подключение виртуального номера |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
virtual_phone_number |
string | нет | Виртуальнй номер. Заполняется один из параметров virtual_phone_number или number_capacity_ids |
number_capacity_ids |
array of string | нет | Массив идентификаторов номеров. Заполняется один из параметров virtual_phone_number или number_capacity_ids |
number_capacity_component |
string | нет | Компонент номера (va, call_tracking) Обязателен, если передается number_capacity_ids |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента |
JSON структура запроса
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"method": "enable.virtual_numbers",
"params": {
"access_token": "string",
"user_id": "number",
"virtual_phone_number": "string"
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"success": true
}
}
Список возвращаемых ошибок
| Текст ошибки | Код ошибки | Мнемоника ошибки |
|---|---|---|
| Action is not allowed for your tariff plan. You need contact support service or change your tariff plan settings in your account | -32602 | tariff_restrictions |
| Virtual phone number {virtual_phone_number} not found. | -32007 | virtual_phone_number_not_found |
Смотрим раздел "Список ошибок для методов с глаголом get"