Method: users.batchGet

获取一系列用户的已启用 RCS 的电话号码。

返回的载荷包含指定用户可通过 RCS 商务平台联系的已启用 RCS 的电话号码列表。系统只会返回已在代理启动的运营商处启用 RCS 的电话号码。

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

每分钟最多 600 次查询 (QPM)。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法 
{
  "users": [
    string
  ],
  "agentId": string
}
字段
users[]

string

采用 E.164 格式的用户电话号码列表。
agentId

string

必需。代理的唯一标识符。

响应正文

包含 RCS 商家私信用户可达性数据的响应。

如果成功，响应正文将包含结构如下的数据：

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

特定运营商的可触达用户列表。此字段仅针对美国电话号码进行填充。