Method: users.batchGet

Recebe os números de telefone ativados para RCS de uma lista de usuários.

O payload retornado contém uma lista de números de telefone ativados para RCS que podem ser acessados pela plataforma RCS for Business para os usuários especificados. Somente os números de telefone ativados para RCS de uma operadora em que o agente é iniciado 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, independentemente do status de lançamento do agente.

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

Importante:o método users.batchGet exige o uso de endpoints regionais. As solicitações precisam conter números de telefone de uma única região geográfica. O envio de números de telefone de várias regiões em uma única solicitação ou enviados para o endpoint regional incorreto resultará em um erro 400 Bad Request.

Endpoints regionais:

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.

Todos os números de telefone em uma única solicitação precisam pertencer à mesma região geográfica. As solicitações que contêm números de telefone de várias regiões ou enviadas para o endpoint regional incorreto falharão com um erro 400 Bad Request.
agentId

string

Obrigatório. O identificador exclusivo do agente.

Corpo da resposta

Resposta com dados de acessibilidade 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,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Campos
reachableUsers[]

string

Lista de números de telefone dos usuários que o RCS for Business pode alcançar. Inclui apenas usuários em operadoras em que o agente é iniciado.
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 acessados por RCS em todas as operadoras, independentemente 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.
reachableUsersMap

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

Apenas saída. Mapa do ID da operadora para uma lista de usuários acessíveis nessa operadora. Esse campo só é preenchido para números de telefone dos EUA.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.

ReachableUsers

Uma lista de usuários acessíveis em uma operadora específica.

Representação JSON 
{
  "reachableUsers": [
    string
  ]
}
Campos
reachableUsers[]

string

Uma lista de usuários acessíveis em uma operadora específica. Esse campo só é preenchido para números de telefone dos EUA.