Method: users.batchGet

Obtiene los números de teléfono habilitados para RCS de 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 comunicarse la plataforma de RCS para empresas para los usuarios especificados. Solo se mostrarán los números de teléfono habilitados para RCS para un operador en el que se inicie 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, independientemente del estado de lanzamiento del agente.

Máximo de 600 consultas por minuto (QPM).

Importante: El método users.batchGet requiere el uso de extremos regionales. Las solicitudes deben contener números de teléfono de una sola región geográfica. Si envías números de teléfono de varias regiones en una sola solicitud o al extremo regional incorrecto, se producirá un error 400 Bad Request.

Extremos regionales:

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

Lista de números de teléfono de los usuarios en formato E.164.

Todos los números de teléfono de una sola solicitud deben pertenecer a la misma región geográfica. Las solicitudes que contengan números de teléfono de varias regiones o que se envíen al extremo regional incorrecto fallarán con un error 400 Bad Request.
agentId

string

Obligatorio. El identificador único del agente.

Cuerpo de la respuesta

Respuesta con datos de accesibilidad del usuario para RCS para empresas.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Campos
reachableUsers[]

string

Lista de números de teléfono de los usuarios a los que puede comunicarse RCS para empresas. Solo incluye a los usuarios de los operadores en los que se inicia 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 el recuento de números de teléfono solicitados es inferior a 500.
reachableRandomSampleUserCount

integer

Recuento de números de teléfono de la lista seleccionada de forma aleatoria que son accesibles 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.
reachableUsersMap

map (key: string, value: object (ReachableUsers))

Solo salida. Mapa del ID del operador a una lista de usuarios accesibles en ese operador. Este campo solo se propaga para los números de teléfono de EE.UU.

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.

ReachableUsers

Una lista de usuarios accesibles en un operador específico.

Representación JSON 
{
  "reachableUsers": [
    string
  ]
}
Campos
reachableUsers[]

string

Una lista de usuarios accesibles en un operador específico. Este campo solo se propaga para los números de teléfono de EE.UU.