Method: users.batchGet

Recebe os números de telefone compatíveis com RCS para uma lista de usuários.

O payload retornado contém uma lista de números de telefone compatíveis com RCS que podem ser acessados pela plataforma RBM dos usuários especificados. Serão retornados somente os números de telefone de uma operadora que tem o RCS ativado para uma operadora em que o agente foi lançado.

O payload retornado também contém valores que podem ser usados para estimar o alcance potencial de uma lista de números de telefone, independentemente do status de inicialização do agente.

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

Solicitação HTTP

POST https://rcsbusinessmessaging.googleapis.com/v1/users:batchGet

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Campos
users[]

string

Lista de usuários números de telefone no formato E.164.
agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da resposta

Resposta com dados do usuário de acessibilidade do RBM.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Campos
reachableUsers[]

string

Lista de usuários e números de telefone que o RBM pode alcançar. Inclui apenas usuários de operadoras em que o agente foi lançado.
totalRandomSampleUserCount

integer

Número de números de telefone selecionados aleatoriamente de reachableUsers. Normalmente, esse valor representa cerca de 75% do total de números de telefone solicitados. Esse valor será 0 se a contagem de números de telefone solicitados for menor que 500.
reachableRandomSampleUserCount

integer

Número de números de telefone da lista selecionada aleatoriamente que podem ser acessados por RCS em todas as operadoras, independente do status de lançamento do agente. A proporção entre esse valor e totalRandomSampleUserCount pode se aproximar do alcance potencial de uma lista de usuários.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.