Method: files.create

Carica un file da utilizzare nei messaggi con contenuti multimediali o schede avanzate.

L'agente fornisce l'URL o il file binario del file e (facoltativo) l'URL del file della miniatura corrispondente.

Importante: per la privacy e la sicurezza degli utenti, la piattaforma RBM scarica ed elabora i file multimediali e PDF dagli URL forniti prima di consegnarli all'utente. In questo modo, viene impedito il monitoraggio degli agenti tramite URL univoci. Pertanto, non inviare un volume elevato di URL univoci. La piattaforma RBM non supporta questa operazione, indipendentemente dal fatto che gli URL rimandino allo stesso file o a file diversi. Utilizza lo stesso URL per file identici.

La piattaforma RBM memorizza nella cache il file per 60 giorni e restituisce un nome univoco che puoi utilizzare per identificare il file quando invii i messaggi dell'agente.

Per caricare un file binario, invia 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 file 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 dei metadati, per le 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,
  "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 delle immagini 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, application/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: application/pdf.
thumbnailUrl

string

Facoltativo. URL pubblico della miniatura corrispondente al file. Se questo campo non è 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 delle immagini supportati: image/jpeg, image/jpg, image/gif, image/png.
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 quando invia 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 della risorsa file assegnato dal server, che un agente può utilizzare per identificare il file durante l'invio dei 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 sezione OAuth 2.0 Overview.