REST Resource: phones.agentMessages

ทรัพยากร: AgentMessage

ข้อความที่ตัวแทนส่งถึงผู้ใช้

การแสดง JSON
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },
  "messageTrafficType": enum (MessageTrafficType),
  "richMessageClassification": {
    object (RichMessageClassification)
  },
  "totalPayloadSizeBytes": string,
  "carrier": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
ช่อง
name

string

แพลตฟอร์ม RCS for Business เป็นผู้กำหนดฟิลด์นี้ อย่าใส่ข้อมูลนี้เมื่อสร้างข้อความของตัวแทน ฟิลด์จะแปลง "phones/{E.164}/agentMessages/{messageId}" โดยที่ {E.164} คือหมายเลขโทรศัพท์ของผู้ใช้ในรูปแบบ E.164 และ {messageId} คือรหัสที่กำหนดโดยตัวแทนของข้อความตัวแทน

sendTime

string (Timestamp format)

แพลตฟอร์ม RCS for Business เป็นผู้กำหนดฟิลด์นี้ อย่าใส่ข้อมูลนี้เมื่อสร้างข้อความของตัวแทน ฟิลด์นี้จะระบุเวลาที่ส่งข้อความถึงผู้ใช้

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

contentMessage

object (AgentContentMessage)

เนื้อหาของข้อความตัวแทน

messageTrafficType

enum (MessageTrafficType)

ประเภทการเข้าชมข้อความ

richMessageClassification

object (RichMessageClassification)

เอาต์พุตเท่านั้น จัดประเภทข้อความตามรูปแบบการเรียกเก็บเงินของสหรัฐอเมริกา ดูรายละเอียดเกี่ยวกับการแยกประเภทแต่ละประเภทได้ในคู่มือรูปแบบการเรียกเก็บเงินของสหรัฐอเมริกา ระบบจะป้อนข้อมูลในช่องนี้สำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น

totalPayloadSizeBytes

string (int64 format)

เอาต์พุตเท่านั้น ขนาดเพย์โหลดทั้งหมดของข้อความเป็นไบต์ เพย์โหลดจะนับไฟล์แนบทั้งหมดในข้อความ RCS สำหรับธุรกิจ ซึ่งอาจเป็นวิดีโอ รูปภาพ PDF ฯลฯ ยกเว้นข้อความหรือคำแนะนำ ปัจจุบันช่องนี้จะแสดงข้อมูลสำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น

carrier

string

เอาต์พุตเท่านั้น ข้อมูลผู้ให้บริการที่หมายเลขโทรศัพท์ของผู้ใช้เป็นของตามแบ็กเอนด์ RCS ของ Google ปัจจุบันช่องนี้จะแสดงข้อมูลสำหรับหมายเลขโทรศัพท์ในสหรัฐอเมริกาเท่านั้น

ฟิลด์ Union expiration

expiration ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น

expireTime

string (Timestamp format)

ไม่บังคับ การประทับเวลาใน UTC ของเวลาที่ถือว่าทรัพยากรนี้หมดอายุ ค่านี้จะแสดงในเอาต์พุตหากมีการตั้งค่าไว้ หรือหากมีการตั้งค่าช่อง TTL

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

ttl

string (Duration format)

ไม่บังคับ อินพุตเท่านั้น ระยะเวลาที่ข้อความจะมีผลก่อนที่จะถูกเพิกถอนโดยอัตโนมัติ

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย 's' เช่น "3.5s"

AgentContentMessage

เนื้อหาของข้อความที่ตัวแทนส่งถึงผู้ใช้

การแสดง JSON
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
ช่อง
suggestions[]

object (Suggestion)

รายการการตอบกลับที่แนะนำและการดำเนินการที่แนะนำซึ่งปรากฏเป็นรายการชิปคำแนะนำหลังข้อความของตัวแทนที่เกี่ยวข้อง คำแนะนำสูงสุด 11 รายการ

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

ฟิลด์ Union content เนื้อหาของข้อความจากตัวแทน content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text

string

ข้อความที่เข้ารหัสใน UTF-8 ความยาวไม่เกิน 3,072 อักขระ

fileName
(deprecated)

string

ชื่อที่ไม่ซ้ำกันของไฟล์ แพลตฟอร์ม RCS for Business จะแสดงชื่อไฟล์เมื่อตัวแทนอัปโหลดไฟล์ เลิกใช้งานเพื่อสนับสนุน uploadedRbmFile ด้านล่าง

uploadedRbmFile

object (UploadedRbmFile)

มีตัวระบุสำหรับไฟล์และภาพขนาดย่อที่อัปโหลดไปยังเซิร์ฟเวอร์ RCS สำหรับธุรกิจและแสดงโดยเซิร์ฟเวอร์ดังกล่าว

richCard

object (RichCard)

Rich Card แบบสแตนด์อโลน

contentInfo

object (ContentInfo)

ข้อมูลเกี่ยวกับไฟล์ รวมถึง URL ของไฟล์และ URL ของภาพปกของไฟล์

แพลตฟอร์ม RCS for Business จะแสดงเนื้อหาจากแคช แต่ Agent สามารถบังคับให้แพลตฟอร์ม RCS for Business ดึงเนื้อหาเวอร์ชันใหม่และรีเฟรชแคชได้

UploadedRbmFile

ข้อความที่มีข้อมูลไฟล์และภาพขนาดย่อ

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

string

ชื่อของไฟล์ที่แพลตฟอร์ม RCS for Business ส่งคืนเมื่อมีการอัปโหลดไฟล์

thumbnailName

string

ชื่อของภาพขนาดย่อที่แพลตฟอร์ม RCS for Business แสดงเมื่อมีการอัปโหลดภาพขนาดย่อ

RichCard

การ์ดริชมีเดียแบบสแตนด์อโลนหรือภาพหมุนของการ์ดริชมีเดียที่เอเจนต์ส่งให้ผู้ใช้

การแสดง JSON
{

  // Union field card can be only one of the following:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
ช่อง
ฟิลด์ Union card การ์ดแบบเดี่ยวหรือภาพสไลด์การ์ด card ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
carouselCard

object (CarouselCard)

ภาพสไลด์ของการ์ด

standaloneCard

object (StandaloneCard)

การ์ดแบบสแตนด์อโลน

CarouselCard

ภาพสไลด์ของการ์ด

การแสดง JSON
{
  "cardWidth": enum (CarouselCard.CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
ช่อง
cardWidth

enum (CarouselCard.CardWidth)

ความกว้างของการ์ดในภาพสไลด์

cardContents[]

object (CardContent)

รายการเนื้อหาของการ์ดแต่ละใบในภาพสไลด์ โดยแคร์รอเซลจะมีได้ตั้งแต่ 2 การ์ดไปจนถึง 10 การ์ด

CarouselCard.CardWidth

ความกว้างของการ์ดในภาพสไลด์

Enum
CARD_WIDTH_UNSPECIFIED ไม่ได้ระบุ
SMALL 120 DP โปรดทราบว่าคุณจะใช้สื่อแนวตั้งไม่ได้
MEDIUM 232 DP.

CardContent

เนื้อหาของการ์ด

การแสดง JSON
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
ช่อง
title

string

(ไม่บังคับ) ชื่อของการ์ด สูงสุด 200 อักขระ

description

string

(ไม่บังคับ) คำอธิบายของการ์ด สูงสุด 2,000 อักขระ

media

object (Media)

(ไม่บังคับ) สื่อ (รูปภาพ, GIF, วิดีโอ, PDF) ที่จะรวมไว้ในการ์ด

suggestions[]

object (Suggestion)

(ไม่บังคับ) รายการคำแนะนำที่จะรวมไว้ในการ์ด แนะนำได้สูงสุด 4 รายการ

สื่อ

ไฟล์สื่อภายใน Rich Card

การแสดง JSON
{
  "height": enum (Media.Height),

  // Union field content can be only one of the following:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
ช่อง
height

enum (Media.Height)

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

ฟิลด์ Union content เนื้อหาสื่อ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
fileName
(deprecated)

string

ชื่อที่ไม่ซ้ำกันของไฟล์ ซึ่งแพลตฟอร์ม RCS for Business จะแสดงเมื่ออัปโหลดไฟล์ เลิกใช้งานเพื่อสนับสนุน uploadedRbmFile ด้านล่าง

uploadedRbmFile

object (UploadedRbmFile)

มีตัวระบุสำหรับไฟล์และภาพขนาดย่อที่อัปโหลดไปยังเซิร์ฟเวอร์ RCS สำหรับธุรกิจและแสดงโดยเซิร์ฟเวอร์ดังกล่าว

contentInfo

object (ContentInfo)

ข้อมูลเกี่ยวกับไฟล์ ซึ่งรวมถึง URL ของไฟล์และ URL ของภาพขนาดย่อของไฟล์

แพลตฟอร์ม RCS for Business จะแสดงเนื้อหาจากแคช แต่ Agent สามารถบังคับให้แพลตฟอร์ม RCS for Business ดึงเนื้อหาเวอร์ชันใหม่และรีเฟรชแคชได้

ContentInfo

ข้อความที่มีข้อมูลเนื้อหา

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

string

URL ของไฟล์ที่เข้าถึงได้แบบสาธารณะ แพลตฟอร์ม RCS สำหรับธุรกิจจะกำหนดประเภท MIME ของไฟล์จากฟิลด์ประเภทเนื้อหาในส่วนหัว HTTP เมื่อแพลตฟอร์มดึงข้อมูลไฟล์ ฟิลด์ Content-Type ต้องมีอยู่และถูกต้องในการตอบกลับ HTTP จาก URL ขนาดไฟล์สูงสุดที่แนะนำคือ 100 MB

หมายเหตุ: ระบบไม่รองรับการเปลี่ยนเส้นทางใน URL ของไฟล์ โปรดใช้ CreateFileRequest หากจำเป็นต้องเปลี่ยนเส้นทาง

thumbnailUrl

string

(ไม่บังคับ สำหรับไฟล์รูปภาพ เสียง และวิดีโอเท่านั้น) URL ของภาพขนาดย่อที่เข้าถึงได้แบบสาธารณะ ขนาดสูงสุด 100 KB

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

หมายเหตุ: ระบบไม่รองรับการเปลี่ยนเส้นทางใน URL ของไฟล์ โปรดใช้ CreateFileRequest หากจำเป็นต้องเปลี่ยนเส้นทาง

forceRefresh

boolean

หากตั้งค่าไว้ แพลตฟอร์ม RCS สำหรับธุรกิจจะดึงไฟล์และภาพขนาดย่อจาก URL ที่ระบุ แม้ว่าแพลตฟอร์มจะมีสำเนาไฟล์ (และ/หรือภาพขนาดย่อ) ที่แคชไว้ก็ตาม

Media.Height

ความสูงของสื่อ

Enum
HEIGHT_UNSPECIFIED ไม่ได้ระบุ
SHORT 112 DP
MEDIUM 168 DP
TALL 264 DP ใช้ไม่ได้กับภาพสไลด์ของการ์ดริชเมื่อตั้งค่าความกว้างของการ์ดเป็น "เล็ก"

คำแนะนำ

การตอบกลับที่แนะนำหรือการดำเนินการที่แนะนำซึ่งรวมอยู่ในการ์ด Rich หรือในรายการชิปคำแนะนำ

การแสดง JSON
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
ช่อง
ฟิลด์ Union option คำตอบที่แนะนำหรือการดำเนินการที่แนะนำ option ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
reply

object (SuggestedReply)

ผู้ใช้สามารถแตะคำตอบที่แนะนำเพื่อส่งข้อความตอบกลับไปยังตัวแทน

action

object (SuggestedAction)

ผู้ใช้สามารถแตะการดำเนินการที่แนะนำเพื่อเริ่มการดำเนินการดั้งเดิมที่เกี่ยวข้องในอุปกรณ์

SuggestedReply

เมื่อแตะแล้ว ระบบจะส่งข้อความตอบกลับไปยังตัวแทน

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

string

ข้อความที่แสดงในการตอบกลับที่แนะนำและส่งกลับไปยังตัวแทนเมื่อผู้ใช้แตะข้อความนั้น สูงสุด 25 อักขระ

postbackData

string

เพย์โหลดที่เข้ารหัส base64 ซึ่งเอเจนต์ได้รับในเหตุการณ์ของผู้ใช้เมื่อผู้ใช้แตะการตอบกลับที่แนะนำ

SuggestedAction

เมื่อแตะแล้ว จะเริ่มการดำเนินการดั้งเดิมที่เกี่ยวข้องในอุปกรณ์

การแสดง JSON
{
  "text": string,
  "postbackData": string,
  "fallbackUrl": string,

  // Union field action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of list of possible types for union field action.
}
ช่อง
text

string

ข้อความที่แสดงในการดำเนินการที่แนะนำ สูงสุด 25 อักขระ

postbackData

string

เพย์โหลด (เข้ารหัส Base64) ที่จะส่งไปยังตัวแทนในเหตุการณ์ของผู้ใช้ซึ่งเกิดขึ้นเมื่อผู้ใช้แตะการดำเนินการที่แนะนำ ยาวไม่เกิน 2,048 อักขระ

fallbackUrl

string

(ไม่บังคับ) URL สำรองที่จะใช้หากไคลเอ็นต์ไม่รองรับการดำเนินการที่แนะนำ URL สำรองจะเปิดในหน้าต่างเบราว์เซอร์ใหม่ ต้องเป็น URI ที่ถูกต้องตามที่กำหนดไว้ใน RFC 3986 ยาวไม่เกิน 2,048 อักขระ

ฟิลด์ Union action การดำเนินการดั้งเดิมที่เริ่มในอุปกรณ์เมื่อผู้ใช้แตะการดำเนินการที่แนะนำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
dialAction

object (DialAction)

เปิดแอปแป้นโทรศัพท์เริ่มต้นของผู้ใช้พร้อมหมายเลขโทรศัพท์ที่ตัวแทนระบุ

viewLocationAction

object (ViewLocationAction)

เปิดแอปแผนที่เริ่มต้นของผู้ใช้และเลือกสถานที่ที่ตัวแทนระบุ หรือค้นหาบริเวณรอบๆ ตำแหน่งของผู้ใช้ตามคำค้นหาที่ตัวแทนระบุ

createCalendarEventAction

object (CreateCalendarEventAction)

เปิดแอปปฏิทินเริ่มต้นของผู้ใช้และเริ่มขั้นตอนกิจกรรมในปฏิทินใหม่โดยมีข้อมูลกิจกรรมที่ตัวแทนระบุไว้ล่วงหน้า

openUrlAction

object (OpenUrlAction)

เปิดแอปเว็บเบราว์เซอร์เริ่มต้นของผู้ใช้ไปยัง URL ที่ระบุ หากผู้ใช้ติดตั้งแอปที่ลงทะเบียนเป็นตัวแฮนเดิลเริ่มต้นสำหรับ URL ไว้ ระบบจะเปิดแอปนี้แทน และจะใช้ไอคอนของแอปใน UI การดำเนินการที่แนะนำ

shareLocationAction

object (ShareLocationAction)

เปิดตัวเลือกตำแหน่งของแอป RCS เพื่อให้ผู้ใช้เลือกตำแหน่งที่จะส่งให้ตัวแทนได้

DialAction

เปิดแอปแป้นโทรศัพท์เริ่มต้นของผู้ใช้พร้อมหมายเลขโทรศัพท์ที่ตัวแทนระบุ

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

string

หมายเลขโทรศัพท์ในรูปแบบ E.164 เช่น +12223334444

ViewLocationAction

เปิดแอปแผนที่เริ่มต้นของผู้ใช้และเลือกสถานที่ที่ตัวแทนระบุ หรือค้นหาบริเวณรอบๆ ตำแหน่งของผู้ใช้ตามคำค้นหาที่ตัวแทนระบุ

การแสดง JSON
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
ช่อง
latLong

object (LatLng)

(ไม่บังคับ) ละติจูดและลองจิจูดของสถานที่ที่ระบุ

label

string

(ไม่บังคับ) ป้ายกำกับของหมุดที่วางที่ latLong

query

string

(ไม่บังคับ รองรับเฉพาะในไคลเอ็นต์ Android Messages) ตัวแทนสามารถระบุสตริงการค้นหาแทนการระบุ 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

number

ละติจูดเป็นองศา ต้องอยู่ในช่วง [-90.0, +90.0]

longitude

number

ลองจิจูดในหน่วยองศา ต้องอยู่ในช่วง [-180.0, +180.0]

CreateCalendarEventAction

เปิดแอปปฏิทินเริ่มต้นของผู้ใช้และเริ่มขั้นตอนกิจกรรมในปฏิทินใหม่โดยมีข้อมูลกิจกรรมที่ตัวแทนระบุไว้ล่วงหน้า

การแสดง JSON
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
ช่อง
startTime

string (Timestamp format)

เวลาเริ่มต้นของกิจกรรม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

endTime

string (Timestamp format)

เวลาสิ้นสุดกิจกรรม

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

title

string

ชื่อกิจกรรม ยาวไม่เกิน 100 อักขระ

description

string

คำอธิบายกิจกรรม สูงสุด 500 อักขระ

OpenUrlAction

เปิดแอปเว็บเบราว์เซอร์เริ่มต้นของผู้ใช้ไปยัง URL ที่ระบุ หากผู้ใช้ติดตั้งแอปที่ลงทะเบียนเป็นตัวแฮนเดิลเริ่มต้นสำหรับ URL ไว้ ระบบจะเปิดแอปนี้แทน และจะใช้ไอคอนของแอปใน UI การดำเนินการที่แนะนำ

การแสดง JSON
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
ช่อง
url

string

URL ที่จะเปิด ตั้งแต่วันที่ 1 พฤศจิกายน 2025 เป็นต้นไป รูปแบบ URL ต้องเป็น https:// หรือ http:// คำขอ API ที่ใช้รูปแบบอื่น (เช่น tel:, mailto:, sms:) จะถูกปฏิเสธโดยมีข้อผิดพลาด 400 Bad Request หลังจากวันที่นี้ URL ต้องเป็น URI ที่ถูกต้องตามที่กำหนดไว้ใน RFC 3986 ยาวไม่เกิน 2,048 อักขระ

application

enum (OpenUrlApplication)

URL เปิดแอปพลิเคชัน เบราว์เซอร์ หรือ WebView หากต้องการตรวจสอบว่าอุปกรณ์ของผู้ใช้รองรับโหมด WebView หรือไม่ ให้เรียกใช้การตรวจสอบความสามารถก่อน ดูรายละเอียดได้ที่เอกสารประกอบ https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities

webviewViewMode

enum (WebviewViewMode)

โหมดดูสำหรับ WebView

description

string

คำอธิบายการช่วยเหลือพิเศษสำหรับ 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

ShareLocationAction

ประเภทนี้ไม่มีฟิลด์

เปิดตัวเลือกตำแหน่งของแอป RCS เพื่อให้ผู้ใช้เลือกตำแหน่งที่จะส่งกลับไปให้ตัวแทนได้

StandaloneCard

การ์ดแบบสแตนด์อโลน

การแสดง JSON
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
ช่อง
cardOrientation

enum (StandaloneCard.CardOrientation)

การวางแนวของการ์ด

thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

การจัดแนวตัวอย่างรูปภาพสําหรับการ์ดแบบสแตนด์อโลนที่มีเลย์เอาต์แนวนอน

cardContent

object (CardContent)

เนื้อหาของการ์ด

StandaloneCard.CardOrientation

การวางแนวของการ์ด

Enum
CARD_ORIENTATION_UNSPECIFIED ไม่ได้ระบุ
HORIZONTAL

เลย์เอาต์แนวนอน

หาก object(CardContent) ของริชการ์ดแนวนอนมีฟิลด์ media ก็ต้องมีฟิลด์ title, description หรือ suggestions[] อย่างน้อย 1 รายการด้วย

VERTICAL เลย์เอาต์แนวตั้ง

StandaloneCard.ThumbnailImageAlignment

การจัดแนวตัวอย่างรูปภาพสําหรับการ์ดแบบสแตนด์อโลนที่มีเลย์เอาต์แนวนอน

Enum
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED ไม่ได้ระบุ
LEFT ตัวอย่างไฟล์จะจัดชิดซ้าย
RIGHT ตัวอย่างไฟล์จะอยู่ชิดขวา

MessageTrafficType

ประเภทการรับส่งข้อความที่รองรับ เราจะขยายการแจงนับเพื่อรองรับการเข้าชมประเภทอื่นๆ

Enum
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED ลักษณะการทำงานเริ่มต้น: ประเภทการเข้าชมข้อความจะกำหนดโดยกรณีการใช้งานของตัวแทน อัปเดตประเภทการเข้าชมตามต้องการโดยอิงตามเนื้อหาของข้อความ สำหรับเอเจนต์แบบมัลติยูส จะไม่มีค่าเริ่มต้น ต้องตั้งค่าประเภทการเข้าชมด้วยตนเอง (เช่น ธุรกรรม โปรโมชัน)
AUTHENTICATION สำหรับข้อความการตรวจสอบสิทธิ์ในกรณีการใช้งานตัวแทน OTP
TRANSACTION สำหรับข้อความธุรกรรมในกรณีการใช้งานตัวแทนแบบธุรกรรมหรือแบบหลายครั้ง
PROMOTION สำหรับข้อความโปรโมชันในกรณีการใช้งานเอเจนต์แบบโปรโมชันหรือแบบหลายการใช้งาน
SERVICEREQUEST สำหรับข้อความเกี่ยวกับบริการที่ผู้ใช้ยินยอมรับ ใช้ในกรณีการใช้งาน OTP, ธุรกรรม, โปรโมชัน หรือตัวแทนแบบหลายการใช้งาน
ACKNOWLEDGEMENT สำหรับข้อความที่รับทราบคำขอยกเลิกการสมัครรับอีเมลของผู้ใช้ ใช้ในกรณีการใช้งาน OTP, ธุรกรรม, โปรโมชัน หรือตัวแทนแบบหลายการใช้งาน

RichMessageClassification

สำหรับการเรียกเก็บเงินในสหรัฐอเมริกาเท่านั้น: รายละเอียดเกี่ยวกับการจัดประเภทข้อความที่ใช้สำหรับการเรียกเก็บเงิน

การแสดง JSON
{
  "classificationType": enum (RichMessageClassificationType),
  "segmentCount": integer
}
ช่อง
classificationType

enum (RichMessageClassificationType)

segmentCount

integer

จำนวนกลุ่ม 160 ไบต์สำหรับข้อความของข้อความ โดยปัดขึ้นเสมอ

คำนวณจากความยาวของไบต์ UTF-8 ทั้งหมดของเนื้อหาข้อความเท่านั้น โดยไม่รวมข้อมูลจากคำตอบหรือการดำเนินการที่แนะนำ

เช่น ข้อความ SMS ที่มีความยาว 300 ไบต์จะมี segmentCount เป็น 2

ฟิลด์นี้จะระบุค่าสำหรับประเภท RICH_MESSAGE เท่านั้น

RichMessageClassificationType

สำหรับการเรียกเก็บเงินในสหรัฐอเมริกาเท่านั้น: ระบุการจัดประเภทข้อความสำหรับการเรียกเก็บเงิน

สำคัญ: ผู้ให้บริการในสหรัฐอเมริกาเป็นผู้กำหนดราคาสำหรับข้อความประเภทที่เรียกเก็บเงินได้ตามที่อธิบายไว้ในหน้านี้ นอกจากนี้ ผู้ให้บริการในสหรัฐอเมริกายังเป็นผู้กำหนดค่าบริการขั้นสุดท้ายที่นักพัฒนาแอปต้องชำระสำหรับการส่งข้อความ RCS สำหรับธุรกิจด้วย หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดราคาหรือการเรียกเก็บเงิน โปรดติดต่อตัวแทนของผู้ให้บริการที่เกี่ยวข้อง

Enum
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED ไม่ได้ระบุ
RICH_MESSAGE ข้อความจะได้รับการจัดประเภทเป็น RICH ในกรณีต่อไปนี้ 1. ไม่มี Rich Card 2. โดยไม่มีไฟล์แนบ 3. การดำเนินการที่แนะนำใดๆ ที่มีอยู่ต้องเป็นการดำเนินการโทรหรือการดำเนินการเปิด URL ที่ไม่ได้ใช้ WebView
RICH_MEDIA_MESSAGE ข้อความที่ไม่เป็นไปตามเกณฑ์ RICH_MESSAGE ซึ่งรวมถึงข้อความที่มีริชการ์ด ไฟล์สื่อ หรือการดำเนินการที่แนะนำอื่นๆ นอกเหนือจากโทรหรือเปิด URL ในเบราว์เซอร์
SUGGESTED_ACTION_CLICK แสดงการแตะของผู้ใช้ในการดำเนินการที่แนะนำ (ไม่ใช่การตอบกลับที่แนะนำ) การจัดประเภทนี้ใช้กับการดำเนินการของผู้ใช้เท่านั้น และจะปรากฏเฉพาะในเพย์โหลด UserMessage ของเว็บฮุก โดยจะไม่มีผลกับข้อความ A2P

เมธอด

create

ส่งข้อความจากตัวแทนไปยังผู้ใช้

delete

เพิกถอนข้อความของตัวแทนที่ส่งแล้วแต่ยังไม่ได้นำส่ง