Method: users.batchGet

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

傳回的酬載包含已啟用 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 Overview。