Method: files.create

อัปโหลดไฟล์เพื่อใช้ในข้อความมีเดียหรือการ์ดริชมีเดีย

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

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

คำขอ 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 เมื่อดึงข้อมูลไฟล์

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

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

string

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

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

string

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

string

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

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

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

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

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

string

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมของ OAuth 2.0