ทรัพยากร: AgentMessage
ข้อความที่ส่งจากตัวแทนถึงผู้ใช้
| การแสดง JSON |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| ช่อง | |
|---|---|
name |
แพลตฟอร์ม RCS for Business จะเป็นผู้ตั้งค่าช่องนี้ อย่าใส่ข้อมูลนี้เมื่อสร้างข้อความของตัวแทน ช่องนี้จะแสดงผลเป็น "phones/{E.164}/agentMessages/{messageId}" โดยที่ {E.164} คือหมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 และ {messageId} คือรหัสที่ตัวแทนกำหนดสำหรับข้อความของตัวแทน |
sendTime |
แพลตฟอร์ม RCS for Business จะเป็นผู้ตั้งค่าช่องนี้ อย่าใส่ข้อมูลนี้เมื่อสร้างข้อความของตัวแทน ช่องนี้จะแสดงเวลาที่ส่งข้อความถึงผู้ใช้ ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
contentMessage |
เนื้อหาของข้อความจาก Agent |
messageTrafficType |
ประเภทการเข้าชมข้อความ |
richMessageClassification |
เอาต์พุตเท่านั้น จัดประเภทข้อความตามรูปแบบการเรียกเก็บเงินของสหรัฐอเมริกา ดูรายละเอียดเกี่ยวกับการแยกประเภทแต่ละประเภทได้ที่คู่มือรูปแบบการเรียกเก็บเงินในสหรัฐอเมริกา ระบบจะป้อนข้อมูลในช่องนี้สำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น |
totalPayloadSizeBytes |
เอาต์พุตเท่านั้น ขนาดเพย์โหลดรวมของข้อความในหน่วยไบต์ เพย์โหลดจะนับไฟล์แนบทั้งหมดในข้อความ RCS for Business ซึ่งอาจเป็นวิดีโอ รูปภาพ PDF ฯลฯ ยกเว้นข้อความหรือคำแนะนำ ปัจจุบันระบบจะป้อนข้อมูลในช่องนี้สำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น |
carrier |
เอาต์พุตเท่านั้น ข้อมูลผู้ให้บริการที่เป็นเจ้าของหมายเลขโทรศัพท์ของผู้ใช้ตามแบ็กเอนด์ของ Google RCS ปัจจุบันระบบจะป้อนข้อมูลในช่องนี้สำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น |
| ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
expireTime |
ไม่บังคับ การประทับเวลาในรูปแบบ UTC ของเวลาที่ถือว่าทรัพยากรนี้หมดอายุ ต้องผ่านไปอย่างน้อย 6 วินาทีหลังจากส่งข้อความ หากมีการระบุการประทับเวลาในอนาคตที่น้อยกว่า 6 วินาทีหลังจากส่ง แพลตฟอร์มจะปรับเป็น 6 วินาทีโดยอัตโนมัติ การประทับเวลาใดๆ ที่ตรงกับหรือก่อนเวลาส่งข้อความจะแสดงข้อผิดพลาด ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
ttl |
ไม่บังคับ อินพุตเท่านั้น ระยะเวลาที่ข้อความจะคงอยู่ก่อนที่จะถูกเพิกถอนโดยอัตโนมัติ ค่าต่ำสุดคือ 6 วินาที หากระบุระยะเวลาเป็นค่าบวกที่น้อยกว่า 6 วินาที แพลตฟอร์มจะปรับเป็น 6 วินาทีโดยอัตโนมัติ และแสดงค่าที่ปรับแล้วในช่อง ระยะเวลาเป็นวินาทีที่มีเศษส่วนไม่เกิน 9 หลัก โดยลงท้ายด้วย " |
| สิ้นสุดฟิลด์ที่แยกกัน | |
AgentContentMessage
เนื้อหาของข้อความที่ส่งจากตัวแทนถึงผู้ใช้
| การแสดง JSON |
|---|
{ "suggestions": [ { object ( |
| ช่อง | |
|---|---|
suggestions[] |
รายการการตอบกลับที่แนะนำและการดำเนินการที่แนะนำซึ่งปรากฏเป็นรายการชิปคำแนะนำตามข้อความของ Agent ที่เกี่ยวข้อง มีคำแนะนำได้สูงสุด 11 รายการ ชิปจะแสดงก็ต่อเมื่อข้อความของตัวแทนที่เชื่อมโยงเป็นข้อความล่าสุดในการสนทนา (รวมถึงข้อความของทั้งตัวแทนและผู้ใช้) ผู้ใช้สามารถแตะการตอบกลับที่แนะนำเพื่อส่งข้อความตอบกลับไปยังตัวแทน หรือแตะการดำเนินการที่แนะนำเพื่อเริ่มการดำเนินการแบบเนทีฟในอุปกรณ์ รูปแบบคำแนะนำมี 2 ประเภท ได้แก่ แบบถาวรและแบบชั่วคราว โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อคำแนะนำ |
| เนื้อหาของข้อความจาก Agent ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
text |
ข้อความที่เข้ารหัสเป็น UTF-8 สูงสุด 3,072 อักขระ |
fileName |
ชื่อที่ไม่ซ้ำกันของไฟล์ แพลตฟอร์ม RCS for Business จะแสดงชื่อไฟล์เมื่อตัวแทนอัปโหลดไฟล์ เลิกใช้งานแล้วเพื่อสนับสนุน uploadedRbmFile ด้านล่าง |
uploadedRbmFile |
มีตัวระบุสำหรับไฟล์และภาพปกที่อัปโหลดและแสดงโดยเซิร์ฟเวอร์ RCS for Business |
richCard |
Rich Card แบบสแตนด์อโลน |
contentInfo |
ข้อมูลเกี่ยวกับไฟล์ รวมถึง URL ของไฟล์และ URL ของภาพขนาดย่อของไฟล์ แพลตฟอร์ม RCS for Business จะแสดงเนื้อหาจากแคช แต่ตัวแทนสามารถบังคับให้แพลตฟอร์ม RCS for Business ดึงเนื้อหาเวอร์ชันใหม่และรีเฟรชแคชได้ |
| สิ้นสุดฟิลด์ที่แยกกัน | |
UploadedRbmFile
ข้อความที่มีข้อมูลไฟล์และภาพปก
| การแสดง JSON |
|---|
{ "fileName": string, "thumbnailName": string } |
| ช่อง | |
|---|---|
fileName |
ชื่อไฟล์ที่แพลตฟอร์ม RCS for Business แสดงผลเมื่ออัปโหลดไฟล์ |
thumbnailName |
ชื่อของภาพปกที่แพลตฟอร์ม RCS for Business แสดงผลเมื่ออัปโหลดภาพปก |
RichCard
Rich Card แบบสแตนด์อโลนหรือภาพสไลด์ของ Rich Card ที่ส่งจากตัวแทนไปยังผู้ใช้
| การแสดง JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "carouselCard": { object ( |
| ช่อง | |
|---|---|
| การ์ดแบบสแตนด์อโลนหรือภาพสไลด์การ์ด ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
carouselCard |
ภาพสไลด์การ์ด |
standaloneCard |
การ์ดแบบสแตนด์อโลน |
| สิ้นสุดฟิลด์ที่แยกกัน | |
CarouselCard
ภาพสไลด์การ์ด
| การแสดง JSON |
|---|
{ "cardWidth": enum ( |
| ช่อง | |
|---|---|
cardWidth |
ความกว้างของการ์ดในภาพสไลด์ |
cardContents[] |
รายการเนื้อหาสำหรับการ์ดแต่ละใบในภาพสไลด์ ภาพสไลด์ต้องมีการ์ดอย่างน้อย 2 ใบและไม่เกิน 10 ใบ |
CarouselCard.CardWidth
ความกว้างของการ์ดในภาพสไลด์
| Enum | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
ไม่ได้ระบุ |
SMALL |
120 DP |
MEDIUM |
232 DP |
CardContent
เนื้อหาการ์ด
| การแสดง JSON |
|---|
{ "title": string, "description": string, "media": { object ( |
| ช่อง | |
|---|---|
title |
(ไม่บังคับ) ชื่อของการ์ด สูงสุด 200 อักขระ |
description |
(ไม่บังคับ) คำอธิบายของการ์ด สูงสุด 2,000 อักขระ |
media |
(ไม่บังคับ) สื่อ (รูปภาพ, GIF, วิดีโอ, PDF) ที่จะรวมไว้ในการ์ด |
suggestions[] |
(ไม่บังคับ) รายการคำแนะนำที่จะรวมไว้ในการ์ด สูงสุด 4 รายการ |
สื่อ
ไฟล์สื่อภายใน Rich Card
| การแสดง JSON |
|---|
{ "height": enum ( |
| ช่อง | |
|---|---|
height |
ความสูงของสื่อภายใน Rich Card ที่มีเลย์เอาต์แนวตั้ง สำหรับการ์ดแบบสแตนด์อโลนที่มีเลย์เอาต์แนวนอน ให้ใช้ |
contentDescription |
ไม่บังคับ อธิบายเนื้อหาสื่อเพื่อการช่วยเหลือพิเศษ โดยระบุข้อความแสดงแทน รองรับข้อความธรรมดาได้สูงสุด 200 อักขระ |
| เนื้อหาสื่อ รายการต่อไปนี้เป็นช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
fileName |
ชื่อไฟล์ที่ไม่ซ้ำกัน ซึ่งแพลตฟอร์ม RCS for Business แสดงผลเมื่ออัปโหลดไฟล์ เลิกใช้งานแล้วเพื่อสนับสนุน uploadedRbmFile ด้านล่าง |
uploadedRbmFile |
มีตัวระบุสำหรับไฟล์และภาพปกที่อัปโหลดและแสดงโดยเซิร์ฟเวอร์ RCS for Business |
contentInfo |
ข้อมูลเกี่ยวกับไฟล์ ซึ่งรวมถึง URL ของไฟล์และ URL ของภาพปกของไฟล์ แพลตฟอร์ม RCS for Business จะแสดงเนื้อหาจากแคช แต่ตัวแทนสามารถบังคับให้แพลตฟอร์ม RCS for Business ดึงเนื้อหาเวอร์ชันใหม่และรีเฟรชแคชได้ |
| สิ้นสุดฟิลด์ที่แยกกัน | |
ContentInfo
ข้อความที่มีข้อมูลเนื้อหา
| การแสดง JSON |
|---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
| ช่อง | |
|---|---|
fileUrl |
URL ของไฟล์ที่เข้าถึงได้แบบสาธารณะ แพลตฟอร์ม RCS for Business จะกำหนดประเภท MIME ของไฟล์จากช่องประเภทเนื้อหาในส่วนหัว HTTP เมื่อแพลตฟอร์มดึงข้อมูลไฟล์ ช่อง content-type ต้องแสดงและถูกต้องในการตอบกลับ HTTP จาก URL ขนาดไฟล์สูงสุดที่แนะนำคือ 100 MB หมายเหตุ: ระบบไม่รองรับการเปลี่ยนเส้นทางใน URL ของไฟล์ โปรดใช้ CreateFileRequest หากจำเป็นต้องเปลี่ยนเส้นทาง |
thumbnailUrl |
(ไม่บังคับ สำหรับไฟล์รูปภาพ เสียง และวิดีโอเท่านั้น) URL ของภาพขนาดย่อที่เข้าถึงได้แบบสาธารณะ ขนาดสูงสุด 100 kB หากคุณไม่ได้ระบุ URL ภาพปก แพลตฟอร์ม RCS for Business จะแสดงภาพปกตัวยึดตำแหน่งเปล่าจนกว่าอุปกรณ์ของผู้ใช้จะดาวน์โหลดไฟล์ ทั้งนี้ขึ้นอยู่กับการตั้งค่าของผู้ใช้ ไฟล์อาจไม่ดาวน์โหลดโดยอัตโนมัติและอาจกำหนดให้ผู้ใช้แตะปุ่มดาวน์โหลด หมายเหตุ: ระบบไม่รองรับการเปลี่ยนเส้นทางใน URL ของไฟล์ โปรดใช้ CreateFileRequest หากจำเป็นต้องเปลี่ยนเส้นทาง |
forceRefresh |
หากตั้งค่าไว้ แพลตฟอร์ม RCS for Business จะดึงข้อมูลไฟล์และภาพขนาดย่อจาก URL ที่ระบุ แม้ว่าแพลตฟอร์มจะมีสำเนาไฟล์ (และ/หรือภาพขนาดย่อ) ที่แคชไว้ก็ตาม |
Media.Height
ความสูงของสื่อ
| Enum | |
|---|---|
HEIGHT_UNSPECIFIED |
ไม่ได้ระบุ |
SHORT |
112 DP |
MEDIUM |
168 DP |
TALL |
264 DP |
คำแนะนำ
การตอบกลับที่แนะนำหรือการดำเนินการที่แนะนำซึ่งรวมอยู่ใน Rich Card หรือในรายการชิปคำแนะนำ
| การแสดง JSON |
|---|
{ "suggestionDisplay": enum ( |
| ฟิลด์ | |
|---|---|
suggestionDisplay |
ไม่บังคับ ควบคุมลักษณะการแสดงผลของคำแนะนำ ใช้ได้กับข้อความธรรมดาที่ส่งไปยังไคลเอ็นต์ Google Messages (เวอร์ชัน 20260225.00 ขึ้นไป) เท่านั้น ต้องตั้งค่าช่องนี้ในคำแนะนำแบบสแตนด์อโลนที่เชื่อมโยงกับข้อความธรรมดาเท่านั้น เซิร์ฟเวอร์จะปฏิเสธข้อความหากใช้ช่องนี้กับคำแนะนำใน Rich Card หรือคำแนะนำแบบสแตนด์อโลนที่มีการโอนไฟล์ การตั้งค่านี้จะได้รับการจัดรูปแบบเป็นอนุกรมสำหรับ Google Messages เท่านั้น โดยไคลเอ็นต์อื่นๆ (เช่น iOS หรือ Samsung) จะไม่สนใจการตั้งค่านี้ |
| การตอบกลับที่แนะนำหรือการดำเนินการที่แนะนำ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
reply |
ผู้ใช้สามารถแตะการตอบกลับที่แนะนำเพื่อส่งข้อความตอบกลับไปยังตัวแทนได้ |
action |
ผู้ใช้สามารถแตะการดำเนินการที่แนะนำเพื่อเริ่มการดำเนินการที่เกี่ยวข้องในอุปกรณ์ |
| สิ้นสุดฟิลด์ที่แยกกัน | |
SuggestedReply
เมื่อแตะ ระบบจะส่งข้อความตอบกลับไปยังตัวแทน
| การแสดง JSON |
|---|
{ "text": string, "postbackData": string } |
| ช่อง | |
|---|---|
text |
ข้อความที่แสดงในการตอบกลับที่แนะนำและส่งกลับไปยังตัวแทนเมื่อผู้ใช้แตะข้อความนั้น สูงสุด: 25 อักขระ |
postbackData |
เพย์โหลดที่เข้ารหัส Base64 ซึ่งตัวแทนได้รับในเหตุการณ์ของผู้ใช้เมื่อผู้ใช้แตะการตอบกลับที่แนะนำ |
SuggestedAction
เมื่อแตะ ระบบจะเริ่มการดำเนินการที่เกี่ยวข้องในอุปกรณ์
| การแสดง JSON |
|---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "dialAction": { object ( |
| ช่อง | |
|---|---|
text |
ข้อความที่แสดงในการดำเนินการที่แนะนำ สูงสุด: 25 อักขระ |
postbackData |
เพย์โหลด (เข้ารหัส base64) ที่จะส่งไปยังตัวแทนในเหตุการณ์ของผู้ใช้ซึ่งเป็นผลลัพธ์เมื่อผู้ใช้แตะการดำเนินการที่แนะนำ ยาวไม่เกิน 2,048 อักขระ |
fallbackUrl |
(ไม่บังคับ) URL สำรองที่จะใช้หากไคลเอ็นต์ไม่รองรับการดำเนินการที่แนะนำ URL สำรองจะเปิดในหน้าต่างเบราว์เซอร์ใหม่ ต้องเป็น URI ที่ถูกต้องตามที่กำหนดไว้ใน RFC 3986 ยาวไม่เกิน 2,048 อักขระ |
| การดำเนินการที่มาพร้อมเครื่องซึ่งเริ่มต้นในอุปกรณ์เมื่อผู้ใช้แตะการดำเนินการที่แนะนำ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
dialAction |
เปิดแอปโทรศัพท์เริ่มต้นของผู้ใช้โดยกรอกหมายเลขโทรศัพท์ที่ตัวแทนระบุไว้ |
viewLocationAction |
เปิดแอปแผนที่เริ่มต้นของผู้ใช้และเลือกตำแหน่งที่ตัวแทนระบุ หรือค้นหาบริเวณรอบๆ ตำแหน่งของผู้ใช้ตามคำค้นหาที่ตัวแทนระบุ |
createCalendarEventAction |
เปิดแอปปฏิทินเริ่มต้นของผู้ใช้และเริ่มขั้นตอนกิจกรรมในปฏิทินใหม่โดยกรอกข้อมูลเหตุการณ์ที่ตัวแทนระบุไว้ล่วงหน้า |
openUrlAction |
เปิดแอปเว็บเบราว์เซอร์เริ่มต้นของผู้ใช้ไปยัง URL ที่ระบุ หากผู้ใช้ติดตั้งแอปที่ลงทะเบียนเป็นตัวแฮนเดิลเริ่มต้นสำหรับ URL ไว้ ระบบจะเปิดแอปนี้แทน และจะใช้ไอคอนของแอปใน UI การดำเนินการที่แนะนำ |
shareLocationAction |
เปิดเครื่องมือเลือกตำแหน่งของแอป RCS เพื่อให้ผู้ใช้เลือกตำแหน่งที่จะส่งไปยังตัวแทนได้ |
| สิ้นสุดฟิลด์ที่แยกกัน | |
DialAction
เปิดแอปโทรศัพท์เริ่มต้นของผู้ใช้โดยกรอกหมายเลขโทรศัพท์ที่ตัวแทนระบุไว้
| การแสดง JSON |
|---|
{ "phoneNumber": string } |
| ช่อง | |
|---|---|
phoneNumber |
หมายเลขโทรศัพท์ในรูปแบบ E.164 เช่น +12223334444 |
ViewLocationAction
เปิดแอปแผนที่เริ่มต้นของผู้ใช้และเลือกตำแหน่งที่ตัวแทนระบุ หรือค้นหาบริเวณรอบๆ ตำแหน่งของผู้ใช้ตามคำค้นหาที่ตัวแทนระบุ
| การแสดง JSON |
|---|
{
"latLong": {
object ( |
| ช่อง | |
|---|---|
latLong |
(ไม่บังคับ) ละติจูดและลองจิจูดของสถานที่ที่ระบุ |
label |
(ไม่บังคับ) ป้ายกำกับของหมุดที่วางที่ latLong |
query |
(ไม่บังคับ) แทนที่จะระบุ latLong (และป้ายกำกับ (ไม่บังคับ)) ตัวแทนสามารถระบุสตริงการค้นหาได้ สำหรับแอปแผนที่เริ่มต้นที่รองรับฟังก์ชันการค้นหา (รวมถึง Google Maps) การแตะการดำเนินการที่แนะนำนี้จะส่งผลให้เกิดการค้นหาตำแหน่งที่อยู่รอบๆ ตำแหน่งปัจจุบันของผู้ใช้ หากคำค้นหามีความเฉพาะเจาะจงเพียงพอ ตัวแทนจะใช้คำค้นหานั้นเพื่อเลือกสถานที่ใดก็ได้ในโลก เช่น การตั้งค่าสตริงคำค้นหาเป็น "Growing Tree Bank" จะแสดงสถานที่ตั้งของ Growing Tree Bank ทั้งหมดในบริเวณใกล้เคียงของผู้ใช้ การตั้งค่าสตริงการค้นหาเป็น "1600 Amphitheater Parkway, Mountain View, CA 94043" จะเลือกที่อยู่ที่เฉพาะเจาะจงนั้น ไม่ว่าผู้ใช้จะอยู่ที่ใดก็ตาม |
LatLng
ออบเจ็กต์ที่แสดงคู่ละติจูด/ลองจิจูด ซึ่งจะแสดงเป็นคู่ของค่า Double เพื่อแสดงองศาละติจูดและองศาลองจิจูด ออบเจ็กต์นี้ต้องเป็นไปตาม มาตรฐาน WGS84 เว้นแต่จะระบุไว้เป็นอย่างอื่น ค่าต้องอยู่ในช่วงที่ปรับให้เป็นมาตรฐาน
| การแสดง JSON |
|---|
{ "latitude": number, "longitude": number } |
| ช่อง | |
|---|---|
latitude |
ละติจูดในหน่วยองศา โดยต้องอยู่ในช่วง [-90.0, +90.0] |
longitude |
ลองจิจูดเป็นองศา โดยต้องอยู่ในช่วง [-180.0, +180.0] |
CreateCalendarEventAction
เปิดแอปปฏิทินเริ่มต้นของผู้ใช้และเริ่มขั้นตอนกิจกรรมในปฏิทินใหม่โดยกรอกข้อมูลเหตุการณ์ที่ตัวแทนระบุไว้ล่วงหน้า
| การแสดง JSON |
|---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
| ช่อง | |
|---|---|
startTime |
เวลาเริ่มต้นกิจกรรม ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
endTime |
เวลาสิ้นสุดกิจกรรม ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
title |
ชื่อกิจกรรม ยาวไม่เกิน 100 อักขระ |
description |
คำอธิบายกิจกรรม สูงสุด 500 อักขระ |
OpenUrlAction
เปิดแอปเว็บเบราว์เซอร์เริ่มต้นของผู้ใช้ไปยัง URL ที่ระบุ หากผู้ใช้ติดตั้งแอปที่ลงทะเบียนเป็นตัวแฮนเดิลเริ่มต้นสำหรับ URL ไว้ ระบบจะเปิดแอปนี้แทน และจะใช้ไอคอนของแอปใน UI การดำเนินการที่แนะนำ
| การแสดง JSON |
|---|
{ "url": string, "application": enum ( |
| ช่อง | |
|---|---|
url |
URL ที่จะเปิด ตั้งแต่วันที่ 1 พฤศจิกายน 2025 เป็นต้นไป URL Scheme ต้องเป็น https:// หรือ http:// คำขอ API ที่ใช้รูปแบบอื่นๆ (เช่น tel:, mailto:, sms:) จะถูกปฏิเสธพร้อมข้อผิดพลาด 400 Bad Request หลังจากวันที่นี้ URL ต้องเป็น URI ที่ถูกต้องตามที่กำหนดไว้ใน RFC 3986 ยาวไม่เกิน 2,048 อักขระ |
application |
URL เปิดแอปพลิเคชัน เบราว์เซอร์ หรือ WebView หากต้องการตรวจสอบว่าอุปกรณ์ของผู้ใช้รองรับโหมด WebView หรือไม่ ให้เรียกใช้การตรวจสอบความสามารถก่อน ดูรายละเอียดได้ในเอกสารประกอบ: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities |
webviewViewMode |
โหมดดูสำหรับ WebView |
description |
คำอธิบายการช่วยเหลือพิเศษสำหรับ WebView |
OpenUrlApplication
ประเภทของแอปพลิเคชันที่เปิด URL
| Enum | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
ไม่ได้ระบุ จะใช้เบราว์เซอร์เพื่อเปิด |
BROWSER |
ใช้เบราว์เซอร์เพื่อเปิด URL |
WEBVIEW |
เปิด URL ในหน้าต่าง WebView แบบผสานรวม |
WebviewViewMode
ประเภทของโหมดการดูของ WebView
| Enum | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
ไม่ได้ระบุ หากต้องการใช้ WebView คุณต้องระบุโหมดการดู |
FULL |
ต้องมีการวางซ้อนแบบเต็มหน้าจอพร้อมป้ายกำกับการสนทนากับแชทบ็อตภายในแถบสถานะ |
HALF |
ต้องใช้การวางซ้อนครึ่งหน้าจอ |
TALL |
ต้องใช้การวางซ้อนหน้าจอขนาด 3 ใน 4 |
Suggestion.SuggestionDisplay
ลักษณะการแสดงผลของคำแนะนำข้อความแบบสแตนด์อโลน
| Enum | |
|---|---|
SUGGESTION_DISPLAY_UNSPECIFIED |
ไคลเอ็นต์จะใช้ลักษณะการแสดงผลเริ่มต้นดังนี้
|
PERSISTENT |
คำแนะนำจะยังคงปรากฏในบับเบิลข้อความอย่างต่อเนื่อง แม้ว่าจะมีการเพิ่มข้อความใหม่ในการสนทนาก็ตาม |
StandaloneCard
การ์ดแบบสแตนด์อโลน
| การแสดง JSON |
|---|
{ "cardOrientation": enum ( |
| ช่อง | |
|---|---|
cardOrientation |
การวางแนวของการ์ด |
thumbnailImageAlignment |
การจัดแนวตัวอย่างรูปภาพสําหรับการ์ดแบบสแตนด์อโลนที่มีเลย์เอาต์แนวนอน |
cardContent |
เนื้อหาการ์ด |
StandaloneCard.CardOrientation
การวางแนวของการ์ด
| Enum | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
ไม่ได้ระบุ |
HORIZONTAL |
เลย์เอาต์แนวนอน หาก |
VERTICAL |
เลย์เอาต์แนวตั้ง |
StandaloneCard.ThumbnailImageAlignment
การจัดแนวตัวอย่างรูปภาพสําหรับการ์ดแบบสแตนด์อโลนที่มีเลย์เอาต์แนวนอน
| Enum | |
|---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
ไม่ได้ระบุ |
LEFT |
ตัวอย่างไฟล์จะจัดชิดซ้าย |
RIGHT |
ตัวอย่างไฟล์จะจัดชิดขวา |
MessageTrafficType
ประเภทการเข้าชมข้อความที่รองรับ ระบบจะขยาย enum เพื่อรองรับประเภทการเข้าชมเพิ่มเติม โปรดทราบว่าแม้กรณีการใช้งานของตัวแทนจะให้คำแนะนำเกี่ยวกับประเภทการเข้าชมที่จะใช้ได้ แต่ก็ไม่มีการบังคับใช้ API กับความสัมพันธ์ดังกล่าว
| Enum | |
|---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
ลักษณะการทำงานเริ่มต้น: ประเภทการเข้าชมข้อความจะกำหนดโดยกรณีการใช้งานของ Agent อัปเดตประเภทการเข้าชมตามความจำเป็นโดยอิงตามเนื้อหาข้อความ สำหรับ Agent ที่ใช้งานได้หลายอย่าง จะไม่มีค่าเริ่มต้นให้ ควรตั้งค่าประเภทการเข้าชมด้วยตนเอง (เช่น TRANSACTION, PROMOTION) |
AUTHENTICATION |
สำหรับข้อความการตรวจสอบสิทธิ์ (แนะนำสำหรับกรณีการใช้งานตัวแทน OTP) |
TRANSACTION |
สำหรับข้อความธุรกรรม (แนะนำสำหรับกรณีการใช้งานตัวแทนแบบธุรกรรมหรือแบบใช้งานหลายครั้ง) |
PROMOTION |
สำหรับข้อความโปรโมชัน (แนะนำสำหรับกรณีการใช้งานตัวแทนเพื่อการโปรโมตหรือการใช้งานหลายอย่าง) |
SERVICEREQUEST |
สำหรับข้อความเกี่ยวกับบริการที่ผู้ใช้ยินยอมรับ (แนะนำสำหรับกรณีการใช้งาน OTP, ธุรกรรม, โปรโมชัน หรือตัวแทนอเนกประสงค์) |
ACKNOWLEDGEMENT |
สำหรับข้อความที่รับทราบคำขอยกเลิกการสมัครของผู้ใช้ (แนะนำสำหรับกรณีการใช้งาน Agent แบบ OTP, ธุรกรรม, โปรโมชัน หรืออเนกประสงค์) |
RichMessageClassification
สำหรับการเรียกเก็บเงินในสหรัฐอเมริกาเท่านั้น: รายละเอียดเกี่ยวกับการแยกประเภทข้อความที่ใช้สำหรับการเรียกเก็บเงิน
| การแสดง JSON |
|---|
{
"classificationType": enum ( |
| ช่อง | |
|---|---|
classificationType |
|
segmentCount |
จำนวนกลุ่ม 160 ไบต์สำหรับข้อความของ SMS โดยจะปัดเศษขึ้นเสมอ คำนวณจากความยาวไบต์ UTF-8 ทั้งหมดของเนื้อหาข้อความเท่านั้น โดยไม่รวมข้อมูลจากการตอบกลับที่แนะนำหรือการดำเนินการ เช่น ข้อความที่มีความยาว 300 ไบต์จะมี segmentCount เท่ากับ 2 ระบบจะป้อนข้อมูลในช่องนี้สำหรับประเภท RICH_MESSAGE เท่านั้น |
RichMessageClassificationType
สำหรับการเรียกเก็บเงินในสหรัฐอเมริกาเท่านั้น: ระบุการแยกประเภทของข้อความสำหรับการเรียกเก็บเงิน
สำคัญ: ผู้ให้บริการในสหรัฐอเมริกาเป็นผู้กำหนดราคาสำหรับประเภทข้อความที่เรียกเก็บเงินได้ซึ่งอธิบายไว้ในหน้านี้ นอกจากนี้ ผู้ให้บริการในสหรัฐอเมริกายังเป็นผู้กำหนดค่าใช้จ่ายสุดท้ายของนักพัฒนาแอปสำหรับการส่งข้อความ RCS for Business ด้วย หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับราคาหรือข้อมูลสำหรับการเรียกเก็บเงิน โปรดติดต่อตัวแทนของผู้ให้บริการที่เหมาะสม
| Enum | |
|---|---|
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED |
ไม่ได้ระบุ |
RICH_MESSAGE |
ข้อความจะได้รับการจัดประเภทเป็น RICH ภายใต้เงื่อนไขต่อไปนี้ 1. โดยจะไม่มี Rich Card 2. โดยจะไม่มีไฟล์แนบ 3. การดำเนินการที่แนะนำที่มีอยู่ต้องเป็นการดำเนินการโทรหรือการดำเนินการเปิด URL ที่ไม่ได้ใช้ WebView |
RICH_MEDIA_MESSAGE |
ข้อความที่ไม่เป็นไปตามเกณฑ์ RICH_MESSAGE ซึ่งรวมถึงข้อความที่มี Rich Card, ไฟล์สื่อ หรือการดำเนินการที่แนะนำนอกเหนือจากการโทรหรือเปิด URL ในเบราว์เซอร์ |
SUGGESTED_ACTION_CLICK |
แสดงถึงการแตะของผู้ใช้ในการดำเนินการที่แนะนำ (ไม่ใช่การตอบกลับที่แนะนำ) การจัดประเภทนี้ใช้กับการดำเนินการของผู้ใช้เท่านั้น และจะปรากฏในเพย์โหลด UserMessage ของเว็บฮุคเท่านั้น โดยจะไม่มีผลกับข้อความ A2P |
เมธอด |
|
|---|---|
|
ส่งข้อความจากตัวแทนไปยังผู้ใช้ |
|
เพิกถอนข้อความของตัวแทนที่ส่งแล้วแต่ยังไม่ได้นำส่ง |