Method: users.batchGet

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

Die zurückgegebene Nutzlast enthält eine Liste der RCS-fähigen Telefonnummern, die über die RCS for Business-Plattform für die angegebenen Nutzer erreichbar sind. Es werden nur Telefonnummern zurückgegeben, die für einen Mobilfunkanbieter, auf dem der Agent gestartet wird, für RCS aktiviert sind.

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

Maximal 600 Abfragen pro Minute.

Wichtig:Für die Methode users.batchGet müssen regionale Endpunkte verwendet werden. Anfragen müssen Telefonnummern aus einer einzelnen geografischen Region enthalten. Wenn Sie Telefonnummern aus mehreren Regionen in einer einzelnen Anfrage senden oder an den falschen regionalen Endpunkt senden, erhalten Sie den Fehler 400 Bad Request.

Regionale Endpunkte:

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.

Alle Telefonnummern in einer einzelnen Anfrage müssen zur selben geografischen Region gehören. Anfragen mit Telefonnummern aus mehreren Regionen oder Anfragen, die an den falschen regionalen Endpunkt gesendet werden, schlagen mit dem Fehler 400 Bad Request fehl.
agentId

string

Erforderlich. Die eindeutige ID des Agents.

Antworttext

Antwort mit Daten zur Erreichbarkeit von Nutzern für RCS for Business.

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

JSON-Darstellung 
{
  "reachableUsers": [
    string
  ],
  "totalRandomSampleUserCount": integer,
  "reachableRandomSampleUserCount": integer,
  "reachableUsersMap": {
    string: {
      object (ReachableUsers)
    },
    ...
  }
}
Felder
reachableUsers[]

string

Liste der Telefonnummern von Nutzern, die über RCS for Business erreicht werden können. Umfasst nur Nutzer bei Mobilfunkanbietern, bei denen der Agent gestartet wird.
totalRandomSampleUserCount

integer

Anzahl der Telefonnummern, die zufällig aus reachableUsers ausgewählt wurden. In der Regel entspricht dieser Wert etwa 75% der insgesamt 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 über alle Mobilfunkanbieter hinweg per RCS erreichbar sind, unabhängig vom Startstatus des Agents. Das Verhältnis zwischen diesem Wert und totalRandomSampleUserCount kann die potenzielle Reichweite für eine Liste von Nutzern annähern.
reachableUsersMap

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

Nur Ausgabe. Zuordnung der Mobilfunkanbieter-ID zu einer Liste der erreichbaren Nutzer bei diesem Mobilfunkanbieter. Dieses Feld wird nur für US-amerikanische Telefonnummern ausgefüllt.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

ReachableUsers

Eine Liste der erreichbaren Nutzer bei einem bestimmten Mobilfunkanbieter.

JSON-Darstellung 
{
  "reachableUsers": [
    string
  ]
}
Felder
reachableUsers[]

string

Eine Liste der erreichbaren Nutzer bei einem bestimmten Mobilfunkanbieter. Dieses Feld wird nur für US-amerikanische Telefonnummern ausgefüllt.