Method: brands.agents.list

Listet alle mit einer Marke verknüpften Agenten auf.

HTTP-Anfrage

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Die eindeutige ID der Marke. Wenn die Marken-ID „1234“ lautet, wird dieser Parameter in „brands/1234“ aufgelöst. Die Marken-ID muss „-“ sein, um alle Kundenservicemitarbeiter für einen RCS for Business-Mobilfunkanbieter zurückzugeben.

Suchparameter

Parameter
pageSize

integer

Geben Sie die maximale Anzahl der Ergebnisse an, die vom Server zurückgegeben werden sollen. Die Anzahl der maximal auf einer Seite zurückgegebenen Ergebnisse kann auf dem Server weiter begrenzt werden. Wenn „pageSize“ 0 ist, entscheidet der Server, wie viele Ergebnisse zurückgegeben werden.
pageToken

string

Der Wert "nextPageToken" wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben.
launchStateFilter

enum (LaunchState)

Optional. Es werden nur Agents mit diesem Startstatus zurückgegeben. Funktioniert nur, wenn es von Mobilfunkanbietern verwendet wird.
includeLaunchData

boolean

Wenn „true“, sind Startdaten (ohne Fragebogen) in der Antwort des Agents enthalten. Funktioniert nur, wenn es von Mobilfunkanbietern verwendet wird.
includeArchived

boolean

Optional. Enthält archivierte Agents in der Antwort.
includeHidden

boolean

Optional. Enthält ausgeblendete Kundenservicemitarbeiter in der Antwort.
orderBy

string

Optional. Gibt eine durch Kommas getrennte Liste von Feldern an, nach denen die Ergebnisse sortiert werden sollen.

Folgende Sortierfelder werden unterstützt:

  • updateTime: Sortiert chronologisch nach dem Zeitstempel der letzten Aktualisierung.
  • displayName: Sortiert alphabetisch nach dem für Menschen lesbaren Namen des Agents.
  • agentId: Sortiert nach der eindeutigen, vom System generierten Agenten-ID.

Für Sortierfelder, die ohne das Suffix " desc" oder " asc" angegeben werden, wird standardmäßig die aufsteigende Reihenfolge verwendet. Wenn dieser Parameter weggelassen wird, werden die Ergebnisse aufsteigend nach agentId sortiert.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Eine Liste von Agents.

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

JSON-Darstellung 
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
Felder
agents[]

object (Agent)

Liste der Agent-Informationen.
nextPageToken

string

Das Paginierungstoken zum Abrufen der nächsten Ergebnisseite. Wenn der Wert "" ist, sind keine weiteren Ergebnisse für die Anfrage vorhanden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.