/Носителя

Конечная точка API для отправки вложений мультимедиа в группы бесед в Kaizala.

Поддерживаемые форматы файлов:

Тип носителя	ActionType	Расширение
изображения;	Image	.jpg, JPEG, .png
Альбома	Альбома	.jpg, JPEG, .png
Аудиофайлы	"Audio" (Аудио);	.mp3, .wav
Документы	Документ	.doc, .docx, .xls, .xlsx, .ppt, .pptx, .pdf
Видео	Видео	.mp4, .3gpp

Публикация мультимедийных вложений в Kaizala — это двухэтапный процесс. Сначала необходимо отправить файл мультимедиа в репозиторий с помощью конечной точки /media, а затем использовать URL-адрес ресурса позже для публикации в Качестве действия внутри Kaizala.

Соответствующий тип контента (mime type) необходимо задать в заголовке содержимого файла мультимедиа. Без этого API выдаст ошибку неподдерживаемого media(415).

POST /media

POST {endpoint-url}/v1/media

Параметры запроса

	Параметр	Тип	Дополнительные?	Описание
Заголовок HTTP	accessToken	Строка	Нет	Маркер доступа, полученный от конечной точки проверки подлинности
Заголовок HTTP	Content-Type	String	Нет	Чтобы указать, что файл передается. value: multipart/form-data

Текст запроса

Параметр	Тип	Описание
Текст POST	files	Файл мультимедиа для отправки в многокомпонентном формате или формате формы

Текст ответа

Параметр	Тип	Описание
mediaResource	Строка	Закодированные данные мультимедиа для использования в последующих вызовах действий отправки

POST /groups/{groupId}/actions

После отправки файла мультимедиа вы можете опубликовать файл мультимедиа в группе с помощью приведенного ниже API.

POST {endpoint-url}/v1/groups/{groupId}/actions

Параметры запроса

	Параметр	Тип	Дополнительные?	Описание
Параметр URL-пути	groupId	String	Нет	GUID, представляющий groupId определенного ресурса группы
Заголовок HTTP	accessToken	Строка	Нет	Маркер доступа, полученный от конечной точки проверки подлинности
Заголовок HTTP	Content-Type	String	Нет	value: application/json

Текст запроса

Параметр	Тип	Описание
actionType	Строка	Идентификатор отправляемого действия Kaizala. Сведения о поддерживаемых форматах файлов и их соответствующих параметрах ActionType см. в таблице выше.
actionBody	Объект JSON	Объект , представляющий данные, необходимые для соответствующего действия. Параметры, определенные ниже для каждого поддерживаемого MediaType.

actionBody для файлов мультимедиа

Параметр	Тип	Дополнительные?	Описание
mediaResource	Строка	Нет	Строка MediaResource из предыдущего вызова /media, куда необходимо отправить вложение
Заголовок	Строка	Да	Текстовая строка, отображаемая вместе с файлом мультимедиа в составе сообщения

Пример запроса JSON для действия мультимедиа

{
    actionType:"Image",
    actionBody: {
                mediaResource: "{{MediaResource return in response of /media api call}}",
                caption: "Sample test caption"
                }
}

Пример ответа JSON

{
    "referenceId": "6007fe3a-cb7c-4eef-bb88-934273aabc1e"
}