Method: files.create

Medya veya zengin kart iletilerinde kullanılacak bir dosya yükler.

Aracı, dosyanın URL'sini veya ikili programını ve (isteğe bağlı olarak) ilgili küçük resim dosyasının URL'sini sağlar. RBM platformu, dosyayı 30 gün boyunca önbelleğe alır ve temsilci mesajları gönderirken dosyayı tanımlamak için kullanabileceğiniz benzersiz bir ad döndürür.

İkili dosya yüklemek için Yükleme URI'sine bir HTTP POST isteği yapın, JSON istek gövdesinden fileUrl alanını çıkarın ve ikili değeri POST isteği gövdesi olarak belirtin. Örneğin, ikili dosyanın tam dosya yoluyla --upload-file cURL işaretini kullanın.

HTTP isteği

  • Medya yükleme istekleri için yükleme URI'si:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • Yalnızca meta veri istekleri için meta veri URI'si:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek gövdesi, aşağıdaki yapıyla birlikte veriler içerir:

JSON gösterimi
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Alanlar
fileUrl

string

İsteğe bağlı. Dosyanın herkese açık URL'si. RBM platformu, dosyanın MIME türünü, dosya getirilirken HTTP üstbilgilerindeki içerik türü alanından belirler.

Desteklenen resim içeriği türleri: resim/jpeg, resim/jpg, resim/gif, resim/png.

Desteklenen video içeriği türleri: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

thumbnailUrl

string

İsteğe bağlı. Dosyaya karşılık gelen küçük resmin herkese açık URL'si. Bu alan ayarlanmazsa RBM platformu otomatik olarak dosyadan bir küçük resim oluşturur. RBM platformu, dosyanın MIME türünü, dosya getirilirken HTTP üstbilgilerindeki içerik türü alanından belirler.

Desteklenen resim içeriği türleri: resim/jpeg, resim/jpg, resim/gif, resim/png.

contentDescription

string

İsteğe bağlı. Dosya içeriğinin metin açıklaması. Ekran okuyucular bu açıklamayı, engelli kullanıcıların dosyanın içeriğini anlamasına yardımcı olmak için kullanır.

agentId

string

Zorunlu. Temsilcinin benzersiz tanımlayıcısı.

Yanıt gövdesi

Bir temsilcinin ileti gönderirken dosyayı tanımlamak için kullanabileceği benzersiz ada sahip bir dosya kaynağı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "name": string
}
Alanlar
name

string

Dosya kaynağının sunucu tarafından atanan benzersiz adı. Bir aracı, ileti gönderirken dosyayı tanımlamak için bu adı kullanabilir. Biçim, "files/{uid}" şeklindedir ve {uid}, benzersiz bir kimliktir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleye bakın.