Method: users.batchGet

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

Die zurückgegebene Nutzlast enthält eine Liste mit RCS-fähigen Telefonnummern, auf die die RBM-Plattform für die angegebenen Nutzer zugreifen kann. Es werden nur Telefonnummern zurückgegeben, die für einen Mobilfunkanbieter, bei dem der Agent aktiviert ist, RCS-fähig sind.

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

Maximal 600 Abfragen 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 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 aktiviert ist.
totalRandomSampleUserCount

integer

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

integer

Anzahl der Telefonnummern aus der zufällig ausgewählten Liste, die bei allen Mobilfunkanbietern RCS-Chats erreichbar sind, unabhängig vom Aktivierungsstatus des Agents. Das Verhältnis zwischen diesem Wert und totalRandomSampleUserCount kann ungefähr der potenziellen Reichweite für eine Liste von Nutzern entsprechen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.