Gets the RCS-enabled phone numbers for a list of users.
The returned payload contains a list of RCS-enabled phone numbers reachable by the RBM platform for the specified users. Only phone numbers that are RCS-enabled for a carrier the agent is launched on will be returned.
The returned payload also contains values that can be used to estimate the potential reach of a list of phone numbers regardless of the launch status of the agent.
Maximum 600 queries per minute (QPM).
HTTP request
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "users": [ string ], "agentId": string } |
Fields | |
---|---|
users[] |
List of users' phone numbers in E.164 format. |
agentId |
Required. The agent's unique identifier. |
Response body
Response with RBM-reachability user data.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "reachableUsers": [ string ], "totalRandomSampleUserCount": integer, "reachableRandomSampleUserCount": integer } |
Fields | |
---|---|
reachableUsers[] |
List of users' phone numbers that RBM can reach. Only includes users on carriers that the agent is launched on. |
totalRandomSampleUserCount |
Count of phone numbers randomly selected from |
reachableRandomSampleUserCount |
Count of phone numbers from the randomly selected list that are RCS-reachable across all carriers, regardless of the agent's launch status. The ratio between this value and |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/rcsbusinessmessaging
For more information, see the OAuth 2.0 Overview.