Method: users.batchGet

Obtiene los números de teléfono habilitados para RCS para una lista de usuarios.

La carga útil que se muestra contiene una lista de números de teléfono habilitados para RCS a los que puede acceder la plataforma de RBM para los usuarios especificados. Solo se mostrarán los números de teléfono que estén habilitados para RCS para un operador con el que se haya lanzado el agente.

La carga útil que se muestra también contiene valores que se pueden usar para estimar el alcance potencial de una lista de números de teléfono, sin importar el estado de lanzamiento del agente.

Se permite 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 comunicarse RBM. Solo incluye a los usuarios de los operadores en los que se lanza el agente.
totalRandomSampleUserCount

integer

Recuento de números de teléfono seleccionados al azar de reachableUsers. Por lo general, este valor representa alrededor del 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 con RCS para todos los operadores, independientemente del estado de lanzamiento del agente. La proporción entre este valor y totalRandomSampleUserCount puede aproximarse al alcance potencial para 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 la Descripción general de OAuth 2.0.