Method: users.batchGet

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

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

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

Maximal 600 Abfragen pro Minute (QPM).

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 von Nutzern im E.164-Format.
agentId

string

Erforderlich. Die eindeutige Kennung des Agents.

Antworttext

Antwort mit Nutzerdaten zur RBM-Erreichbarkeit.

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 von Mobilfunkanbietern, bei denen der Agent gestartet wurde.
totalRandomSampleUserCount

integer

Anzahl der Telefonnummern, die zufällig aus reachableUsers ausgewählt wurden. Dieser Wert beträgt in der Regel ca. 75% der insgesamt angeforderten Telefonnummern. Dieser Wert ist 0, wenn die Anzahl der angeforderten Telefonnummern kleiner als 500 ist.
reachableRandomSampleUserCount

integer

Anzahl der Telefonnummern aus der zufällig ausgewählten Liste, die unabhängig vom Aktivierungsstatus des Agents über RCS erreichbar sind. Das Verhältnis zwischen diesem Wert und totalRandomSampleUserCount kann die potenzielle Reichweite einer Liste von Nutzern annähern.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.