Получение информации о загрузке звонков.
| Метод | get.uploaded_calls |
|---|---|
| Описание | Получение информации о загрузке звонков |
| Кому доступен | Агент, Клиент |
| Необходимые компоненты для работы с методом | Data API для настройки |
| Вес метода | 1 баллов |
Параметры запроса
--object
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод" | |
report_id |
number | да | Уникальный идентификатор отчета пользователя. Для получения списка отчетов пользователей необходимо использовать метод "get.reports_list" | |
date_from |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата начала основной выборки по upload_time
|
date_till |
iso8601 | да | YYYY-MM-DD hh:mm:ss | Дата окончания основной выборки по upload_time
|
fields |
array | нет | Список идентификаторов пользовательских столбцов, разделенных запятой. Доступный список столбцов см.раздел "Получение вложенности столбцов" . Порядок влияет на ответ. | |
| Фильтры применяемые в отчете | filter |
object | нет | Допустимо использовать не более 2 уровней вложенности. Смотри примеры ниже |
Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации" |
filters |
array | да | Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Получение списка возможных условий фильтрации для отчета" . | |
field |
string | Поле сущности к которой будет применяться фильтрация (список заранее определен для метода) | ||
operator |
enum | Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации" | ||
value |
string | Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота. | ||
| Сортировка применяемая в отчете | sort |
array | нет | Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описание |
|---|---|---|---|---|---|---|
ext_id |
string | да | да | да | Уникальный идентификатор звонка в вашей системе. | |
ext_request_id |
string | да | да | да | Уникальный идентификатор запроса API в котором загружались звонки. | |
upload_time |
iso8601 | YYYY-MM-DD hh:mm:ss | нет | нет | нет | Дата и время загрузки звонков |
direction |
enum |
|
да | да | да | Направление звонка |
calling_phone_number |
string | E164 | да | да | да | Номер звонящего |
called_phone_number |
string | E164 | да | да | да | Номер куда звонили |
start_time |
iso8601 | YYYY-MM-DD hh:mm:ss | да | да | да | Дата и время начала сессии звонка |
finish_time |
iso8601 | YYYY-MM-DD hh:mm:ss | да | да | да | Время окончания сессии звонка |
is_lost |
boolean | да | да | да | Признак, что звонок потерянный или успешный | |
is_transfer |
boolean | да | да | да | Признак, был ли трансфер в сессии звонка. | |
wait_duration |
number | да | да | да | Длительность ожидания абонента до первого разговора с сотрудником. Значение в секундах. | |
talk_duration |
number | да | да | да | Длительность ожидания абонента до первого разговора с сотрудником. Значение в секундах. | |
visitor_session_id |
number | да | да | да | Уникальный идентификатор сессии посетителя. | |
campaign_id |
number | да | да | да | Уникальный идентификатор рекламной кампании. | |
source_id |
number | да | да | да | Уникальный идентификатор источника. | |
site_id |
number | да | да | да | Уникальный идентификатор сайта. | |
comment |
string | да | да | да | Комментарий к звонку. | |
record_type |
enum |
wavmp3 |
да | да | да | Тип файла разговора |
status |
enum |
new - Новый звонокin_process - Звонок в процессе загрузкиcancelled - Загрузка звонка отмененаprocessed - Звонок полностью обработан и разговор загруженerror - При загрузке звонка произошла ошибка |
да | да | да | Статус загрузки звонка. |
error_code |
enum |
internal_error - Внутрення ошибкаdownload_error - Неизвестная ошибка во время загрузки файлаconnection_download_error - Ошибка при подключении к серверу. Проблема с сетью.http_status_download_error - Сервер с которого скачиваем файл ответил не 200.http_content_type_download_error - Content-Type не соответствует спецификации.max_file_size_download_error - Превышен максимальный размер файла. На текущий момент - 50 Мб.timeout_download_error - Очень долго скачивался файл или очень долго происходило соединение с сервером. Максимальное время - 30 секунд.decode_error - Не смогли открыть файл разговора, отсутствуют первые байты в файлах mp3 - ID3 и wav - RIFF или при процессе декодирования возникла ошибка.processing_error - Неизвестная ошибка при обработке файла разговора.wav_min_duration_processing_error - Скаченный wav-файл короче 16 секунд.wav_channels_processing_error - Скаченный wav-файл не содержит 2 канала. |
да | да | да | Ошибка при загрузке звонка. |
call_session_id |
number | да | да | да | Уникальный идентификатор звонка, только для звонков в статусе processed. |
|
| Уведомление об обработке звонка | ||||||
callback |
object | нет | нет | нет | Уведомление об обработке звонка. | |
url |
string | нет | нет | нет | http/https адрес на которые будет отправлено уведомление об успешной обработке звонка. | events |
array |
processed - переданный звонок обработан успешноin_process - звонок в процессе обработкиerror - ошибка обработки звонка |
нет | нет | нет | Какие уведомления об обработке звонка получать |
| Теги звонка | ||||||
tags |
array | нет | нет | нет | Теги звонка | |
tag_id |
number | нет | нет | нет | Уникальный идентификатор тега в системе | |
tag_name |
string | нет | нет | нет | Название тега | |
| Запись разговора | ||||||
records |
array | нет | нет | нет | Данные разговора для прослушивания в личном кабинете | |
employee_name |
string | нет | нет | нет | Название сотрудника (ФИО) | |
employee_id |
number | нет | нет | нет | Уникальный идентификатор сотрудника в системе | |
employee_channel |
enum |
|
нет | нет | нет | Указывает в каком канале находится сотрудник |
record_url |
string | нет | нет | нет | Адрес по которому можно скачать файл разговора | |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.uploaded_calls",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"date_from":"iso8601",
"date_till":"iso8601",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "rMiS6Y5qt1OYo2m9S3S3z",
"result": {
"data": [
{
"tags": [
{
"tag_name": "Maxim"
}
],
"ext_id": "yud2022081125",
"status": "processed",
"comment": "yud2022081125",
"is_lost": false,
"records": null,
"site_id": 25187,
"callback": {
"url": "https://webhook.site/dab0fb9d-25e7-48e0-bd2d-a60c9f9f61d9",
"events": [
"processed",
"in_process",
"error"
]
},
"direction": "in",
"error_code": null,
"start_time": "2022-08-11 08:48:43",
"campaign_id": null,
"source_id": null,
"finish_time": "2022-08-11 08:48:44",
"is_transfer": false,
"record_type": null,
"upload_time": "2022-08-11 13:18:19",
"talk_duration": 13,
"wait_duration": 12,
"ext_request_id": "ТЕст",
"call_session_id": 2427195081,
"visitor_session_id": 9161005360,
"called_phone_number": "74950324069",
"calling_phone_number": "79539693061"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"