Method: users.batchGet

取得使用者清單中已啟用 RCS 的電話號碼。

傳回的酬載會列出指定使用者可透過 RCS for Business 平台聯絡的 RCS 啟用電話號碼。系統只會傳回已啟用 RCS 的電話號碼，且這些號碼必須屬於啟動代理程式的電信業者。

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

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

重要事項：users.batchGet 方法需要使用區域端點。要求必須包含來自單一地理區域的電話號碼。如果單一要求中包含多個地區的電話號碼，或是傳送至錯誤的地區端點，就會導致 400 Bad Request 錯誤。

區域端點：

HTTP 要求

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

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

要求主體

要求主體會包含結構如下的資料：

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

string

使用者電話號碼清單 (E.164 格式)。

單一要求中的所有電話號碼都必須屬於同一個地理區域。如果要求包含多個區域的電話號碼，或傳送至錯誤的區域端點，就會失敗並顯示 400 Bad Request 錯誤。
agentId

string

必填。代理程式的專屬 ID。

回應主體

回覆，其中包含 RCS for Business 的使用者可及性資料。

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

JSON 表示法 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
欄位
reachableUsers[]

string

企業專用 RCS 可觸及的使用者電話號碼清單。只會納入服務專員啟用的電信業者使用者。
totalRandomSampleUserCount

integer

從「reachableUsers」隨機選取的電話號碼數量。這個值通常是所要求電話號碼總數的 75% 左右。如果要求的電話號碼數量少於 500 個，這個值為 0。
reachableRandomSampleUserCount

integer

無論代理商的發布狀態為何，隨機選取清單中所有電信業者可透過 RCS 聯絡的電話號碼數量。這個值與 totalRandomSampleUserCount 的比率，可估算使用者名單的潛在觸及人數。
reachableUsersMap

map (key: string, value: object (ReachableUsers))

僅供輸出。電信業者 ID 對應至該電信業者可連線使用者清單的對應。這個欄位只會填入美國電話號碼。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱OAuth 2.0 Overview。

ReachableUsers

特定電信業者可連線的使用者名單。

JSON 表示法 
{
  "reachableUsers": [
    string
  ]
}
欄位
reachableUsers[]

string

特定電信業者可連線的使用者名單。這個欄位只會填入美國電話號碼。