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