Method: users.batchGet

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

O payload retornado contém uma lista de números de telefone compatíveis com RCS que podem ser contatados pela plataforma RCS para empresas para os usuários especificados. Somente os números de telefone que estão ativados para RCS em uma operadora em que o agente é lançado serão retornados.

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, independente do status de lançamento 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 números de telefone dos usuários no formato E.164.
agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da resposta

Resposta com dados de capacidade de alcance do usuário para o RCS for Business.

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 números de telefone dos usuários que podem ser contatados pelo RCS for Business. Inclui apenas usuários em operadoras em que o agente é lançado.
totalRandomSampleUserCount

integer

Contagem de números de telefone selecionados aleatoriamente em reachableUsers. Normalmente, esse valor é de aproximadamente 75% do total de números de telefone solicitados. Esse valor é 0 se a contagem de números de telefone solicitados for menor que 500.
reachableRandomSampleUserCount

integer

Contagem de números de telefone da lista selecionada aleatoriamente que podem ser alcançados por RCS em todas as operadoras, independente do status de lançamento do agente. A proporção entre esse valor e totalRandomSampleUserCount pode aproximar o 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 OAuth 2.0 Overview.