SetCallRecordState (номер)
Метод SetCallRecordState (номер)
Примените этот метод для включения или отключения записи звонков для купленного номера. Для включения услуги на номере выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/number/v1/SetCallRecordState
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
number_code | uint64 | купленный номер |
call_record | boolean | True для включения записи звонка. False для отключения записи звонка |
Примечание
Чтобы включить запись звонков для номера, убедитесь, что услуга уже подключена глобально в настройках приложения в Личном кабинете разработчика. Там вы сможете выбрать подходящий срок хранения — 1 месяц, 3 месяца, 6 месяцев или 1 год. Срок хранения единый для всех звонков, совершенных с/на номера с подключенной услугой в этом приложении.
Выходные параметры
Пустой JSON с 200 OK статусом.
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
500 | Internal Server Error | Error setting call record: rpc error: code = Unknown desc = Error getting number: Error getting number fields: Error scanning result: no rows in result set | в поле number_code указан несуществующий номер |
400 | Bad Request | proto: syntax error (line 2:20): invalid value п | значение параметра number_code невалидно |
400 | Bad Request | proto: syntax error (line 2:20): unexpected token | пустое поле number_code |
400 | Bad Request | proto: (line 3:20): invalid value for bool type: | значение параметра сall_record невалидно / не задано` |
Примеры
Входные параметры:
{
"number_code": 79011550008,
"call_record": true
}
Выходные параметры:
{}