ユーザーのリストの 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[] |
ユーザーの電話番号のリスト(E.164 形式)。 |
agentId |
必須。エージェントの一意の識別子。 |
レスポンスの本文
RBM のネットワーク到達性ユーザーデータを含むレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "reachableUsers": [ string ], "totalRandomSampleUserCount": integer, "reachableRandomSampleUserCount": integer } |
フィールド | |
---|---|
reachableUsers[] |
RBM がアクセスできるユーザーの電話番号のリスト。エージェントが起動されている携帯通信会社のユーザーのみが含まれます。 |
totalRandomSampleUserCount |
|
reachableRandomSampleUserCount |
エージェントの起動ステータスに関係なく、ランダムに選択されたリストの、すべての携帯通信会社で RCS で到達可能な電話番号の数。この値と |
認可スコープ
次の OAuth スコープが必要です。
https://www.googleapis.com/auth/rcsbusinessmessaging
詳細については、OAuth 2.0 の概要をご覧ください。