Update

Метод Update

Примените метод Update для редактирования ресурса голосового SMS — можно изменить название и настройки перевода на номер оператора, а также привязать новый аудиофайл для информирования.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/voice-message/v1/Update

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
id string идентификатор ресурса голосового SMS
name string название ресурса голосового SMS
media_id uint64 идентификатор аудиофайла, загруженного в аудиобиблиотеку этого приложение
redirect_info RedirectInfo настройка перевода звонка на оператора после проигрывания аудиосообщения; если не передано, перевод отключается

RedirectInfo

Параметр Тип Описание
digit uint32 клавиша, на которую принимающему абоненту нужно нажать, чтобы соединиться с оператором: от 0 до 9; если не передано, применяется значение по умолчанию: 0
redirect_number string номер телефона, на который нужно перевести звонок после нажатия на клавишу, в формате 79999999999 (11 цифр); если не передано, значение сбрасывается

Выходные параметры

Пустой JSON с 200 OK статусом.

Примеры

Входные параметры:

{
   "id": "817cabf1-bcdd-461e-8b2f-2ff4a9f48619",
   "name": "Сезонная распродажа 30%",
   "media_id": "196691",
   "redirect_info": {
           "digit": 1,
           "redirect_number": "79999999999"
           }
}

Выходные параметры:

{}

Возможные ошибки

Код Статус Пример сообщения Описание
400 Bad Request failed to parse token невалидный API-ключ приложения
401 Unauthorized error getting JWT Token claims ошибка при парсинге JWT claims (части API-ключа, отвечающие за информацию о пользователе/приложении)
403 Forbidden error":“Customer is not in correct status” аккаунт заблокирован
404 Not Found error getting media resource аудиофайл с таким идентификатором не найден в этом приложении

Содержание статьи