Инициация вызова
POST /telephony/calls/@channelKey/
Пример URL
https://домен_системы/api/v2/telephony/calls/@channelKey/
Параметры тела запроса (form-data)
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
action | строка | Да | create_call - для создания вызова необходимо использовать данное значение |
direction | строка | Да | Направление вызова: incoming - входящий, outcoming - исходящий |
phone | строка | Да | Номер телефона |
call_status | строка | Нет | Статус вызова, описание см. ниже |
pbx_call_id | строка | Нет | ID вызова из ВАТС |
pbx_user_ids[] | массив строк/чисел | Нет | ID пользователей из ВАТС |
user_ids[] | массив чисел | Нет | ID сотрудников системы с доступом к телефонии |
user_id | число | Нет | ID сотрудника в системе |
group_ids[] | массив чисел | Нет | ID групп сотрудников системы с доступом к телефонии |
audio_record | файл (mp3/mp4/wav/ogg) | Нет | Запись вызова |
сomment | строка | Нет | Комментарий к заявке |
Описание параметра call_status
Доступные значения:
- ringing
- in-progress
- canceled
- missed
- failed
- answered
- busy
Статусы ringing
и in-progress
являются активными статусами вызова, то есть пользователю будет показа карточка звонка.
Остальные статусы являются финальным статусами вызова и скрывают карточку звонка.
Внимание
Одновременно можно передавать только один из параметров: user_ids
/ group_ids
/ pbx_user_ids
Данные параметры отвечают за то, каким пользователям будет показана карточка вызова. В случае если ни один из перечисленных параметров не будет указан, карточка будет показана всем сотрудникам с доступом к модулю телефонии. Если будет передан/найден только один сотрудник, то он автоматически будет назначен в качестве исполнителя заявки/звонка.
Пример тела запроса (form-data)
Запрос на инициацию
вызова
Key | Value |
---|---|
action | create_call |
direction | incoming |
phone | +79998887766 |
call_status | ringing |
user_ids[] | 1,2,3 |
comment | Важный звонок! |
Пример ответа
{
"data": {
"call_id": 123,
"pbx_call_id": null,
"user_id": 0,
"pbx_user_id": null,
"call_status": "ringing",
"audio_record": null,
"ticket_id": 4567
}
}