| Warning |
|---|
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Записи разговоров (/record/) |
Ресурс записи разговоров позволяет получить список доступных записей разговора клиента или добавочного за определенный период, получить непосредственно файлы записи, а также удалить записи в диапазоне или поштучно.
...
Имя | Тип | Обязательный | Значение по умолчанию |
|---|---|---|---|
| YYYY-MM-DD HH:MM:SS | да | |
| YYYY-MM-DD HH:MM:SS | да | |
|
| нет | desc |
Поля записей разговора
Поля ресурса "Запись разговора" совпадают с полями ресурса CDR, но в отличие от CDR, поля record_uuid и record_file_size никогда не принимают значения null.
Имя | Тип | Описание |
|---|---|---|
|
| Идентификатор клиента-владельца записи |
|
| Идентификатор дилера-владельца записи |
|
| Домен назначения вызова |
|
| Номер назначения вызова |
|
| Домен внешнего номера |
|
| Внешний номер |
|
| Длительность вызова |
|
| Зарегистрированный внешний номер |
|
| Идентификатор группы добавочных, владеющей записью |
|
| Идентификатор добавочного |
|
| Имя добавочного |
|
| Тип добавочного |
|
| Направление вызова. Может принимать значение "in" или "out" |
|
| Исходный домен звонящего |
|
| Исходное отображаемое имя звонящего |
|
| Исходное имя пользователя звонящего |
|
| Причина окончания вызова |
|
| Время окончания вызова |
|
| Время инициализации вызова |
|
| Размер файла записи в байтах |
|
| Идентификатор записи разговора |
|
| Результат вызова |
|
| Домен источника вызова |
|
| Номер источника вызова |
|
| Время начала вызова |
|
| Исходный домен назначения |
|
| Исходный имя пользователя назначения |
| string | Уникальный идентификатор вызова |
Получение статистики записей разговора
...
Имя | Тип | Обязательный | Значение по умолчанию |
|---|---|---|---|
| YYYY-MM-DD HH:MM:SS | да | |
| YYYY-MM-DD HH:MM:SS | да |
Поля статистики записей разговора
Имя | Тип | Описание |
|---|---|---|
|
| Суммарный размер файлов записей |
|
| Количество файлов записей |
Получение файлов записей разговора из хранилища
Если в системе присутствует внешнее хранилища записей разговора, то для получения ссылки на запись в хранилище необходимо воспользоваться следующим методом:
GET /client/{client_id}/record/{record_uuid}/storage_url/В ответ API вернёт URL для получения записи из хранилища. Получение записи из хранилища не требует аутентификации. Ссылка является постоянной.
Получение файлов записей с помощью ссылки на хранилище является наиболее предпочтительным и надёжным.
Пример получение ссылки на запись из хранилища:
Запрос:
GET https://hostname/api/ver1.0/client/@me/record/30-624835FEEE0E11E6A19D331E4D6A0606/storage_url/Ответ:
{
"record_url": "https://storage.hostname.ru/bd7zzrXD5395gn7FMgzKtB8zhZnNoYx8BdkX_HgNdeE2lnJjPMLcOR_1hQprGf-dW94wuTCNRAY6MDjMZ0zWIg=="
}
Получение файлов записей разговора из API
Для непосредственного получения файла записи разговора с севера REST API нужно совершить GET-запрос на соответствующий нужному уровню пользователя ресурс, указав идентификатор записи:
...
Подробнее этот способ описан в разделе Получение файлов через базовую HTTP-аутентификацию.
Получение архива файлов записей разговора
Существует возможность получить архив с множеством файлов записей за период времени. Для этого необходимо воспользоваться специальным ресурсом API, передав в него временной диапазон и адрес электронной почты, на которую будет отправлена ссылка для загрузки архива. Размер файлов в архиве и диапазон дат ограничен. В течении часа невозможно запросить новый архив, не загрузив предыдущий. Коды возможных ошибок перечислены на странице Возвращаемые коды и статусы. Записи разговора по ссылке будут доступны в течении 12 часов.
POST /client/{client_id}/record/archive/
Параметры JSON
Имя | Тип | Обязательный | Описание |
|---|---|---|---|
|
|
| Начало диапазона в формате YYYY-MM-DD HH:MM:SS |
end_datetime | string (YYYY-MM-DD HH:MM:SS) | да | Конец диапазона в формате YYYY-MM-DD HH:MM:SS |
|
|
| Адрес электронной почты для отправки ссылки на архив. Возможно перечисление нескольких адресов через запятую |
Ресурсы раздела "Клиент"
GET /client/{client_id}/record/
...
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
...
POST /client/{client_id}/record/archive/
Запросить архив записей разговора за период
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
...
GET /client/{client_id}/record/stats/
Получить статистику по записям разговора в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
...
Получить файл записи разговора
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
DELETE /client/{client_id}/record/{record_uuid}
Удалить запись разговора
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
...
Получить список записей разговора группы добавочных в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
...
Получить статистику по записям разговора в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
...
Получить файл записи разговора
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
...
Получить список записей разговора добавочного в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
...
Удалить записи разговора добавочного в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
...
Получить статистику по записям разговора добавочного в интервале
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
...
Получить файл записи разговора
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
...