資源:AgentMessage
服務專員向使用者傳送的訊息。
JSON 表示法 |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
欄位 | |
---|---|
name |
這個欄位是由 RBM 平台設定。建立服務專員訊息時,請勿包含此字串。欄位會解析「phones/{E.164}/agentMessages/{messageId}」,其中 {E.164} 是使用者的電話號碼 (格式為 E.164),{messageId} 則是服務專員指派的服務專員訊息 ID。 |
sendTime |
這個欄位是由 RBM 平台設定。建立服務專員訊息時,請勿包含此字串。欄位會解析訊息傳送給使用者的時間。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例: |
contentMessage |
服務專員訊息的內容。 |
聯集欄位
|
|
expireTime |
選用設定。資源到期時間的時間戳記 (世界標準時間)。如果已設定 TTL 欄位,則會在輸出時提供這個值。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例: |
ttl |
選用設定。僅限輸入。訊息會在自動撤銷前保留多久。 持續時間以秒為單位,最多 9 個小數位數,結尾為「 |
AgentContentMessage
服務專員向使用者傳送的訊息內容。
JSON 表示法 |
---|
{ "suggestions": [ { object ( |
欄位 | |
---|---|
suggestions[] |
建議回覆和建議動作清單,在相關聯的代理程式訊息後方,會以建議方塊清單的形式顯示。最多 11 項建議。 只有在相關聯的服務專員訊息是對話中的最新訊息 (包括服務專員和使用者訊息) 時,系統才會顯示方塊。使用者可以輕觸建議回覆,將簡訊回覆傳回給服務專員,或是輕觸建議動作,在裝置上執行原生動作。 |
聯集欄位 content 。服務專員訊息 content 只能採用下列其中一種設定: |
|
text |
以 UTF-8 編碼的文字。 |
fileName |
檔案的專屬名稱。代理程式上傳檔案時,RBM 平台會傳回檔案名稱。已淘汰,改用下方的 uploadRbmFile |
uploadedRbmFile |
內含由 RBM 伺服器上傳及提供的檔案和縮圖 ID |
richCard |
獨立的複合式資訊卡。 |
contentInfo |
檔案相關資訊,包括檔案網址和縮圖網址。 RBM 平台會從快取提供內容,但代理程式可以強制 RBM 平台擷取新版本的內容並重新整理快取。 |
UploadedRbmFile
包含檔案和縮圖資訊的訊息
JSON 表示法 |
---|
{ "fileName": string, "thumbnailName": string } |
欄位 | |
---|---|
fileName |
檔案名稱,由 RBM 平台在上傳檔案時傳回。 |
thumbnailName |
縮圖上傳時,RBM 平台會傳回縮圖名稱。 |
RichCard
由服務專員傳送給使用者的獨立複合式資訊卡或複合式資訊卡輪轉介面。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 card 。獨立資訊卡或資訊卡輪轉介面。card 只能是下列其中一項: |
|
carouselCard |
資訊卡輪轉介面。 |
standaloneCard |
獨立卡片。 |
CarouselCard
資訊卡輪轉介面。
JSON 表示法 |
---|
{ "cardWidth": enum ( |
欄位 | |
---|---|
cardWidth |
輪轉介面中的資訊卡寬度。 |
cardContents[] |
輪轉介面中每張資訊卡的內容清單。輪轉介面最多可以有 2 張資訊卡,最多 10 張。 |
CarouselCard.CardWidth
輪轉介面中的資訊卡寬度。
列舉 | |
---|---|
CARD_WIDTH_UNSPECIFIED |
不指定。 |
SMALL |
120 DP。請注意,您無法使用高度媒體。 |
MEDIUM |
232 DP。 |
CardContent
資訊卡內容
JSON 表示法 |
---|
{ "title": string, "description": string, "media": { object ( |
欄位 | |
---|---|
title |
(選填) 資訊卡的標題。最多 200 個字元。 |
description |
(選填) 卡片的說明。最多 2,000 個字元。 |
media |
(選用) 要加入資訊卡中的媒體 (圖片、GIF、影片)。 |
suggestions[] |
(選用) 要加入資訊卡的建議清單。最多 4 個建議。 |
媒體
複合式資訊卡中的媒體檔案。
JSON 表示法 |
---|
{ "height": enum ( |
欄位 | |
---|---|
height |
互動式多媒體在直向版面配置中的媒體高度。如果是採用橫向版面配置的獨立資訊卡,則無法自訂高度,系統會忽略這個欄位。 |
聯集欄位 content 。媒體內容 content 只能採用下列其中一種設定: |
|
fileName |
檔案的專屬名稱,由 RBM 平台在上傳檔案時傳回。已淘汰,改用下方的 uploadRbmFile |
uploadedRbmFile |
內含由 RBM 伺服器上傳及提供的檔案和縮圖 ID |
contentInfo |
檔案相關資訊,包括檔案網址和縮圖網址。 RBM 平台會從快取提供內容,但代理程式可以強制 RBM 平台擷取新版本的內容並重新整理快取。 |
ContentInfo
含有內容資訊的訊息。
JSON 表示法 |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
欄位 | |
---|---|
fileUrl |
檔案可公開存取的網址。RBM 平台在平台擷取檔案時,會從 HTTP 標頭的 content-type 欄位判斷檔案的 MIME 類型。Content-type 欄位必須在網址的 HTTP 回應中正確存在且正確無誤。建議的檔案大小上限為 100 MB。 |
thumbnailUrl |
(選用,僅適用於圖片、音訊和影片檔案) 縮圖的公開連結網址。大小上限為 100 KB。 如果您沒有提供縮圖網址,RBM 平台會顯示空白的預留位置縮圖,直到使用者裝置下載該檔案為止。視使用者的設定而定,檔案可能不會自動下載,使用者也可能必須輕觸下載按鈕。 |
forceRefresh |
設定後,即使平台已快取檔案 (和/或縮圖) 的副本,RBM 平台仍會從指定的網址擷取檔案和縮圖。 |
Media.Height
媒體高度
列舉 | |
---|---|
HEIGHT_UNSPECIFIED |
不指定。 |
SHORT |
112 DP。 |
MEDIUM |
168 DP。 |
TALL |
264 DP。如果資訊卡寬度設為小,則不適用於複合式資訊卡輪轉介面。 |
建議
複合式資訊卡或建議方塊清單中的建議回覆或建議動作。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 option 。建議回覆或建議動作option 只能採用下列其中一種做法: |
|
reply |
使用者可以輕觸建議回覆,將簡訊回覆給服務專員。 |
action |
使用者可以輕觸建議動作,在裝置上啟動相應的原生動作。 |
SuggestedReply
使用者輕觸後,將文字回覆傳回給服務專員。
JSON 表示法 |
---|
{ "text": string, "postbackData": string } |
欄位 | |
---|---|
text |
建議回覆中顯示的文字,在使用者輕觸時傳回給服務專員。長度上限為 25 個半形字元。 |
postbackData |
在使用者輕觸建議回覆時,代理程式在使用者事件中收到的 Base64 編碼酬載。 |
SuggestedAction
使用者輕觸後,就會在裝置上啟動相應的原生動作。
JSON 表示法 |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
欄位 | |
---|---|
text |
建議動作中顯示的文字。長度上限為 25 個半形字元。 |
postbackData |
酬載 (採用 Base64 編碼) 會在使用者輕觸建議動作時傳送至代理程式的結果 |
fallbackUrl |
(選用) 如果客戶不支援建議動作時要使用的備用網址。備用網址會在新的瀏覽器視窗中開啟。 |
聯集欄位 action 。使用者輕觸建議動作 action 時,裝置要啟動的原生動作只能採用下列其中一項: |
|
dialAction |
開啟使用者的預設撥號應用程式,並填入服務專員指定的電話號碼。 |
viewLocationAction |
開啟使用者的預設地圖應用程式,然後選取服務專員指定的位置,或在服務專員指定的查詢中,搜尋使用者所在位置的附近地點。 |
createCalendarEventAction |
開啟使用者的預設日曆應用程式,開始新的日曆活動流程,並預先填入代理程式指定的事件資料。 |
openUrlAction |
開啟使用者的預設網路瀏覽器應用程式前往指定網址。如果使用者已安裝的應用程式註冊為網址的預設處理常式,系統會改為開啟這個應用程式,並在建議動作 UI 中使用該應用程式的圖示。 |
shareLocationAction |
開啟 RCS 應用程式的位置選擇器,讓使用者選擇要傳送給服務專員的位置。 |
DialAction
開啟使用者的預設撥號應用程式,並填入服務專員指定的電話號碼。
JSON 表示法 |
---|
{ "phoneNumber": string } |
欄位 | |
---|---|
phoneNumber |
採用 E.164 格式的電話號碼,例如 +12223334444。 |
ViewLocationAction
開啟使用者的預設地圖應用程式,然後選取服務專員指定的位置,或在服務專員指定的查詢中,搜尋使用者所在位置的附近地點。
JSON 表示法 |
---|
{
"latLong": {
object ( |
欄位 | |
---|---|
latLong |
(選用) 指定位置的經緯度。 |
label |
(選用) 在 latLong 放置的圖釘標籤。 |
query |
(選用,只有 Android 訊息用戶端支援) 代理程式可以改為指定查詢字串,不必指定 latLong (也可視需要指定標籤)。在支援搜尋功能的預設地圖應用程式 (包括 Google 地圖) 中,輕觸這項建議動作後,系統會以使用者目前所在位置為中心的位置搜尋。如果查詢內容夠具體,服務專員就能利用該查詢選取全球任何地點。 例如,將查詢字串設為「拓展樹木銀行」會顯示使用者附近所有正在成長的 Tree Bank 地點。將查詢字串設為「1600 Amphitheater Parkway, Mountain View, CA 94043, USA」一律選取該特定地址,無論使用者身在何處。 |
LatLng
代表經緯度組合的物件。以一對雙精準數表示經度度數和緯度度數。除非另有指定,否則這個物件必須符合 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 |
事件開始時間。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例: |
endTime |
活動結束時間。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例: |
title |
活動標題。 |
description |
活動說明。 |
OpenUrlAction
開啟使用者的預設網路瀏覽器應用程式前往指定網址。如果使用者已安裝的應用程式註冊為網址的預設處理常式,系統會改為開啟這個應用程式,並在建議動作 UI 中使用該應用程式的圖示。
JSON 表示法 |
---|
{ "url": string } |
欄位 | |
---|---|
url |
網址 |
StandaloneCard
獨立卡片
JSON 表示法 |
---|
{ "cardOrientation": enum ( |
欄位 | |
---|---|
cardOrientation |
資訊卡的方向。 |
thumbnailImageAlignment |
採用橫向版面配置的獨立資訊卡圖片預覽對齊方式。 |
cardContent |
資訊卡內容。 |
StandaloneCard.CardOrientation
資訊卡的方向。
列舉 | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
不指定。 |
HORIZONTAL |
橫向版面配置。 如果橫向複合式資訊卡的 |
VERTICAL |
直式版面配置。 |
StandaloneCard.ThumbnailImageAlignment
採用橫向版面配置的獨立資訊卡圖片預覽對齊方式。
列舉 | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
不指定。 |
LEFT |
檔案預覽畫面靠左對齊。 |
RIGHT |
檔案預覽畫面靠右對齊。 |
方法 |
|
---|---|
|
傳送服務專員的訊息給使用者。 |
|
撤銷已傳送但尚未傳送的服務專員訊息。 |