3.3.2 Добавление нового правила переадресации
POST /vpbx/forwarding/number/add
Метод позволяет добавить новое правило безусловной переадресации на внутренний или внешний номер при звонке клиента. При добавлении новой переадресации для имеющегося в списке номера клиента
- возвращается ошибка, новое правило не добавляется. Опционально может содержать ID номера ВАТС (если переадресация осуществляется на него) и комментарий.
Входные параметры:
| № | Параметры с уровнями вложенности | Параметры с уровнями вложенности | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|---|
| № | 1 | 2 | Тип | Обяза-тель-ный | Описание |
| 1 | client_phone_number | string | Да | Номер, с которого поступает входящий звонок; указанный номер должен соответствовать типу номера, указанного в client_phone_type (если client_phone_type = 0, тогда client_phone_number - DID-номер; если client_phone_type = 1, тогда client_phone_number - SIP-номер), иначе метод возвращает ошибку. | |
| 2 | client_phone_type | bool | Да | Тип номера, с которого поступает входящий звонок (0 - телефон, 1 - SIP-Номер). | |
| 3 | status | bool | Да | Статус активности правила переадресации (0 - правило неактивно, 1 - правило активно). | |
| 4 | forward_type | string | Да | Тип переадресации (group - группа, user - сотрудник, ext_forward - внешний номер). | |
| 5 | forward_to_group | object | Обязательный, если в параметре "forward_type" указано значение "group" (иначе опциональный), данные при переадресации на группу. | ||
| 5.1 | forward_group_id | integer | Обязательный, если указан параметр "forward_to_group" (иначе опциональный), ID сотрудника, на которого осуществляется переадресация. | ||
| 6 | forward_to_user | object | Обязательный, если в параметре "forward_type" указано значение "user" (иначе опциональный), данные при переадресации на сотрудника, массив. | ||
| 6.1 | forward_user_id | integer | Обязательный, если указан параметр "forward_to_user" (иначе опциональный), ID сотрудника, на которого осуществляется переадресация. | ||
| 6.2 | forward_contact_id | string | Обязательный, если указан параметр "forward_to_user" (иначе опциональный), id контакта сотрудника, на который осуществляется переадресация, если передана пустая строка, то устанавливается номер по-умолчанию. | ||
| 7 | forward_to_ext | object | Обязательный, если в параметре "forward_type" указано значение "ext_forward" (иначе опциональный), массив данных при переадресации на внешний номер. | ||
| 7.1 | forward_number_type | bool | Обязательный, если указан параметр "forward_to_ext" (иначе опциональный), тип внешнего номера, на который осуществляется переадресация вызова (0 - телефон, 1 - SIP-Номер). | ||
| 7.2 | forward_number | string | Обязательный, если указан параметр "forward_to_ext" (иначе опциональный), внешний номер, на который осуществляется переадресация вызова. | ||
| 7.3 | forward_wait_sec | integer | Обязательный, если указан параметр "forward_to_ext" (иначе опциональный), время ожидания ответа абонента (в секундах) при переадресации на внешний номер. | ||
| 8 | comment | string | Комментарий. |
Пример запроса:
POST https://app.mango-office.ru/vpbx/forwarding/number/add
vpbx_api_key = 1234567890qwerty,
sign = 1234567890qwerty,
json =
{
"client_phone_number": "79993692503",
"client_phone_type": "0",
"forward_type": "ext_forward",
"forward_to_ext": {
"forward_number_type": "1",
"forward_number": "123456@mangosip.ru",
"forward_wait_sec": "30"
},
"comment": "мой номер"
}
В результате обработки запроса, формируются и передаются JSON-данные, содержащие следующие параметры:
| № | Параметры | Тип | Обяза-тель-ный | Описание |
|---|---|---|---|---|
| 1 | result | Да | Результат выполнения команды завершения вызова от внешней системы.Ниже приведены возможные значения результата (см. " Список кодов результатов "): - 1000 - команда завершения вызова выполнена успешно; - 3100 - переданы неверные параметры команды; - 31XX - неверные параметры; - 3300 - объект не существует; - 5XXX – исключение. |
Пример ответа:
{
"result": 1000
}