Method: users.batchGet

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

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

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

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