Method: users.batchGet

Ruft die RCS-kompatiblen Telefonnummern für eine Liste von Nutzern ab.

Die zurückgegebene Nutzlast enthält eine Liste der RCS-fähigen Telefonnummern, die von der RBM-Plattform für die angegebenen Nutzer erreichbar sind. Es werden nur Telefonnummern zurückgegeben, die für einen Mobilfunkanbieter, bei dem der Kundenservicemitarbeiter gestartet wurde, RCS-fähig sind.

Die zurückgegebene Payload enthält auch Werte, mit denen die potenzielle Reichweite einer Liste von Telefonnummern unabhängig vom Einführungsstatus des Kundenservicemitarbeiters geschätzt werden kann.

Maximal 600 Anfragen pro Minute.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "users": [
    string
  ],
  "agentId": string
}
Felder
users[]

string

Liste der Telefonnummern der Nutzer im E.164-Format.
agentId

string

Erforderlich. Die eindeutige Kennung des Kundenservicemitarbeiters.

Antworttext

Antwort mit Nutzerdaten zur RBM-Reichweite.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer
}
Felder
reachableUsers[]

string

Liste der Telefonnummern von Nutzern, die RBM erreichen kann. Umfasst nur Nutzer bei Mobilfunkanbietern, bei denen der Agent eingeführt wurde.
totalRandomSampleUserCount

integer

Anzahl der Telefonnummern, die zufällig aus reachableUsers ausgewählt wurden. Normalerweise entspricht dieser Wert etwa 75% der angeforderten Telefonnummern. Dieser Wert ist 0, wenn die Anzahl der angeforderten Telefonnummern unter 500 liegt.
reachableRandomSampleUserCount

integer

Anzahl der Telefonnummern aus der zufällig ausgewählten Liste, die unabhängig vom Einführungsstatus des Kundenservicemitarbeiters über alle Mobilfunkanbieter per RCS erreichbar sind. Das Verhältnis zwischen diesem Wert und totalRandomSampleUserCount kann die potenzielle Reichweite für eine Liste von Nutzern annähernd bestimmen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.