Method: files.create

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

Агент предоставляет URL-адрес или двоичный файл файла и (необязательно) URL-адрес соответствующего файла миниатюр. Платформа RBM кэширует файл в течение 30 дней и возвращает уникальное имя, которое можно использовать для идентификации файла при отправке сообщений агента.

Чтобы загрузить двоичный файл, выполните HTTP-запрос POST к 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 .

Тело запроса

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

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

string

Необязательный. Общедоступный URL-адрес файла. Платформа RBM определяет MIME-тип файла из поля типа контента в заголовках 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.

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

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

thumbnailUrl

string

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

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

contentDescription

string

Необязательный. Текстовое описание содержимого файла. Программы чтения с экрана используют это описание, чтобы помочь пользователям с ограниченными возможностями понять, что содержит файл.

agentId

string

Необходимый. Уникальный идентификатор агента.

Тело ответа

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

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

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

string

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

Области авторизации

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .