Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Warning

Мы обновили документацию, актуальная версия страницы доступна по ссылке: Звуковые файлы (/sound/)

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

...

Note
titleContent-Type при загрузке файлов

При загрузке файлов через метод POST следует установить заголовок Content-Type в значение multipart/form-data с указанием параметра boundary, который содержит последовательность символов, разделяющую части тела запроса. Параметры звукового файла и сам файл передаются как поля формы. Во всех остальных методах, в том числе и обновлении информации о звуковом файле, следует использовать обычный Content-Type: application/json и передавать информацию в JSON-формате.

Стоит отметить, что в большинстве случаев различные библиотеки для работы с веб-ресурсами генерируют тело запроса и заголовок Content-Type с параметром boundary автоматически.

Описание полей

Параметр
Тип
Обязательный
Значение по умолчанию
Описание
title

string

да 
Название звукового файла
filefileда 

Звуковой файл в формате wav или mp3. Максимальный размер файла – 10 мегабайт. Не поддерживаются wav-файлы с кодированием типа Float. Не поддерживаются wav-файлы, в которых нет информации о формате: кодировании, количестве каналов, битрейте, частоте и т.д.

В случае успешной загрузки файла, возвращается ресурс "Звуковой файл", содежащий в том числе идентификатор звукового файла (поле id), который используется для указания звука в ресурсах очереди, голосового приветствия и т.п.

...

Пример HTTP-запроса, загружающего звуковой файл test_sound.wav c именем Файл приветствия .

Code Block
Request URL: https://hostname.domain/api/ver1.0/client/@me/sound/
Request Method: POST
Authorization: Bearer token
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryRJjeZXUAAoerF744
Host: hostname.domain
------WebKitFormBoundaryRJjeZXUAAoerF744
Content-Disposition: form-data; name="file"; filename="test_sound.wav"
Content-Type: audio/wav


------WebKitFormBoundaryRJjeZXUAAoerF744
Content-Disposition: form-data; name="title"

Файл приветствия
------WebKitFormBoundaryRJjeZXUAAoerF744--

...

Параметр
Тип
Описание
id

integer

Идентификатор звукового файла
title

string

Название звукового файла
client_idinteger

Идентификатор клиента, владеющего звуковым файлом. Может иметь значение null, если звук не принадлежит клиенту.

dealer_idinteger

Идентификатор дилера, владеющего звуковым файлом. Может иметь значение null, если звук не принадлежит дилеру клиента.

filenamestring

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

...


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

POST /client/{client_id}/sound/

...