List calls
Получить список активных разговоров
| Метод | list.calls |
|---|---|
| Версия API | v4.0 |
| Описание | Получить список активных вызовов и их участников |
| Вернуться к списку методов | |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
| access_token | string | да | Ключ сессии аутентификации | |
| direction | string | нет | in, out | Указывает какие сессии выводить - входящие, исходящие. Если параметр не задан, то выводятся все сессии. |
| virtual_phone_number | string | нет | Указывает с каким виртуальным номер активные вызовы показывать. Номер должен начинаться с 7 |
Параметры ответа
| Название | Тип | Обязательный | Допустимые значения | Описание | |
|---|---|---|---|---|---|
| call_session_id | number | да | Уникальный идентификатор сессии звонка, который может быть получен в ответном сообщении при вызове методов start.informer_call, start.vnumber_call, start.scenario_call, start.employee_call, с помощью сервера уведомлений или DATA API. | ||
| direction | string | да | in, out | Направление сесси звонка | |
| start_time | string | да | Время начала вызова. Формат YYYY-MM-DD hh:mm:ss
|
||
| virtual_phone_number | string | да | Виртуальный номер, который был использован как номер представления. | ||
| contact_phone_number | string | да | Номер абонента | ||
| external_id | string | да | Уникальный идентификатор запроса во внешней системе клиента | ||
| Список проставленных тегов | |||||
| tags | array | да | Список проставленных тегов | ||
| tag_id | number | да | Уникальный идентификатор тега | ||
| tag_name | string | да | Имя тега | ||
| Участники сессии звонка | |||||
| legs | array | да | Список участников сессии звонка | ||
| leg_id | number | да | Уникальный идентификатор плеча | ||
| calling_phone_number | string | да | Номер вызывающего абонента | ||
| called_phone_number | string | да | Номер вызываемого абонента | ||
| is_operator | boolean | да | true, false | Признак, который идентифицирует плечо, у которого есть права на выполнение опций разговора | |
| employee_id | number | да | Уникальный идентификатор сотрудника | ||
| employee_full_name | string | да | Ф.И.О сотрудника | ||
| record_call_enabled | boolean | да | true, false |
Включена/Выключена запись разговора. |
|
| state | string | да |
Состояние участника разговора Возможные значения:
|
||
Пример запроса
Копировать
{
"jsonrpc": "2.0",
"method": "list.calls",
"id": "req1",
"params": {
"access_token": "2fRN4g217ca0b4224a67988aff3e584f91964a692045415f36fa66146f5a3c1ae1f6093d",
"direction": "in",
"virtual_phone_number": "74951045771"
}
}
Пример ответа
Копировать
{
"jsonrpc": "2.0",
"id": "req1",
"result": {
"data": [
{
"call_session_id": 206597836,
"direction": "in",
"start_time": "2016-10-19T12:26:48.418",
"virtual_phone_number": "74951045771",
"contact_phone_number": "74959268686",
"external_id": null,
"tags": [
{
"tag_id": 456,
"tag_name": "Целевой"
}
],
"legs": [
{
"leg_id": 287866245,
"calling_phone_number": "74951045771",
"called_phone_number": "74959268686...9.2.3.3",
"is_operator": false,
"employee_id": null,
"employee_full_name": null,
"record_call_enabled": true,
"state": "Разговор"
},
{
"leg_id": 287866221,
"calling_phone_number": "74959268686",
"called_phone_number": "79262444393",
"is_operator": true,
"employee_id": 2345,
"employee_full_name": "Тест",
"record_call_enabled": true,
"state": "Разговор"
}
]
}
]
}
}