Method: files.create

Faz upload de um arquivo para uso em mensagens de mídia ou rich card.

O agente fornece o URL ou binário do arquivo e, opcionalmente, o URL do arquivo de miniatura correspondente. A plataforma RBM armazena o arquivo em cache por 30 dias e retorna um nome exclusivo que pode ser usado para identificar o arquivo ao enviar mensagens do agente.

Para fazer upload de um binário de arquivo, faça uma solicitação HTTP POST para o URI de upload, omita o campo fileUrl do corpo da solicitação JSON e especifique o binário como o corpo da solicitação POST. Por exemplo, use a sinalização cURL --upload-file com o caminho totalmente qualificado do arquivo binário.

Solicitação HTTP

  • URI de upload para solicitações de upload de mídia:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI de metadados, para solicitações somente de metadados:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Campos
fileUrl

string

Opcional. URL do arquivo disponível publicamente. A plataforma RBM determina o tipo MIME do arquivo no campo content-type nos cabeçalhos HTTP ao buscar o arquivo.

Tipos de conteúdo de imagem compatíveis: image/jpeg, image/jpg, image/gif, image/png.

Tipos de conteúdo de vídeo compatíveis: vídeo/h263, vídeo/m4v, vídeo/mp4, vídeo/mpeg, vídeo/mpeg4, vídeo/webm.
thumbnailUrl

string

Opcional. URL disponível publicamente da miniatura correspondente ao arquivo. Se esse campo não for definido, a plataforma RBM vai gerar automaticamente uma miniatura do arquivo. A plataforma RBM determina o tipo MIME do arquivo no campo content-type nos cabeçalhos HTTP ao buscar o arquivo.

Tipos de conteúdo de imagem compatíveis: image/jpeg, image/jpg, image/gif, image/png.
contentDescription

string

Opcional. Descrição do texto do conteúdo do arquivo. Os leitores de tela usam essa descrição para ajudar usuários com deficiências a entender o conteúdo do arquivo.
agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da resposta

Um recurso de arquivo com um nome exclusivo que um agente pode usar para identificar o arquivo ao enviar mensagens.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "name": string
}
Campos
name

string

Nome exclusivo atribuído pelo servidor do recurso de arquivo, que um agente pode usar para identificar o arquivo ao enviar mensagens. O formato é "files/{uid}", em que {uid} é um ID exclusivo.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.