Method: users.batchGet

Consente di acquisire i numeri di telefono abilitati per RCS per un elenco di utenti.

Il payload restituito contiene un elenco di numeri di telefono abilitati per RCS raggiungibili dalla piattaforma RBM per gli utenti specificati. Verranno restituiti solo i numeri di telefono abilitati per RCS per un operatore su cui l'agente è stato lanciato.

Il payload restituito contiene anche valori che possono essere utilizzati per stimare la copertura potenziale 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 dati utente sulla raggiungibilità RBM.

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

Rappresentazione JSON 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Campi
reachableUsers[]

string

Elenco dei numeri di telefono degli utenti che RBM può raggiungere. Include solo gli utenti con operatori su cui è stato avviato l'agente.
totalRandomSampleUserCount

integer

Conteggio di 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 numero di numeri di telefono richiesti è inferiore a 500.
reachableRandomSampleUserCount

integer

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

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Panoramica di OAuth 2.0.