Method: users.batchGet

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

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

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

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

重要: users.batchGet メソッドでは、リージョン エンドポイントを使用する必要があります。リクエストには、単一の地域からの電話番号を含める必要があります。単一のリクエストで複数のリージョンの電話番号を送信した場合や、誤ったリージョン エンドポイントに送信した場合は、400 Bad Request エラーが発生します。

リージョン エンドポイント:

HTTP リクエスト

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

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

リクエストの本文

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

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

string

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

1 回のリクエストに含まれる電話番号は、すべて同じ地域に属している必要があります。複数のリージョンの電話番号を含むリクエストや、間違ったリージョン エンドポイントに送信されたリクエストは、400 Bad Request エラーで失敗します。
agentId

string

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

レスポンスの本文

RCS for Business のユーザーの到達可能性データを含むレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
フィールド
reachableUsers[]

string

RCS for Business でリーチできるユーザーの電話番号のリスト。エージェントが起動される携帯通信会社のユーザーのみが含まれます。
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

特定の携帯通信会社で連絡可能なユーザーのリスト。このフィールドは、米国の電話番号に対してのみ入力されます。