Method: users.batchGet

获取用户列表中启用了 RCS 的电话号码。

返回的载荷包含 RBM 平台可通过指定用户联系的已启用 RCS 的电话号码列表。系统只会返回已启用 RCS 的电话号码，且该号码必须属于代理启用时所用的运营商。

返回的载荷还包含一些值，这些值可用于估算电话号码列表的潜在覆盖面，无论代理的启动状态如何。

每分钟查询次数 (QPM) 上限为 600 次。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

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 概览。