Lädt eine Datei zur Verwendung in Medien- oder Rich Card-Nachrichten hoch.
Der Agent stellt die URL oder das Binärprogramm der Datei und (optional) die URL der entsprechenden Miniaturansichtsdatei bereit. Die RBM-Plattform speichert die Datei 30 Tage lang im Cache und gibt einen eindeutigen Namen zurück, mit dem Sie die Datei beim Senden von Agent-Nachrichten identifizieren können.
Stellen Sie zum Hochladen einer binären Datei eine HTTP-POST-Anfrage an den Upload-URI, lassen das Feld fileUrl
im JSON-Anfragetext weg und geben die Binärdatei als POST-Anfragetext an. Verwenden Sie beispielsweise das cURL-Flag --upload-file
mit dem voll qualifizierten Dateipfad der Binärdatei.
HTTP-Anfrage
- Upload-URI für Medien-Uploadanfragen:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- Metadaten-URI, für Anfragen, die nur Metadaten enthalten:
POST https://rcsbusinessmessaging.googleapis.com/v1/files
Die URL verwendet die Syntax der gRPC-Transcodierung.
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "fileUrl": string, "thumbnailUrl": string, "contentDescription": string, "agentId": string } |
Felder | |
---|---|
fileUrl |
Optional. Öffentlich verfügbare URL der Datei. Die RBM-Plattform bestimmt den MIME-Typ der Datei beim Abrufen der Datei anhand des Felds „content-type“ in den HTTP-Headern. Unterstützte Bildinhalte: Bild/JPEG, Bild/JPG, Bild/GIF, Bild/PNG Unterstützte Videocontenttypen: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm. |
thumbnailUrl |
Optional. Öffentlich verfügbare URL der Miniaturansicht für die Datei Wenn dieses Feld nicht festgelegt ist, generiert die RBM-Plattform automatisch eine Miniaturansicht aus der Datei. Die RBM-Plattform bestimmt den MIME-Typ der Datei beim Abrufen der Datei anhand des Felds „content-type“ in den HTTP-Headern. Unterstützte Bildinhalte: Bild/JPEG, Bild/JPG, Bild/GIF, Bild/PNG |
contentDescription |
Optional. Textbeschreibung des Dateiinhalts. Screenreader verwenden diese Beschreibung, um Nutzenden mit Behinderungen zu vermitteln, was die Datei enthält. |
agentId |
Erforderlich. Die eindeutige Kennung des Agents. |
Antworttext
Eine Dateiressource mit einem eindeutigen Namen, mit dem ein Agent die Datei beim Senden von Nachrichten identifizieren kann.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{ "name": string } |
Felder | |
---|---|
name |
Vom Server zugewiesener eindeutiger Name der Dateiressource, mit dem ein Agent die Datei beim Senden von Nachrichten identifizieren kann. Das Format ist „files/{uid}“, wobei {uid} eine eindeutige ID ist. |
Autorisierungsbereiche
Erfordert den folgenden OAuth-Bereich:
https://www.googleapis.com/auth/rcsbusinessmessaging
Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.