Method: users.batchGet

取得支援 RCS 的使用者清單電話號碼。

傳回的酬載包含指定使用者的 RBM 平台可存取 RCS 的電話號碼清單。系統只會傳回已啟用服務專員的電信業者已啟用 RCS 的電話號碼。

無論代理程式的發布狀態為何，傳回的酬載也會包含相關值，可用於預估電話號碼清單的潛在觸及率。

每分鐘最多 600 次查詢 (QPM)。

HTTP 要求

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "users": [
    string
  ],
  "agentId": string
}
欄位
users[]

string

使用者電話號碼清單，格式為 E.164。
agentId

string

必要欄位。代理程式的專屬 ID。

回應主體

針對可觸及 RBM 的使用者資料做出回應。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
欄位
reachableUsers[]

string

RBM 可觸及的使用者電話號碼清單。僅包含已啟動代理程式的電信業者使用者。
totalRandomSampleUserCount

integer

從 reachableUsers 中隨機選取的電話號碼數量。一般來說，這個值約佔指定電話號碼總數的 75% 左右。如果要求的電話號碼數量少於 500，這個值為 0。
reachableRandomSampleUserCount

integer

無論服務專員的發布狀態為何，從隨機選取清單取得且支援所有電信業者的 RCS 服務電話號碼數量。這個值與 totalRandomSampleUserCount 之間的比率，可估算使用者名單的潛在觸及率。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/rcsbusinessmessaging

詳情請參閱 OAuth 2.0 總覽。