Method: files.create

Carica un file da utilizzare nei messaggi multimediali o nelle schede informative.

L'agente fornisce l'URL o il programma binario del file e (facoltativamente) l'URL del file della miniatura corrispondente. La piattaforma RBM memorizza nella cache il file per 30 giorni e restituisce un nome univoco che puoi utilizzare per identificare il file quando invii i messaggi dell'agente.

Per caricare un file binario, effettua una richiesta POST HTTP all'URI di caricamento, ometti il campo fileUrl dal corpo della richiesta JSON e specifica il file binario come corpo della richiesta POST. Ad esempio, utilizza il flag cURL --upload-file con il percorso completo del file binario.

Richiesta HTTP

  • URI di caricamento, per le richieste di caricamento di contenuti multimediali:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI metadati, per richieste solo di metadati:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Campi
fileUrl

string

(Facoltativo) URL del file disponibile pubblicamente. La piattaforma RBM determina il tipo MIME del file dal campo content-type nelle intestazioni HTTP durante il recupero del file. RBM supporta immagini, audio, video e PDF.

Tipi di contenuti immagine supportati: image/jpeg, image/jpg, image/gif, image/png.

Tipi di contenuti audio supportati: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, applicazione/ogg, audio/ogg.

Tipi di contenuti video supportati: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Tipi di contenuti PDF supportati: applicazione/pdf.
thumbnailUrl

string

(Facoltativo) URL disponibile pubblicamente della miniatura corrispondente al file. Se questo campo non viene impostato, la piattaforma RBM genera automaticamente una miniatura dal file. La piattaforma RBM determina il tipo MIME del file dal campo content-type nelle intestazioni HTTP durante il recupero del file.

Tipi di contenuti immagine supportati: image/jpeg, image/jpg, image/gif, image/png.
contentDescription

string

(Facoltativo) Descrizione testuale dei contenuti del file. Gli screen reader utilizzano questa descrizione per aiutare gli utenti con disabilità a comprendere cosa contiene il file.
agentId

string

Obbligatorio. L'identificatore univoco dell'agente.

Corpo della risposta

Una risorsa file con un nome univoco che un agente può utilizzare per identificare il file durante l'invio di messaggi.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "name": string
}
Campi
name

string

Nome univoco assegnato dal server della risorsa file, che un agente può utilizzare per identificare il file durante l'invio di messaggi. Il formato è "files/{uid}", dove {uid} è un ID univoco.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.