SetCallRecordState (SIP ID)
Метод SetCallRecordState (SIP ID)
Примените этот метод для включения или отключения записи звонков для SIP ID. Для включения услуги на номере выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/sip/v1/SetCallRecordState
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| sip_resource_id | uint64 | уникальный идентификатор ресурса SIP ID |
| call_record | boolean | запись разговора. True - включить запись разговоров, False - не включать запись разговоров |
Примечание
Чтобы включить запись звонков для SIP ID, убедитесь, что услуга уже подключена глобально в настройках приложения в Личном кабинете разработчика. Там вы сможете выбрать подходящий срок хранения — 1 месяц, 3 месяца, 6 месяцев или 1 год. Срок хранения единый для всех звонков, совершенных с/на SIP ID с подключенной услугой в этом приложении.
Выходные параметры
Пустой JSON с 200 OK статусом.
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 401 | Unauthorized | Unauthorized | отсутствует/невалидный API-ключ |
| 400 | Bad Request | Error getting sip info: SIP is missing in the application | заданный SIP ID не принадлежит приложению |
| 409 | Conflict | Error adding SIP: call record is disabled on the app | услуга записи звонков не подключена в настройках приложения |
| 400 | Bad Request | invalid value [value] | в одном из полей невалидный формат |
Примеры
Входные параметры:
{
"sip_resource_id": 1111,
"call_record": true
}
Выходные параметры:
{}