Method: files.create

Mengupload file untuk digunakan dalam pesan media atau kartu informasi.

Agen memberikan URL atau biner file dan (secara opsional) URL file thumbnail yang sesuai. Platform RBM menyimpan file dalam cache selama 30 hari dan menampilkan nama unik yang dapat Anda gunakan untuk mengidentifikasi file saat mengirim pesan agen.

Untuk mengupload biner file, buat permintaan POST HTTP ke URI Upload, hapus kolom fileUrl dari isi permintaan JSON, dan tentukan biner sebagai isi permintaan POST. Misalnya, gunakan tanda cURL --upload-file dengan jalur file yang sepenuhnya memenuhi syarat dari file biner.

Permintaan HTTP

  • URI upload, untuk permintaan upload media:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI Metadata, untuk permintaan khusus metadata:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Kolom
fileUrl

string

Opsional. URL file yang tersedia secara publik. Platform RBM menentukan jenis MIME file dari kolom content-type di header HTTP saat mengambil file. RBM mendukung gambar, audio, video, dan PDF.

Jenis konten gambar yang didukung: image/jpeg, image/jpg, image/gif, image/png.

Jenis konten audio yang didukung: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, aplikasi/ogg, audio/ogg.

Jenis konten video yang didukung: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Jenis konten pdf yang didukung: application/pdf.
thumbnailUrl

string

Opsional. URL thumbnail yang tersedia secara publik sesuai dengan file. Jika kolom ini tidak disetel, platform RBM akan otomatis membuat thumbnail dari file. Platform RBM menentukan jenis MIME file dari kolom content-type di header HTTP saat mengambil file.

Jenis konten gambar yang didukung: image/jpeg, image/jpg, image/gif, image/png.
contentDescription

string

Opsional. Deskripsi teks dari konten file. Pembaca layar menggunakan deskripsi ini untuk membantu pengguna difabel memahami isi file.
agentId

string

Wajib. ID unik agen.

Isi respons

Resource file dengan nama unik yang dapat digunakan agen untuk mengidentifikasi file saat mengirim pesan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "name": string
}
Kolom
name

string

Nama unik resource file yang ditetapkan server, yang dapat digunakan agen untuk mengidentifikasi file saat mengirim pesan. Formatnya adalah "files/{uid}", dengan {uid} adalah ID unik.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.