Method: files.create

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

Агент предоставляет URL-адрес или двоичный файл файла и (опционально) URL-адрес соответствующего файла миниатюры.

Важно: Для обеспечения конфиденциальности и безопасности пользователей платформа RBM загружает и обрабатывает медиа- и PDF-файлы с предоставленных URL-адресов перед их доставкой пользователю. Это предотвращает отслеживание агента по уникальным URL-адресам. Поэтому не отправляйте большое количество уникальных URL-адресов. Платформа RBM не поддерживает это, независимо от того, указывают ли URL-адреса на одни и те же или на разные файлы. Используйте один и тот же URL-адрес для идентичных файлов.

Платформа RBM кэширует файл на 60 дней и возвращает уникальное имя, которое можно использовать для идентификации файла при отправке сообщений агенту.

Чтобы загрузить двоичный файл, сделайте запрос HTTP POST на Upload URI, исключите поле fileUrl из тела запроса JSON и укажите двоичный файл как тело запроса POST. Например, используйте флаг cURL --upload-file с полным путем к двоичному файлу.

HTTP-запрос

  • URI загрузки для запросов на загрузку медиафайлов:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI метаданных для запросов только метаданных:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

URL-адрес использует синтаксис gRPC Transcoding .

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

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "agentId": string
}
Поля
fileUrl

string

Необязательно. Публично доступный URL файла. Платформа RBM определяет тип MIME файла из поля content-type в заголовках HTTP при извлечении файла. RBM поддерживает изображения, аудио, видео и pdf.

Поддерживаемые типы изображений: image/jpeg, image/jpg, image/gif, image/png.

Поддерживаемые типы аудиоконтента: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg.

Поддерживаемые типы видеоконтента: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Поддерживаемые типы содержимого PDF: application/pdf.

Примечание: URL-адрес файла может иметь 1 перенаправление. Перенаправленные URL-адреса файлов должны быть общедоступны. Перенаправления не поддерживаются для URL-адресов файлов в CreateAgentMessageRequest.

thumbnailUrl

string

Необязательно. Публично доступный URL миниатюры, соответствующей файлу. Если это поле не задано, платформа RBM автоматически генерирует миниатюру из файла. Платформа RBM определяет тип MIME файла из поля content-type в заголовках HTTP при извлечении файла.

Поддерживаемые типы изображений: image/jpeg, image/jpg, image/gif, image/png.

agentId

string

Обязательно. Уникальный идентификатор агента.

Тело ответа

Файловый ресурс с уникальным именем, которое агент может использовать для идентификации файла при отправке сообщений.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "name": string
}
Поля
name

string

Назначенное сервером уникальное имя файлового ресурса, которое агент может использовать для идентификации файла при отправке сообщений. Формат: "files/{uid}", где {uid} — уникальный идентификатор.

Области действия авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Для получения более подробной информации см.OAuth 2.0 Overview .