REST Resource: conversations.messages

แหล่งข้อมูล: ข้อความ

ข้อความในการสนทนาระหว่างตัวแทนและผู้ใช้

การแสดง JSON 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
ช่อง
name

string

ชื่อข้อความที่ Business Messages กำหนดไว้ เปลี่ยนเป็น "conversations/{conversationId}/messages/{messageId}" โดยที่ {conversationId} เป็นรหัสที่ไม่ซ้ำกันสำหรับการสนทนาและ {messageId} เป็นรหัสที่ไม่ซ้ำกันสำหรับข้อความ
messageId

string

ต้องระบุ ตัวระบุที่ไม่ซ้ำกันของข้อความ กำหนดโดยตัวแทน หากข้อความพยายามใช้ messageId เดียวกันกับข้อความก่อนหน้า อาจส่งผลต่อการนำส่งข้อความที่เหมาะสมได้
representative

object (Representative)

รายละเอียดเกี่ยวกับตัวแทน (มนุษย์หรือแชทบ็อต) ที่ส่งข้อความ
suggestions[]

object (Suggestion)

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

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

string

ไม่บังคับ ข้อความสำรองที่จะแสดงขึ้นหากอุปกรณ์ของผู้ใช้ไม่รองรับประเภทข้อความหรือเนื้อหา สูงสุด 3,072 อักขระ
containsRichText

boolean

ไม่บังคับ หากเป็น true แสดงว่าข้อความมี Rich Text หากข้อความมีการจัดรูปแบบที่ไม่ถูกต้อง Business Messages จะแสดงข้อผิดพลาด
ช่องการรวม content เนื้อหาของข้อความ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
text

string

SMS สูงสุด 3,072 อักขระ
image

object (Image)

ข้อความรูปภาพ
richCard

object (RichCard)

ข้อความ Rich Card

รูปภาพ

รูปภาพ

การแสดง JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
ช่อง
ช่องการรวม content เนื้อหารูปภาพ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
contentInfo

object (ContentInfo)

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

ContentInfo

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

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

string

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

สูงสุด 5 MB

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

string

ไม่บังคับ URL ที่เข้าถึงได้แบบสาธารณะของภาพขนาดย่อ

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

ขนาดสูงสุด 25 KB

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

boolean

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

string

ข้อความอธิบายรายละเอียดเกี่ยวกับสื่อเพื่อวัตถุประสงค์ในการเข้าถึง

RichCard

Rich Card แบบสแตนด์อโลนหรือภาพสไลด์ของ Rich Card ที่ส่งจากตัวแทนไปยังผู้ใช้

การแสดง JSON 
{

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

object (StandaloneCard)

บัตรแบบสแตนด์อโลน
carouselCard

object (CarouselCard)

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

StandaloneCard

บัตรแบบสแตนด์อโลน

การแสดง JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
ช่อง
cardContent

object (CardContent)

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

CardContent

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

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

string

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

string

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

object (Media)

ไม่บังคับ สื่อที่จะรวมไว้ในการ์ด
suggestions[]

object (Suggestion)

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

สื่อ

ไฟล์สื่อภายในการ์ดริชมีเดีย

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

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

enum (Height)

ความสูงของสื่อภายในการ์ดริชมีเดีย
ช่องการรวม content เนื้อหาสื่อ content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
contentInfo

object (ContentInfo)

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

ส่วนสูง

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

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

คำแนะนำ

คำแนะนำภายในรายการชิป

การแสดง JSON 
{

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

object (SuggestedReply)

คำแนะนำเพื่อให้ผู้ใช้ตอบกลับด้วยข้อความที่ระบุ
action

object (SuggestedAction)

การดำเนินการที่แนะนำซึ่งเริ่มการดำเนินการแบบดั้งเดิมในอุปกรณ์
liveAgentRequest

object (LiveAgentRequest)

คำขอให้ให้ตัวแทนแบบเรียลไทม์เข้าร่วมการสนทนา
authenticationRequest

object (AuthenticationRequest)

คำขอเพื่อเริ่มขั้นตอนการตรวจสอบสิทธิ์

SuggestedReply

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

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

string

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

string

สตริงที่ตัวแทนได้รับเมื่อผู้ใช้แตะการตอบกลับที่แนะนำ สูงสุด 2,048 อักขระ

SuggestedAction

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

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

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

string

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

string

สตริงที่ Agent ได้รับเมื่อผู้ใช้แตะการดำเนินการที่แนะนำ สูงสุด 2,048 อักขระ
ช่องการรวม action การทำงานแบบเนทีฟจะเริ่มต้นในอุปกรณ์เมื่อผู้ใช้แตะการดำเนินการที่แนะนำ action ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
openUrlAction

object (OpenUrlAction)

เปิด URL ที่ระบุ
dialAction

object (DialAction)

เปิดแอปแป้นโทรศัพท์เริ่มต้นของผู้ใช้

OpenUrlAction

เปิด URL ที่ระบุ

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

string

URL

DialAction

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

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

string

ต้องระบุ หมายเลขโทรศัพท์ที่ระบุในรูปแบบ RFC 3966 เช่น "+1-201-555-0123"

LiveAgentRequest

ประเภทนี้ไม่มีช่อง

เมื่อแตะ ระบบจะขอให้ตัวแทนแบบเรียลไทม์เข้าร่วมการสนทนา

AuthenticationRequest

ขอตรวจสอบสิทธิ์การสนทนา

การแสดง JSON 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
ช่อง
ช่องการรวม authentication_type ประเภทการตรวจสอบสิทธิ์ authentication_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
oauth

object (Oauth)

รายละเอียดสำหรับการตรวจสอบสิทธิ์ผ่าน OAuth

OAuth

รายละเอียดสำหรับการตรวจสอบสิทธิ์ผ่าน OAuth

การแสดง JSON 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
ช่อง
clientId

string

ต้องระบุ รหัสของแอปพลิเคชันที่ขออนุญาต
codeChallenge

string

ต้องระบุ การทดสอบโค้ดที่ใช้เพื่อแลกเปลี่ยนโทเค็นเพื่อการเข้าถึง
scopes[]

string

ต้องระบุ อาร์เรย์ที่ระบุขอบเขตของคำขอ
codeChallengeMethod

string

ไม่บังคับ วิธีการทดสอบโค้ดที่ใช้สร้างระบบทดสอบโค้ด หากไม่ระบุพารามิเตอร์นี้ เซิร์ฟเวอร์จะถือว่า plain

CarouselCard

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

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

enum (CardWidth)

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

object (CardContent)

รายการเนื้อหาสำหรับการ์ดแต่ละรายการในภาพสไลด์ ภาพสไลด์มีการ์ดอย่างน้อย 2 ใบและสูงสุด 10 การ์ด

CardWidth

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

Enum
CARD_WIDTH_UNSPECIFIED ไม่ได้ระบุ
SMALL 136 DP รวมสื่อขนาดใหญ่ไม่ได้
MEDIUM 280 DP

เมธอด

create

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

updateReceipt

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