Method: files.create

Lädt eine Datei zur Verwendung in Media- oder Rich Cards-Nachrichten hoch.

Der Agent stellt die URL oder Binärdatei der Datei und (optional) die URL der entsprechenden Miniaturansichtdatei 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.

Um eine Dateibinärdatei hochzuladen, stellen Sie eine HTTP-POST-Anfrage an den Upload-URI, lassen Sie das Feld fileUrl aus dem JSON-Anfragetext weg und geben Sie 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 Anfragen zum Hochladen von Medien:
    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

string

Optional. Öffentlich verfügbare URL der Datei. Die RBM-Plattform bestimmt den MIME-Typ der Datei aus dem Feld "content-type" in den HTTP-Headern, wenn die Datei abgerufen wird. RBM unterstützt Bild-, Audio-, Video- und PDF-Dateien.

Unterstützte Bildinhaltstypen: Bild/JPEG, Bild/JPG, Bild/GIF, Bild/PNG

Unterstützte Audio-Inhaltstypen: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg.

Unterstützte Videoinhaltstypen: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Unterstützte PDF-Inhaltstypen: application/pdf.
thumbnailUrl

string

Optional. Öffentlich verfügbare URL der Miniaturansicht, die der Datei entspricht Ist dieses Feld nicht konfiguriert, erstellt die RBM-Plattform automatisch eine Miniaturansicht aus der Datei. Die RBM-Plattform bestimmt den MIME-Typ der Datei aus dem Feld "content-type" in den HTTP-Headern, wenn die Datei abgerufen wird.

Unterstützte Bildinhaltstypen: Bild/JPEG, Bild/JPG, Bild/GIF, Bild/PNG
contentDescription

string

Optional. Textbeschreibung des Dateiinhalts. Screenreader verwenden diese Beschreibung, um Nutzern mit Behinderungen zu helfen, den Inhalt der Datei zu verstehen.
agentId

string

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

string

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.