REST Resource: brands.agents

資源：Agent

代表品牌的對話實體。

JSON 表示法

JSON 表示法
{ "name": string, "displayName": string, "brandName": string, // Union field `detail_info` can be only one of the following: "rcsBusinessMessagingAgent": { object (`RcsBusinessMessagingAgent`) } // End of list of possible types for union field `detail_info`. }

{
  "name": string,
  "displayName": string,
  "brandName": string,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}

欄位
`name`	`string` 代理程式的專屬 ID。這個唯讀設定檔由平台定義。
`displayName`	`string` 必填。服務專員向使用者顯示的名稱。長度上限為 40 個半形字元。代理商驗證後即無法修改。
`brandName`	`string` 僅供輸出。與代理程式相關聯的品牌名稱。
聯集欄位 `detail_info`。包含特定產品所需的欄位。必填。`detail_info` 只能是下列其中一項：
`rcsBusinessMessagingAgent`	`object (RcsBusinessMessagingAgent)` 企業專用 RCS 的服務專員詳細資訊。

RcsBusinessMessagingAgent

與企業專用 RCS 相關的代理程式資訊。建立代理人時，建議至少提供一種聯絡方式 (電話、電子郵件或網站)，並附上相應的標籤。如要啟動代理，請至少提供一種聯絡方式 (電話、電子郵件或網站)，並附上相應標籤。

JSON 表示法

JSON 表示法
{ "description": string, "logoUri": string, "heroUri": string, "phoneNumbers": [ { object (`PhoneEntry`) } ], "emails": [ { object (`EmailEntry`) } ], "websites": [ { object (`WebEntry`) } ], "privacy": { object (`WebEntry`) }, "termsConditions": { object (`WebEntry`) }, "color": string, "billingConfig": { object (`RcsBusinessMessagingAgentBillingConfig`) }, "agentUseCase": enum (`AgentUseCase`), "hostingRegion": enum (`HostingRegion`), "partner": { object (`PartnerEntry`) }, "launchDetails": { string: { object (`RcsBusinessMessagingRegionLaunch`) }, ... }, "indiaPrincipalEntityId": string }

{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}

欄位
`description`	`string` 必填。向使用者顯示的代理程式說明。長度上限為 100 個半形字元。如需詳細規定，請參閱「編輯代理人資訊」。
`logoUri`	`string` 必填。代理程式標誌的公開網址。大小上限為 50 KB。代理商驗證後即無法修改。
`heroUri`	`string` 必填。服務專員主要圖片的公開網址。上限為 200 KB。代理商驗證後即無法修改。
`phoneNumbers[]`	`object (PhoneEntry)` (選用步驟) 與服務專員相關聯的電話號碼。如未提供電子郵件和網站，則為必填欄位。
`emails[]`	`object (EmailEntry)` (選用步驟) 與服務專員相關聯的電子郵件地址。如果未提供電話號碼和網站，則必須提供。
`websites[]`	`object (WebEntry)` (選用步驟) 與代理程式相關聯的網站。最多 3 個。如果未提供電話號碼和電子郵件地址，則為必填欄位。
`privacy`	`object (WebEntry)` 必填。與代理程式相關聯的隱私權政策。
`termsConditions`	`object (WebEntry)` 必填。與代理商相關聯的條款及細則。
`color`	`string` 必填。以十六進位格式顯示給使用者的代理程式主題顏色。例如 #FF6347。
`billingConfig`	`object (RcsBusinessMessagingAgentBillingConfig)` 必填。代理程式的帳單設定。
`agentUseCase`	`enum (AgentUseCase)` (選用步驟) 機器人的用途。
`hostingRegion`	`enum (HostingRegion)` 必填。服務專員的代管地區。
`partner`	`object (PartnerEntry)` 僅供輸出。與代理商相關聯的合作夥伴。
`launchDetails`	`map (key: string, value: object (RcsBusinessMessagingRegionLaunch))` 僅供輸出。代理程式的發布詳細資料。只有電信業者會填入這項資料，且僅限於撥打電話的電信業者相關發布詳細資料。
`indiaPrincipalEntityId`	`string` (選用步驟) 與服務專員相關聯的印度商家主要實體識別碼 (PE ID)。如要在印度推出代理程式，則為必要條件。

PhoneEntry

與服務專員相關聯的電話號碼。

JSON 表示法
{ "phoneNumber": { object (`Phone`) }, "label": string }

欄位

欄位
`phoneNumber`	`object (Phone)` 必填。電話號碼可採用兩種格式：完整的 E.164 格式 (例如「+12223334444」)，或不含「+」前置字元或國家/地區代碼的當地/免付費電話號碼 (例如「6502530000」)。注意：不得使用緊急電話號碼。
`label`	`string` 必填。電話號碼的標籤。

phoneNumber

object (Phone)

必填。電話號碼可採用兩種格式：完整的 E.164 格式 (例如「+12223334444」)，或不含「+」前置字元或國家/地區代碼的當地/免付費電話號碼 (例如「6502530000」)。注意：不得使用緊急電話號碼。

label

string

必填。電話號碼的標籤。

EmailEntry

與服務專員相關聯的電子郵件地址。

JSON 表示法
{ "address": string, "label": string }

欄位

欄位
`address`	`string` 必填。電子郵件地址。
`label`	`string` 必填。電子郵件地址的標籤。

address

string

必填。電子郵件地址。

label

string

必填。電子郵件地址的標籤。

WebEntry

與代理程式相關的網路資源。

JSON 表示法
{ "uri": string, "label": string }

欄位

欄位
`uri`	`string` 必填。與代理程式相關聯的公開存取 URI。必須使用 HTTP 或 HTTPS 通訊協定。
`label`	`string` `websites` 必須填寫，其他情況則為選填。URI 的標籤。

uri

string

必填。與代理程式相關聯的公開存取 URI。必須使用 HTTP 或 HTTPS 通訊協定。

label

string

websites 必須填寫，其他情況則為選填。URI 的標籤。

RcsBusinessMessagingAgentBillingConfig

代理程式的帳單設定。

JSON 表示法
{ "billingCategory": enum (`BillingCategory`) }

欄位

欄位
`billingCategory`	`enum (BillingCategory)` 代理程式的帳單類別。

billingCategory

enum (BillingCategory)

代理程式的帳單類別。

BillingCategory

支援的帳單類別。

列舉
`BILLING_CATEGORY_UNSPECIFIED`	未指定類別。
`CONVERSATIONAL_LEGACY`	舊版類別，支援現有代理商的帳單設定。請改用 `CONVERSATIONAL`。這個項目已淘汰！
`CONVERSATIONAL`	適用於較長且複雜的工作階段，使用者和品牌會交換一系列訊息。
`SINGLE_MESSAGE`	取代 SMS 簡訊，提供更豐富的傳訊體驗。系統絕不會以「對話」計費。這個項目已淘汰！
`BASIC_MESSAGE`	計費模式與簡訊類似。系統絕不會以「對話」計費。這個項目已淘汰！
`NON_CONVERSATIONAL`	代表非對話帳單類別，取代舊版 SINGLE_MESSAGE 和 BASIC_MESSAGE 類別。這項功能適用於主要進行單向 (A2P) 通訊的服務專員。

AgentUseCase

儲存空間中使用的代理用途類型。

列舉
`AGENT_USE_CASE_UNSPECIFIED`	未指定用途。
`TRANSACTIONAL`	只傳送必要、緊急且具時效性訊息的服務專員。
`PROMOTIONAL`	傳送銷售、行銷和宣傳訊息的代理商。預設類型。
`OTP`	只傳送一次性密碼的代理程式。
`MULTI_USE`	代理程式有多種用途。這包括立即推出一個用途的代理程式，以及預計在未來版本中推出第二個用途的代理程式。詳情請參閱多用途說明文件。

HostingRegion

代理程式的可能代管區域，用於將 P2A 訊息正確轉送至區域化伺服器。

列舉
`HOSTING_REGION_UNSPECIFIED`	未指定代管地區。
`NORTH_AMERICA`	北美洲。
`EUROPE`	歐洲。
`ASIA_PACIFIC`	亞太地區。

PartnerEntry

與代理商相關聯的合作夥伴。

JSON 表示法
{ "partnerId": string, "displayName": string, "company": string }

欄位

欄位
`partnerId`	`string` 僅供輸出。合作夥伴的專屬 ID。
`displayName`	`string` 僅供輸出。向商家顯示的名稱，用於將合作夥伴與產品建立關聯。合作夥伴不得重複使用。
`company`	`string` 僅供輸出。指定合作夥伴的公司公開名稱。例如 Twilio 或 Cisco。

partnerId

string

僅供輸出。合作夥伴的專屬 ID。

displayName

string

僅供輸出。向商家顯示的名稱，用於將合作夥伴與產品建立關聯。合作夥伴不得重複使用。

company

string

僅供輸出。指定合作夥伴的公司公開名稱。例如 Twilio 或 Cisco。

RcsBusinessMessagingRegionLaunch

各區域的企業專用 RCS 代理發布詳細資料。

JSON 表示法
{ "launchState": enum (`LaunchState`), "comment": string, "updateTime": string }

欄位

欄位
`launchState`	`enum (LaunchState)` 區域的推出狀態。
`comment`	`string` 貨運公司的留言。
`updateTime`	`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"`。

launchState

enum (LaunchState)

區域的推出狀態。

comment

string

貨運公司的留言。

updateTime

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"。

LaunchState

實體的推出狀態。

列舉
`LAUNCH_STATE_UNSPECIFIED`	未指定狀態。
`LAUNCH_STATE_UNLAUNCHED`	實體尚未發布。
`LAUNCH_STATE_PENDING`	上市前審查。
`LAUNCH_STATE_LAUNCHED`	已推出。
`LAUNCH_STATE_REJECTED`	發布遭拒。
`LAUNCH_STATE_SUSPENDED`	發布作業已暫停。
`LAUNCH_STATE_PENDING_UNLAUNCH`	已淘汰：系統已不再使用這個狀態。取消發布要求審查中。這個項目已淘汰！
`LAUNCH_STATE_INVALID_IN_GMB`	已淘汰：系統已不再使用這個狀態。由於相關聯的 Google 我的商家資訊不支援訊息功能，因此無法啟動。在 Google 我的商家中重新驗證後，這裡會自動重新啟動。僅適用於地點。這個項目已淘汰！

方法
`create`	建立代表品牌的新代理。
`delete (deprecated)`	已淘汰：代理程式刪除功能已淘汰。
`get`	取得代理程式的相關資訊。
`getLaunch`	取得代理程式的上線資訊。
`getVerification`	取得代理程式的驗證資訊。
`list`	列出與品牌相關聯的所有代理程式。
`patch`	更新代理程式的相關資訊。
`requestLaunch`	開始啟動代理程式。
`requestVerification`	為代理程式提交商家驗證資訊。
`updateLaunch`	更新代理程式的上線資訊。
`updateVerification`	更新代理的驗證狀態。

REST Resource: brands.agents

資源：Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

方法

`create`

`delete (deprecated)`

`get`

`getLaunch`

`getVerification`

`list`

`patch`

`requestLaunch`

`requestVerification`

`updateLaunch`

`updateVerification`

REST Resource: brands.agents 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

資源：Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

方法

delete (deprecated)

REST Resource: brands.agents

`delete (deprecated)`