Звуковые файлы (/sound/)
- Asia Khalitova (Unlicensed)
- Evgeniy
Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Ресурс "Звуковые файлы" позволяет загружать и управлять файлами звуков, которые в дальнейшем можно использовать для настройки голосовых приветствий, очередей, приветствий голосовой почты и т.п.
Загрузка звуковых файлов
Поддерживаются звуковые файлы в форматах wav и mp3. Максимальный размер файла – 10 мегабайт.
Замена контента звукового файла
Замена контента звукового файла возможна с помощью ресурса
POST /client/{client_id}/sound/{sound_id}
Content-Type при загрузке файлов
При загрузке файлов с помощью метода POST следует установить заголовок Content-Type в значение multipart/form-data с указанием параметра boundary, который содержит последовательность символов, разделяющую части тела запроса. Параметры звукового файла и сам файл передаются как поля формы. Во всех остальных методах, в том числе при обновлении информации о звуковом файле, следует использовать обычный Content-Type: application/json и передавать информацию в JSON-формате. Стоит отметить, что в большинстве случаев различные библиотеки для работы с веб-ресурсами генерируют тело запроса и заголовок Content-Type с параметром boundary автоматически.
Описание полей запроса
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
title | string | да | Название звукового файла |
file | file | да | Звуковой файл в формате wav или mp3. Максимальный размер файла – 10 мегабайт. |
В случае успешной загрузки файла возвращается ресурс "Звуковой файл", содержащий в том числе идентификатор звукового файла (поле id), который используется для указания звука в ресурсах очереди, голосового приветствия и т.п.
Пример
Загрузка звукового файла test_sound.wav c именем “Файл приветствия”.
Получение списка звуковых файлов
Получение всех доступных для использования клиенту или внутреннему номеру звуков осуществляется через соответствующий ресурс. Полученный список содержит информацию обо всех звуковых файлах, доступных для использования клиенту или внутреннему номеру, в том числе загруженных администратором или дилером клиента.
Описание полей
Параметр | Тип | Описание |
|---|---|---|
id | integer | Идентификатор звукового файла |
title | string | Название звукового файла |
client_id | integer | Идентификатор клиента, владеющего звуковым файлом. Может иметь значение null, если звук не принадлежит клиенту |
dealer_id | integer | Идентификатор дилера, владеющего звуковым файлом. Может иметь значение null, если звук не принадлежит дилеру клиента |
filename | string | Системное имя файла, которое может быть использовано, в частности, для проигрывания звука через функцию голосового меню “Call Interactive” |
Ресурсы раздела "Клиент"
Ресурсы раздела "Внутренний номер"