new_releases Actualizaciones: Consulte las
notas de la versión para conocer las funciones nuevas y las actualizaciones de productos.
Method: users.batchGet
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Obtiene los números de teléfono habilitados para RCS para una lista de usuarios.
La carga útil devuelta contiene una lista de números de teléfono habilitados para RCS a los que puede acceder la plataforma RBM para los usuarios especificados. Solo se devolverán los números de teléfono habilitados para RCS del operador para el que se lanzó el agente.
La carga útil que se muestra también contiene valores que se pueden usar para estimar el posible alcance de una lista de números de teléfono, independientemente del estado de lanzamiento del agente.
Un máximo de 600 consultas por minuto (QPM)
Solicitud HTTP
POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
| Representación JSON |
{
"users": [
string
],
"agentId": string
} |
| Campos |
users[] |
string
Lista de números de teléfono de los usuarios en formato E.164.
|
agentId |
string
Obligatorio. El identificador único del agente.
|
Cuerpo de la respuesta
Respuesta con datos del usuario de accesibilidad de RBM.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
| Representación JSON |
{
"reachableUsers": [
string
],
"totalRandomSampleUserCount": integer,
"reachableRandomSampleUserCount": integer
} |
| Campos |
reachableUsers[] |
string
Lista de números de teléfono de los usuarios a los que puede llegar RBM. Solo incluye a los usuarios de los operadores en los que se lanzó el agente.
|
totalRandomSampleUserCount |
integer
Recuento de números de teléfono seleccionados de forma aleatoria de reachableUsers. Por lo general, este valor es aproximadamente el 75% del total de números de teléfono solicitados. Este valor es 0 si la cantidad de números de teléfono solicitados es inferior a 500.
|
reachableRandomSampleUserCount |
integer
Recuento de números de teléfono de la lista seleccionada al azar a los que se puede acceder mediante RCS con todos los operadores, independientemente del estado de lanzamiento del agente. La proporción entre este valor y totalRandomSampleUserCount puede aproximar el alcance potencial de una lista de usuarios.
|
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/rcsbusinessmessaging
Para obtener más información, consulta OAuth 2.0 Overview.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eThis endpoint retrieves a list of RCS-enabled phone numbers for specified users that are reachable by the RBM platform, limited to carriers where the agent is launched.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003ereachableUsers\u003c/code\u003e, indicating which phone numbers are RCS-enabled and accessible via the launched agent's carriers.\u003c/p\u003e\n"],["\u003cp\u003eIt provides \u003ccode\u003etotalRandomSampleUserCount\u003c/code\u003e and \u003ccode\u003ereachableRandomSampleUserCount\u003c/code\u003e to estimate the potential reach of a user list, irrespective of the agent's launch status.\u003c/p\u003e\n"],["\u003cp\u003eThe API endpoint is \u003ccode\u003ePOST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet\u003c/code\u003e, with a maximum request rate of 600 queries per minute.\u003c/p\u003e\n"],["\u003cp\u003eTo make the call to this endpoint, the request body requires a list of user's phone number in E.164 format, and the agents unique identifier.\u003c/p\u003e\n"]]],[],null,["# Method: users.batchGet\n\nGets the RCS-enabled phone numbers for a list of users.\n\nThe 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.\n\nThe 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.\n\nMaximum 600 queries per minute (QPM).\n\n### HTTP request\n\n`POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------|\n| ``` { \"users\": [ string ], \"agentId\": string } ``` |\n\n| Fields ||\n|-----------|--------------------------------------------------------|\n| `users[]` | `string` List of users' phone numbers in E.164 format. |\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Response body\n\nResponse with RBM-reachability user data.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"reachableUsers\": [ string ], \"totalRandomSampleUserCount\": integer, \"reachableRandomSampleUserCount\": integer } ``` |\n\n| Fields ||\n|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reachableUsers[]` | `string` List of users' phone numbers that RBM can reach. Only includes users on carriers that the agent is launched on. |\n| `totalRandomSampleUserCount` | `integer` Count of phone numbers randomly selected from [reachableUsers](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet#body.BatchGetUsersResponse.FIELDS.reachable_users). Typically, this value is \\~75% of the total requested phone numbers. This value is `0` if the count of requested phone numbers is less than 500. |\n| `reachableRandomSampleUserCount` | `integer` 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 [totalRandomSampleUserCount](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet#body.BatchGetUsersResponse.FIELDS.total_random_sample_user_count) can approximate the potential reach for a list of users. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
