Method: users.batchGet

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 devuelta 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 usuarios números de teléfono 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 usuarios números de teléfono 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.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

Para obtener más información, consulta la descripción general de OAuth 2.0.