new_releases Mises à jour : Consultez les
notes de version pour découvrir les nouvelles fonctionnalités et les mises à jour du produit.
Method: files.create
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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 mé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. Remarque: L'URL du fichier peut comporter une redirection. Les URL des fichiers redirigés doivent être accessibles au public. Les redirections ne sont pas compatibles avec les URL de fichier dans CreateAgentMessageRequest.
|
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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThis process allows agents to upload files, including images, audio, video, and PDFs, for use in media or rich card messages, either by providing a public URL or the file's binary data.\u003c/p\u003e\n"],["\u003cp\u003eThe RBM platform handles file privacy and security by downloading and processing media files from provided URLs, preventing agent tracking via unique URLs, and caches the file for 60 days.\u003c/p\u003e\n"],["\u003cp\u003eThe file upload requires an HTTP POST request to either the upload URI \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com/upload/v1/files\u003c/code\u003e or the metadata-only URI \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com/v1/files\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe agent can provide a public \u003ccode\u003efileUrl\u003c/code\u003e, \u003ccode\u003ethumbnailUrl\u003c/code\u003e, and must include the \u003ccode\u003eagentId\u003c/code\u003e within the request body to upload files.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful upload, the RBM platform returns a unique file name (\u003ccode\u003ename\u003c/code\u003e) that agents can use to reference the file in subsequent messages.\u003c/p\u003e\n"]]],[],null,["# Method: files.create\n\nUploads a file for use in media or rich card messages.\n\nThe agent provides the URL or binary of the file and (optionally) the URL of the corresponding thumbnail file.\n\nImportant: For user privacy and security, the RBM platform downloads and processes media and PDF files from the provided URLs before delivering them to the user. This prevents agent tracking by unique URLs. Therefore, do not submit a high volume of unique URLs. The RBM platform does not support this, whether the URLs point to the same or different files. Use the same URL for identical files.\n\nThe RBM platform caches the file for 60 days and returns a unique name that you can use to identify the file when sending agent messages.\n\nTo upload a file binary, make an HTTP POST request to the Upload URI, omit the `fileUrl` field from the JSON request body, and specify the binary as the POST request body. For example, use the `--upload-file` cURL flag with the fully qualified file path of the binary file.\n\n### HTTP request\n\n- Upload URI, for media upload requests: \n `POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files`\n- Metadata URI, for metadata-only requests: \n `POST https://rcsbusinessmessaging.googleapis.com/v1/files`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------|\n| ``` { \"fileUrl\": string, \"thumbnailUrl\": string, \"agentId\": string } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fileUrl` | `string` Optional. Publicly available URL of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when fetching the file. RBM supports image, audio, video, and pdf. Supported image content types: image/jpeg, image/jpg, image/gif, image/png. Supported audio content types: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg. Supported video content types: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. Supported pdf content types: application/pdf. Note: file URL can have 1 redirect. Redirected file URLs must be publicly accessible. Redirects are not supported for file URLs in CreateAgentMessageRequest. |\n| `thumbnailUrl` | `string` Optional. Publicly available URL of the thumbnail corresponding to the file. If this field is not set, then the RBM platform automatically generates a thumbnail from the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when fetching the file. Supported image content types: image/jpeg, image/jpg, image/gif, image/png. |\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Response body\n\nA file resource with a unique name that an agent can use to identify the file when sending messages.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------|\n| ``` { \"name\": string } ``` |\n\n| Fields ||\n|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Server-assigned unique name of the file resource, which an agent can use to identify the file when sending messages. The format is \"files/{uid}\", where {uid} is a unique ID. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]