REST Resource: phones.agentMessages

資源：AgentMessage

代理程式傳送給使用者的訊息。

JSON 表示法 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // 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

這個欄位是由 RBM 平台設定。請勿在建立服務專員訊息時附上這段文字。這個欄位會解析「phones/{E.164}/agentMessages/{messageId}」，其中 {E.164} 是 E.164 格式的使用者電話號碼，{messageId} 則是服務專員訊息指派的 ID。
sendTime

string (Timestamp format)

這個欄位是由 RBM 平台設定。請勿在建立服務專員訊息時附上這段文字。這個欄位會解析將訊息傳送給使用者的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
contentMessage

object (AgentContentMessage)

代理程式訊息的內容。

聯集欄位 expiration。

expiration 只能採用下列其中一種設定：
expireTime

string (Timestamp format)

選用設定。這項資源到期時的時間戳記 (以世界標準時間為準)。如果已設定「TTL」欄位或是已設定「TTL」，值會在輸出時提供。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
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 項建議。

只有在相關聯的服務專員訊息是對話中的最新訊息 (包括服務專員和使用者訊息) 時，系統才會顯示方塊。使用者可以輕觸建議的回覆，將文字回覆傳回代理程式，也可以輕觸建議的動作，在裝置上啟動原生動作。
聯集欄位 content。服務專員訊息 content 只能採用下列其中一種做法：
text

string

採用 UTF-8 編碼的文字。
fileName
(deprecated)

string

檔案的專屬名稱。RBM 平台會在代理程式上傳檔案時傳回檔案名稱。已淘汰，並改用 uploadRbmFile
uploadedRbmFile

object (UploadedRbmFile)

包含由 RBM 伺服器上傳及放送的檔案和縮圖 ID
richCard

object (RichCard)

獨立的複合式資訊卡。
contentInfo

object (ContentInfo)

檔案相關資訊，包括檔案網址與縮圖網址。

RBM 平台提供快取的內容，但是代理程式可以強制 RBM 平台擷取新版本內容並重新整理快取。

UploadedRbmFile

含有檔案和縮圖資訊的訊息

JSON 表示法 
{
  "fileName": string,
  "thumbnailName": string
}
欄位
fileName

string

檔案名稱，在檔案上傳時由 RBM 平台傳回。
thumbnailName

string

縮圖名稱，上傳時由 RBM 平台傳回。

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.
}
欄位
聯集欄位 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

輪轉介面中的資訊卡寬度。

列舉
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、影片)。
suggestions[]

object (Suggestion)

(選用) 要加入資訊卡的建議清單。最多只能有 4 項建議。

媒體

互動式多媒體中的媒體檔案。

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)

以垂直版面配置的互動式多媒體當中媒體的高度。針對水平版面配置的獨立資訊卡，高度無法自訂，系統會忽略這個欄位。
聯集欄位 content。媒體內容「content」只能採用下列其中一種格式：
fileName
(deprecated)

string

檔案的專屬名稱，在檔案上傳時由 RBM 平台傳回。已淘汰，並改用 uploadRbmFile
uploadedRbmFile

object (UploadedRbmFile)

包含由 RBM 伺服器上傳及放送的檔案和縮圖 ID
contentInfo

object (ContentInfo)

檔案相關資訊，包括檔案網址與縮圖網址。

RBM 平台提供快取的內容，但是代理程式可以強制 RBM 平台擷取新版本內容並重新整理快取。

ContentInfo

包含內容資訊的訊息。

JSON 表示法 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
欄位
fileUrl

string

檔案可公開存取的網址。在平台擷取檔案時，RBM 平台會從 HTTP 標頭 content-type 欄位判斷檔案的 MIME 類型。從網址發出的 HTTP 回應中，content-type 欄位必須存在且正確。建議檔案大小上限為 100 MB。
thumbnailUrl

string

(選用，僅適用於圖片和影片檔案) 可公開存取的縮圖網址。大小上限為 100 KB。

如未提供縮圖網址，RBM 平台會在使用者下載檔案前，顯示空白的預留位置縮圖。視使用者的設定而定，檔案可能不會自動下載，且可能需要使用者輕觸下載按鈕。
forceRefresh

boolean

如果設定這項政策，RBM 平台就會從指定網址擷取檔案和縮圖，即使平台已快取檔案 (和/或縮圖) 的副本也一樣。

Media.Height

媒體高度

列舉
HEIGHT_UNSPECIFIED 未指定。
SHORT 112 DP。
MEDIUM 168 DP。
TALL 264 DP。如果將資訊卡寬度設為「小」，則不適用於複合式資訊卡輪轉介面。

建議

複合式資訊卡或建議方塊清單中的建議回覆或建議動作。

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.
}
欄位
聯集欄位 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 編碼) 傳送給代理程式
fallbackUrl

string

(選用) 如果客戶不支援建議動作時要使用的備用網址。備用網址會在新的瀏覽器視窗中開啟。
聯集欄位 action。使用者輕觸建議動作 action 時，在裝置上啟動的原生動作只能是下列其中一項：
dialAction

object (DialAction)

開啟使用者的預設撥號應用程式，並已填入服務專員指定的電話號碼。
viewLocationAction

object (ViewLocationAction)

開啟使用者的預設地圖應用程式，並選取服務專員指定的位置，或是透過代理程式指定的查詢，搜尋使用者所在位置周圍的環境。
createCalendarEventAction

object (CreateCalendarEventAction)

開啟使用者的預設日曆應用程式，然後啟動新的日曆活動流程，並預先填入服務專員指定的事件資料。
openUrlAction

object (OpenUrlAction)

針對指定網址開啟使用者的預設網路瀏覽器應用程式。如果使用者已安裝的應用程式已註冊為網址的預設處理常式，系統會改為開啟這個應用程式，並在建議的動作使用者介面中使用該應用程式的圖示。
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

(選用) 圖釘標籤的位置在經緯度時。
query

string

(選用，僅適用於 Android 訊息用戶端) 代理程式可以改為指定查詢字串，而不是指定 latLong (可選用標籤)。如果預設地圖應用程式支援搜尋功能 (包括 Google 地圖)，輕觸這個建議動作後，系統就會以使用者目前的位置為中心搜尋位置。如果查詢內容充足，服務專員就可以透過查詢選取世界上的任何地點。

舉例來說，如果將查詢字串設為「Growing Tree Bank」，系統便會顯示如果將查詢字串設為「1600 Amphitheater Parkway, Mountain View, CA 94043, USA，系統就會選取該特定地址，無論使用者的所在位置為何。

LatLng

代表經緯度組合的物件。以一對雙精準數表示經度度數和緯度度數。除非另有指定，否則這個物件必須符合 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)

活動開始時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

活動結束時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
title

string

活動標題。
description

string

活動說明。

OpenUrlAction

開啟使用者的預設網路瀏覽器應用程式至指定網址。如果使用者已安裝的應用程式已註冊為網址的預設處理常式，系統會改為開啟這個應用程式，並在建議的動作使用者介面中使用該應用程式的圖示。

JSON 表示法 
{
  "url": string
}
欄位
url

string

網址

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

卡片方向。

列舉
CARD_ORIENTATION_UNSPECIFIED 未指定。
HORIZONTAL

橫向版面配置。

如果水平複合式搜尋結果的 object(CardContent) 包含 media 欄位，則其中也至少須包含 title、description 或 suggestions[] 欄位。
VERTICAL 垂直版面配置。

StandaloneCard.ThumbnailImageAlignment

顯示水平版面配置的獨立資訊卡圖片預覽對齊方式。

列舉
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED 未指定。
LEFT 檔案預覽畫面靠左對齊。
RIGHT 檔案預覽畫面靠右對齊。

方法

create

 從服務專員傳送訊息給使用者。

delete

 撤銷已傳送但尚未傳送的服務專員訊息。