Method: files.create

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

L'agent fournit l'URL ou le binaire du fichier, ainsi que (facultatif) l'URL du fichier de vignette correspondant.

Important: Pour des raisons de confidentialité et de sécurité, la plate-forme RBM télécharge et traite les fichiers multimédias et PDF à partir des URL fournies avant de les transmettre à l'utilisateur. Cela empêche le suivi des agents par URL uniques. Par conséquent, n'envoyez pas un grand nombre d'URL uniques. La plate-forme RBM ne le permet pas, que les URL pointent vers les mêmes fichiers ou vers des fichiers différents. Utilisez la même URL pour les fichiers identiques.

La plate-forme RBM met en cache le fichier pendant 60 jours et renvoie un nom unique que vous pouvez utiliser pour identifier le fichier lorsque vous envoyez des messages aux agents.

Pour importer un fichier binaire, envoyez une requête HTTP POST à l'URI d'importation, omettez le champ fileUrl du corps de la requête JSON et spécifiez le binaire comme 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 contenus multimédias:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI de métadonnées, pour les requêtes de métadonnées uniquement:
    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,
  "agentId": string
}
Champs
fileUrl

string

Facultatif. URL publiquement accessible du fichier. La plate-forme RBM détermine le type MIME du fichier à partir du champ "content-type" des en-têtes HTTP lors de la récupération du fichier. RBM est compatible avec les formats image, audio, vidéo et PDF.

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

Types de contenus audio acceptés: 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, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Types de contenu PDF compatibles: application/pdf.
thumbnailUrl

string

Facultatif. URL publiquement accessible 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" des en-têtes HTTP lors de la récupération du fichier.

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

string

Obligatoire. Identifiant unique de l'agent.

Corps de la réponse

Ressource de fichier avec 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 à la ressource de fichier, que l'agent peut utiliser pour identifier le fichier lors de l'envoi de messages. Le format est "files/{uid}", où {uid} est un ID 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 OAuth 2.0 Overview.