Method: files.create

Importe un fichier à utiliser dans des messages multimédias ou de cartes enrichies.

L'agent fournit l'URL ou le binaire du fichier et (éventuellement) l'URL du fichier de vignette correspondant. La plate-forme RBM met le fichier en cache pendant 30 jours et renvoie un nom unique que vous pouvez utiliser pour identifier le fichier lorsque vous envoyez des messages à l'agent.

Pour importer un fichier binaire, envoyez une requête HTTP POST à l'URI d'importation, omettez le champ fileUrl dans le corps de la requête JSON et spécifiez le binaire en tant que corps de la requête POST. Par exemple, utilisez l'option cURL --upload-file avec le chemin d'accès complet du fichier binaire.

Requête HTTP

  • URI d'importation pour les demandes d'importation de fichiers multimédias:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI de métadonnées, pour les requêtes ne contenant que des métadonnées:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Champs
fileUrl

string

Facultatif. URL publique du fichier. La plate-forme RBM détermine le type MIME du fichier à partir du champ content-type dans les en-têtes HTTP lors de la récupération du fichier. RBM prend en charge les fichiers image, audio, vidéo et PDF.

Types de contenus image acceptés: image/jpeg, image/jpg, image/gif, image/png.

Types de contenus audio compatibles: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg.

Types de contenus vidéo compatibles: video/h263, vidéo/m4v, vidéo/mp4, vidéo/mpeg, vidéo/mpeg4, vidéo/webm

Types de contenus PDF acceptés: application/pdf.
thumbnailUrl

string

Facultatif. URL accessible au public de la vignette correspondant au fichier. Si ce champ n'est pas défini, la plate-forme RBM génère automatiquement une vignette à partir du fichier. La plate-forme RBM détermine le type MIME du fichier à partir du champ content-type dans les en-têtes HTTP lors de la récupération du fichier.

Types de contenus image acceptés: image/jpeg, image/jpg, image/gif, image/png.
contentDescription

string

Facultatif. Description du contenu du fichier sous forme de texte. Les lecteurs d'écran utilisent cette description pour aider les utilisateurs handicapés à comprendre ce que contient le fichier.
agentId

string

Obligatoire. Identifiant unique de l'agent.

Corps de la réponse

Ressource de fichier portant un nom unique qu'un agent peut utiliser pour identifier le fichier lors de l'envoi de messages.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "name": string
}
Champs
name

string

Nom unique attribué par le serveur de la ressource de fichier, qu'un agent peut utiliser pour identifier le fichier lors de l'envoi de messages. Le format est « files/{uid} », où {uid} est un identifiant unique.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.