แหล่งข้อมูล: ข้อความ
ข้อความในการสนทนาระหว่างตัวแทนและผู้ใช้
การแสดง JSON |
---|
{ "name": string, "messageId": string, "representative": { object ( |
ช่อง | |
---|---|
name |
ชื่อของข้อความตามที่กำหนดโดย Business Messages เปลี่ยนเป็น "conversations/{conversationId}/messages/{messageId}" โดยที่ {conversationId} คือรหัสที่ไม่ซ้ำกันสำหรับการสนทนา และ {messageId} คือรหัสที่ไม่ซ้ำกันสำหรับข้อความ |
messageId |
ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของข้อความที่กำหนดโดยตัวแทน หากมีข้อความพยายามใช้ |
representative |
รายละเอียดเกี่ยวกับตัวแทน (มนุษย์หรือแชทบ็อต) ที่ส่งข้อความ |
suggestions[] |
รายการการตอบกลับที่แนะนำซึ่งปรากฏเป็นรายการชิปคำแนะนำหลังจากข้อความที่เกี่ยวข้อง สูงสุด 13 คำแนะนำ ชิปจะแสดงเฉพาะเมื่อข้อความที่เกี่ยวข้องเป็นข้อความล่าสุดในการสนทนาเท่านั้น (รวมทั้งข้อความจากตัวแทนและข้อความของผู้ใช้) ผู้ใช้สามารถแตะการตอบกลับที่แนะนำเพื่อส่งข้อความตอบกลับไปยังตัวแทน |
fallback |
ไม่บังคับ ข้อความสำรองที่แสดงขึ้นหากอุปกรณ์ของผู้ใช้ไม่รองรับประเภทข้อความหรือเนื้อหา สูงสุด 3,072 อักขระ |
containsRichText |
ไม่บังคับ หากเป็น |
ฟิลด์การรวม content เนื้อหาของข้อความ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
text |
SMS สูงสุด 3,072 อักขระ |
image |
ข้อความรูปภาพ |
richCard |
ข้อความ Rich Card |
รูปภาพ
รูปภาพ
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม content เนื้อหารูปภาพ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
contentInfo |
ข้อมูลเกี่ยวกับรูปภาพ รวมถึง URL ของรูปภาพและ URL ของรูปภาพขนาดย่อ |
ContentInfo
ข้อความที่มีข้อมูลเนื้อหา
การแสดง JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean, "altText": string } |
ช่อง | |
---|---|
fileUrl |
URL ของไฟล์ที่เข้าถึงได้แบบสาธารณะ แพลตฟอร์มจะกำหนดประเภท MIME ของไฟล์จากช่องประเภทเนื้อหาในส่วนหัว HTTP เมื่อแพลตฟอร์มดึงไฟล์ ต้องมีฟิลด์ content-type อยู่และถูกต้องในการตอบกลับ HTTP จาก URL สูงสุด 5 MB ประเภทเนื้อหาที่รองรับ: รูปภาพ/jpeg, รูปภาพ/jpg, รูปภาพ/png, รูปภาพ/webp |
thumbnailUrl |
ไม่บังคับ URL ของภาพขนาดย่อที่เข้าถึงได้แบบสาธารณะ หากไม่ระบุ URL ของภาพขนาดย่อ แพลตฟอร์มจะแสดงภาพขนาดย่อที่ว่างเปล่าของตัวยึดตำแหน่งจนกว่าอุปกรณ์ของผู้ใช้จะดาวน์โหลดไฟล์ ไม่เกิน 25 KB ประเภทเนื้อหาที่รองรับ: รูปภาพ/jpeg, รูปภาพ/jpg, รูปภาพ/png, รูปภาพ/webp |
forceRefresh |
หากตั้งค่าไว้ แพลตฟอร์มจะดึงข้อมูลไฟล์และภาพขนาดย่อจาก URL ที่ระบุ แม้ว่าแพลตฟอร์มจะแคชสำเนาไฟล์ (และ/หรือภาพขนาดย่อ) ไว้ก็ตาม |
altText |
ข้อความที่อธิบายรายละเอียดเกี่ยวกับสื่อเพื่อวัตถุประสงค์ในการช่วยเหลือพิเศษ |
RichCard
การ์ดริชมีเดียแบบสแตนด์อโลนหรือภาพสไลด์ของการ์ดริชมีเดียที่ส่งจาก Agent ไปยังผู้ใช้
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม card ประเภทของการ์ดริชมีเดีย card ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
standaloneCard |
บัตรสแตนด์อโลน |
carouselCard |
ภาพสไลด์ของการ์ด |
StandaloneCard
บัตรสแตนด์อโลน
การแสดง JSON |
---|
{
"cardContent": {
object ( |
ช่อง | |
---|---|
cardContent |
เนื้อหาการ์ด |
CardContent
เนื้อหาการ์ด
การแสดง JSON |
---|
{ "title": string, "description": string, "media": { object ( |
ช่อง | |
---|---|
title |
ไม่บังคับ ชื่อการ์ด สูงสุด 200 อักขระ |
description |
ไม่บังคับ คำอธิบายของการ์ด สูงสุด 2,000 อักขระ |
media |
ไม่บังคับ สื่อที่จะรวมไว้ในการ์ด |
suggestions[] |
ไม่บังคับ รายการคำแนะนำที่จะรวมไว้ในการ์ด แนะนำได้สูงสุด 4 รายการ |
สื่อ
ไฟล์สื่อภายในการ์ดริชมีเดีย
การแสดง JSON |
---|
{ "height": enum ( |
ช่อง | |
---|---|
height |
ความสูงของสื่อภายในการ์ดริชมีเดีย |
ฟิลด์การรวม content เนื้อหาสื่อ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
contentInfo |
ข้อมูลเกี่ยวกับไฟล์ ซึ่งรวมถึง URL ของไฟล์และ URL ภาพขนาดย่อของไฟล์ |
ส่วนสูง
ความสูงของสื่อ
Enum | |
---|---|
HEIGHT_UNSPECIFIED |
ไม่ได้ระบุ |
SHORT |
112 DP |
MEDIUM |
168 DP |
TALL |
264 DP ใช้ไม่ได้กับภาพสไลด์การ์ดริชมีเดียเมื่อตั้งค่าความกว้างของการ์ดเป็น SMALL |
คำแนะนำ
คำแนะนำภายในรายการชิป
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม option คำตอบที่แนะนำ option ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
reply |
คำแนะนำให้ผู้ใช้ตอบกลับด้วยข้อความที่ระบุ |
action |
การดำเนินการที่แนะนำที่เริ่มการดำเนินการดั้งเดิมในอุปกรณ์ |
liveAgentRequest |
คําขอให้ตัวแทนแบบเรียลไทม์เข้าร่วมการสนทนา |
authenticationRequest |
คำขอเพื่อเริ่มขั้นตอนการตรวจสอบสิทธิ์ |
SuggestedReply
เมื่อแตะแล้ว ระบบจะส่งข้อความตอบกลับไปยังตัวแทน
การแสดง JSON |
---|
{ "text": string, "postbackData": string } |
ช่อง | |
---|---|
text |
ข้อความที่แสดงในการตอบกลับที่แนะนำและส่งไปยังตัวแทนเมื่อผู้ใช้แตะคำตอบ สูงสุด 25 อักขระ |
postbackData |
สตริงที่ตัวแทนได้รับเมื่อผู้ใช้แตะการตอบกลับที่แนะนำ สูงสุด 2,048 อักขระ |
SuggestedAction
เมื่อแตะ จะเป็นการเริ่มการทำงานดั้งเดิมที่เกี่ยวข้องในอุปกรณ์
การแสดง JSON |
---|
{ "text": string, "postbackData": string, // Union field |
ช่อง | |
---|---|
text |
ข้อความที่แสดงในการดำเนินการที่แนะนำ สูงสุด 25 อักขระ |
postbackData |
สตริงที่ตัวแทนได้รับเมื่อผู้ใช้แตะการดำเนินการที่แนะนำ สูงสุด 2,048 อักขระ |
ฟิลด์การรวม action การดำเนินการแบบเนทีฟที่เริ่มต้นในอุปกรณ์เมื่อผู้ใช้แตะการดำเนินการที่แนะนำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
openUrlAction |
เปิด URL ที่ระบุ |
dialAction |
เปิดแอปโทรศัพท์เริ่มต้นของผู้ใช้ |
OpenUrlAction
เปิด URL ที่ระบุ
การแสดง JSON |
---|
{ "url": string } |
ช่อง | |
---|---|
url |
URL |
DialAction
เปิดแอปโทรศัพท์เริ่มต้นของผู้ใช้ที่มีการกรอกหมายเลขโทรศัพท์ที่ระบุ
การแสดง JSON |
---|
{ "phoneNumber": string } |
ช่อง | |
---|---|
phoneNumber |
ต้องระบุ หมายเลขโทรศัพท์ที่ระบุในรูปแบบ RFC 3966 เช่น "+1-201-555-0123" |
LiveAgentRequest
ประเภทนี้ไม่มีช่อง
เมื่อแตะ ระบบจะส่งคำขอให้ตัวแทนแบบเรียลไทม์เข้าร่วมการสนทนา
AuthenticationRequest
คำขอตรวจสอบสิทธิ์การสนทนา
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม authentication_type ประเภทการตรวจสอบสิทธิ์ authentication_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
oauth |
รายละเอียดสำหรับการตรวจสอบสิทธิ์ผ่าน OAuth |
OAuth
รายละเอียดสำหรับการตรวจสอบสิทธิ์ผ่าน OAuth
การแสดง JSON |
---|
{ "clientId": string, "codeChallenge": string, "scopes": [ string ], "codeChallengeMethod": string } |
ช่อง | |
---|---|
clientId |
ต้องระบุ รหัสของแอปพลิเคชันที่ขอสิทธิ์ |
codeChallenge |
ต้องระบุ การพิสูจน์โค้ดที่ใช้เพื่อแลกเปลี่ยนโทเค็นเพื่อการเข้าถึง |
scopes[] |
ต้องระบุ อาร์เรย์ที่ระบุขอบเขตของคำขอ |
codeChallengeMethod |
ไม่บังคับ วิธีการทดสอบโค้ดที่ใช้สร้างระบบทดสอบโค้ด หากละเว้นพารามิเตอร์นี้ เซิร์ฟเวอร์จะถือว่า |
CarouselCard
ภาพสไลด์ของการ์ด
การแสดง JSON |
---|
{ "cardWidth": enum ( |
ช่อง | |
---|---|
cardWidth |
ความกว้างของการ์ดในภาพสไลด์ |
cardContents[] |
รายการเนื้อหาของการ์ดแต่ละใบในภาพสไลด์ ภาพสไลด์มีการ์ดอย่างน้อย 2 ใบและได้สูงสุด 10 ใบ |
CardWidth
ความกว้างของการ์ดในภาพสไลด์
Enum | |
---|---|
CARD_WIDTH_UNSPECIFIED |
ไม่ได้ระบุ |
SMALL |
136 DP ใส่สื่อที่สูงไม่ได้ |
MEDIUM |
280 DP |
วิธีการ |
|
---|---|
|
ส่งข้อความจากตัวแทนไปยังผู้ใช้ |
|
ส่งใบตอบรับข้อความจากตัวแทนไปยังผู้ใช้ |