Method: files.create

อัปโหลดไฟล์เพื่อใช้ในสื่อหรือข้อความ Rich Card

ตัวแทนจะระบุ URL หรือไบนารีของไฟล์ และ (ไม่บังคับ) URL ของไฟล์ภาพขนาดย่อที่เกี่ยวข้อง แพลตฟอร์ม RBM จะแคชไฟล์เป็นเวลา 30 วันและแสดงผลชื่อที่ไม่ซ้ำกันที่คุณสามารถใช้ระบุไฟล์เมื่อส่งข้อความจากตัวแทน

หากต้องการอัปโหลดไฟล์ไบนารี ให้ส่งคำขอ HTTP POST ไปยัง URI การอัปโหลด อย่าใส่ช่อง fileUrl ในเนื้อหาคำขอ JSON และระบุไบนารีเป็นส่วนเนื้อหาของคำขอ POST เช่น ใช้แฟล็ก cURL --upload-file กับเส้นทางไฟล์ที่สมบูรณ์ในตัวเองของไฟล์ไบนารี

คำขอ HTTP

  • อัปโหลด URI สำหรับคำขออัปโหลดสื่อ:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI ข้อมูลเมตา สำหรับคำขอที่มีข้อมูลเมตาเท่านั้น:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
ช่อง
fileUrl

string

ไม่บังคับ URL ของไฟล์ที่เผยแพร่แบบสาธารณะ แพลตฟอร์ม RBM จะกำหนดประเภท MIME ของไฟล์จากช่องประเภทเนื้อหาในส่วนหัว HTTP เมื่อดึงข้อมูลไฟล์ RBM รองรับรูปภาพ เสียง วิดีโอ และ PDF

ประเภทเนื้อหารูปภาพที่รองรับ: image/jpeg, image/jpg, image/gif, image/png

ประเภทเนื้อหาเสียงที่รองรับ: เสียง/aac, เสียง/mp3, เสียง/mpeg, เสียง/mpg, เสียง/mp4, เสียง/mp4-latm, เสียง/3gpp, แอปพลิเคชัน/ogg, เสียง/ogg

ประเภทเนื้อหาวิดีโอที่รองรับ: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm

ประเภทเนื้อหา PDF ที่รองรับ: application/pdf
thumbnailUrl

string

ไม่บังคับ URL ที่พร้อมใช้งานแบบสาธารณะของภาพขนาดย่อที่เกี่ยวข้องกับไฟล์ หากไม่ได้ตั้งค่าช่องนี้ แพลตฟอร์ม RBM จะสร้างภาพขนาดย่อจากไฟล์โดยอัตโนมัติ แพลตฟอร์ม RBM จะกำหนดประเภท MIME ของไฟล์จากช่องประเภทเนื้อหาในส่วนหัว HTTP เมื่อดึงข้อมูลไฟล์

ประเภทเนื้อหารูปภาพที่รองรับ: image/jpeg, image/jpg, image/gif, image/png
contentDescription

string

ไม่บังคับ ข้อความอธิบายเนื้อหาของไฟล์ โปรแกรมอ่านหน้าจอใช้คำอธิบายนี้เพื่อช่วยให้ผู้ใช้ที่มีความพิการเข้าใจว่าไฟล์ประกอบด้วยอะไรบ้าง
agentId

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของตัวแทน

เนื้อหาการตอบกลับ

ทรัพยากรไฟล์ซึ่งมีชื่อที่ไม่ซ้ำกันซึ่ง Agent จะใช้เพื่อระบุไฟล์เมื่อส่งข้อความได้

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "name": string
}
ช่อง
name

string

ชื่อที่ไม่ซ้ำกันที่เซิร์ฟเวอร์กำหนดของทรัพยากรไฟล์ ซึ่ง Agent จะใช้เพื่อระบุไฟล์เมื่อส่งข้อความได้ รูปแบบคือ "files/{uid}" โดยที่ {uid} เป็นรหัสที่ไม่ซ้ำกัน

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0