Method: users.batchGet

ユーザーのリストで RCS 対応の電話番号を取得します。

返されたペイロードには、指定したユーザーの RBM プラットフォームから到達可能な RCS 対応電話番号のリストが含まれます。エージェントが起動されている携帯通信会社で RCS が有効になっている電話番号のみが返されます。

返されるペイロードには、エージェントの起動ステータスに関係なく、電話番号のリストの潜在的なリーチを見積もるために使用できる値も含まれます。

1 分あたり最大 600 クエリ（QPM）。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "users": [
    string
  ],
  "agentId": string
}
フィールド
users[]

string

ユーザーのリストをE.164 形式の電話番号。
agentId

string

必須。エージェントの一意の識別子。

レスポンスの本文

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 の概要をご覧ください。