Upload
Метод Upload
Примените этот метод для загрузки аудиофайла к приложению. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/media/v1/Upload
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
Имя | Тип | Описание |
---|---|---|
Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0 , где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
Параметр | Тип | Описание |
---|---|---|
file | bytes (Base64) | аудиофайл |
full_name | string | имя файла |
file_type | enum FileType | тип аудиофайла |
FileType
Значение | ID | Описание |
---|---|---|
FILE_TYPE_IVR | 200 | IVR (интерактивное голосовое меню) |
FILE_TYPE_PREMEDIA | 201 | премедиа (аудиосообщение, которое воспроизводится клиенту до ответа оператора) |
Выходные параметры
Параметр | Тип | Описание |
---|---|---|
file_id | uint64 | внутренний ID аудиофайла |
resource_id | uint64 | уникальный идентификатор ресурса загруженного аудиофайла |
size | uint64 | размер аудиофайла в байтах |
duration | uint32 | длительность аудиофайла в секундах |
name | string | имя файла |
extension | string | расширение aудиофайла |
description | string | описание к аудиофайлу |
application_uuid | string | уникальный идентификатор приложения, к которому загружен аудиофайл |
file_type | enum FileType | тип аудиофайла |
date_upload | string | дата загрузки аудиофайла в формате RFC-3339 / ISO-8601 |
Возможные ошибки
Код | Статус | Пример сообщения | Описание |
---|---|---|---|
401 | Unauthorized | malformed token | не указан / не правильно указан API-ключ приложения |
400 | Bad Request | error file type must be value 200 or 201 | недопустимый тип файла |
400 | Bad Request | invalid UploadRequest.FullName: value length must be between 1 and 128 runes, inclusive | пустое имя файла |
500 | Internal Server Error | pMedia_Name [qq12] exists | имя файла уже используется |
500 | Internal Server Error | error GetAudioDuration from audio duration: unknown extension | файл не имеет расширения |
Примеры
Входные параметры:
{
"file": "SUQzAwAAAAAfdlRZRVIAAAAFAAAAMjAyMVRJVDIAAABHAAAB//4TBDgEQgQwBEAEMAQgADwENQQ7BD4ENAQ4BE8EIABABD4EO",
"file_type": "201",
"full_name": "test.mp3"
}
Выходные параметры:
{
"file_id": "1931072746905665536",
"resource_id": "152817",
"size": "121087",
"duration": 5,
"name": "test",
"extension": "mp3",
"description": "",
"application_uuid": "178ec145-6898-4b06-a92a-75f63cb57046",
"file_type": 201,
"date_upload": "2023-06-14T16:53:40.459734572Z"
}