Method: users.batchGet

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

La carga útil que se devuelve contiene una lista de números de teléfono habilitados para RCS a los que se puede acceder a través de la plataforma de RCS for Business para los usuarios especificados. Solo se devolverán los números de teléfono que tengan habilitados los RCS para un operador en el que se inicie el agente.

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

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 de 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

Es una lista de los números de teléfono de los usuarios en formato E.164.
agentId

string

Obligatorio. Es el identificador único del agente.

Cuerpo de la respuesta

Es la respuesta con datos de accesibilidad del usuario para RCS Business.

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

Es la lista de números de teléfono de los usuarios a los que puede llegar RCS para empresas. Solo incluye a los usuarios de los operadores en los que se lanzó el agente.
totalRandomSampleUserCount

integer

Es el recuento de números de teléfono seleccionados de forma aleatoria en reachableUsers. Por lo general, este valor representa el 75% de la cantidad 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

Es el recuento de números de teléfono de la lista seleccionada de forma aleatoria a los que se puede acceder por RCS en 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 permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.