Method: users.batchGet

Recupera i numeri di telefono con RCS attivo per un elenco di utenti.

Il payload restituito contiene un elenco di numeri di telefono abilitati a RCS raggiungibili dalla piattaforma RCS for Business per gli utenti specificati. Verranno restituiti solo i numeri di telefono con RCS attivato per un operatore su cui viene avviato l'agente.

Il payload restituito contiene anche valori che possono essere utilizzati per stimare la potenziale copertura di un elenco di numeri di telefono, indipendentemente dallo stato di lancio dell'agente.

Massimo 600 query al minuto (QPM).

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "users": [
    string
  ],
  "agentId": string
}
Campi
users[]

string

Elenco dei numeri di telefono degli utenti in formato E.164.
agentId

string

Obbligatorio. L'identificatore univoco dell'agente.

Corpo della risposta

Risposta con i dati di raggiungibilità dell'utente per RCS for Business.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Campi
reachableUsers[]

string

Elenco dei numeri di telefono degli utenti che possono essere raggiunti da RCS for Business. Include solo gli utenti di operatori su cui è stato lanciato l'agente.
totalRandomSampleUserCount

integer

Conteggio dei numeri di telefono selezionati in modo casuale da reachableUsers. In genere, questo valore corrisponde a circa il 75% del totale dei numeri di telefono richiesti. Questo valore è 0 se il conteggio dei numeri di telefono richiesti è inferiore a 500.
reachableRandomSampleUserCount

integer

Conteggio dei numeri di telefono dell'elenco selezionato in modo casuale raggiungibili tramite RCS su tutti gli operatori, indipendentemente dallo stato di lancio dell'agente. Il rapporto tra questo valore e totalRandomSampleUserCount può approssimare la potenziale copertura di un elenco di utenti.
reachableUsersMap

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

Solo output. Mappa dell'ID operatore a un elenco di utenti raggiungibili su quell'operatore. Questo campo viene compilato solo per i numeri di telefono statunitensi.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

ReachableUsers

Un elenco di utenti raggiungibili su un operatore specifico.

Rappresentazione JSON 
{
  "reachableUsers": [
    string
  ]
}
Campi
reachableUsers[]

string

Un elenco di utenti raggiungibili su un operatore specifico. Questo campo viene compilato solo per i numeri di telefono statunitensi.