Протестировать методы API можно на странице интерактивного обозревателя и без написания кода

Некоторые ресурсы, описанные на странице, по-умолчанию могут быть не доступны из-за типа приложения. См. типы и уровни приложений

Ресурс записи разговоров позволяет получить список доступных записей разговора клиента или добавочного за определенный период, получить непосредственно файлы записи, а также удалить записи в диапазоне или поштучно.

Получение списка записей разговора

Интервал получения и удаления списка указывается параметрами запроса start_datetime и end_datetime. Дата и время, содержащиеся в параметре end_datetime не должны превышать последний день следующего за start_datetime месяца. Для получения данных за больший период следует делать несколько запросов. 

При получении списка возможно указать параметр запроса order, который задает направление, в котором результирующий список будет отсортирован по полю init_time_gmt.

Параметры запроса

Поля записей разговора

Поля ресурса "Запись разговора" совпадают с полями ресурса CDR, но в отличие от CDR, поля record_uuid и record_file_size никогда не принимают значения null.

Получение статистики записей разговора

Параметры запроса

Поля статистики записей разговора

Получение файлов записей разговора из хранилища

Если в системе присутствует внешнее хранилища записей разговора, то для получения ссылки на запись в хранилище необходимо воспользоваться следующим методом:

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-запрос на соответствующий нужному уровню пользователя ресурс, указав идентификатор записи:

GET /client/{client_id}/record/{record_uuid}

GET /extension_group/{ext_group_id}/record/{record_uuid}

GET /extension/{extension_id}/record/{record_uuid}

Данные файла записи будут возвращены в теле запроса, имя файла содержится в заголовке Content-Disposition.

Пример

Запрос:

GET /api/ver1.0/client/12/record/30-7FD1F974054E11E68FD30968F8BBCB45 HTTP/1.1
User-Agent: Wget/1.15 (linux-gnu)
Accept: */*
Host: host.domain
Connection: Keep-Alive
Authorization: Bearer token

Ответ: 

HTTP/1.0 200 OK
Content-Length: 1008
Content-Disposition: attachment; filename=2016-04-18-13-13-47_outbound_0000000000_300.mp3
Server: nginx/1.8.1
Date: Tue, 19 Apr 2016 11:56:19 GMT
Content-Type: audio/mpeg

Получение файлов через базовую HTTP-аутентификацию

Существует возможность получить доступ к файлам записей разговоров, используя базовую HTTP-аутентификацию, вместо передачи OAuth2-токена.

Подробнее этот способ описан в разделе  Получение файлов через базовую HTTP-аутентификацию.

Получение архива файлов записей разговора

Существует возможность получить архив с множеством файлов записей за период времени. Для этого необходимо воспользоваться специальным ресурсом API, передав в него временной диапазон и адрес электронной почты, на которую будет отправлена ссылка для загрузки архива. Размер файлов в архиве и диапазон дат ограничен. В течении часа невозможно запросить новый архив, не загрузив предыдущий. Коды возможных ошибок перечислены на странице Возвращаемые коды и статусы. Записи разговора по ссылке будут доступны в течении 12 часов.

POST /client/{client_id}/record/archive/

Параметры JSON

Ресурсы раздела "Клиент"

GET /client/{client_id}/record/

Получить список записей разговора клиента в интервале

Параметры URL

Параметры запроса

Поля ответа

DELETE /client/{client_id}/record/

Удалить записи разговора клиента в интервале

Параметры URL

Параметры запроса

POST /client/{client_id}/record/archive/

Запросить архив записей разговора за период

Параметры URL

Параметры JSON

Поля ответа

GET /client/{client_id}/record/stats/

Получить статистику по записям разговора в интервале

Параметры URL

Параметры запроса

Поля ответа

GET /client/{client_id}/record/{record_uuid}

Получить файл записи разговора

Параметры URL

DELETE /client/{client_id}/record/{record_uuid}

Удалить запись разговора

Параметры URL

Ресурсы раздела "Группа добавочных"

GET /extension_group/{ext_group_id}/record/

Получить список записей разговора группы добавочных в интервале

Параметры URL

Параметры запроса

Поля ответа

GET /extension_group/{ext_group_id}/record/stats/

Получить статистику по записям разговора в интервале

Параметры URL

Параметры запроса

Поля ответа

GET /extension_group/{ext_group_id}/record/{record_uuid}

Получить файл записи разговора

Параметры URL

Ресурсы раздела "Добавочный"

GET /extension/{extension_id}/record/

Получить список записей разговора добавочного в интервале

Параметры URL

Параметры запроса

Поля ответа

DELETE /extension/{extension_id}/record/

Удалить записи разговора добавочного в интервале

Параметры URL

Параметры запроса

GET /extension/{extension_id}/record/stats/

Получить статистику по записям разговора добавочного в интервале

Параметры URL

Параметры запроса

Поля ответа

GET /extension/{extension_id}/record/{record_uuid}

Получить файл записи разговора

Параметры URL

Похожие разделы

There are no related labels.