REST Resource: brands.agents

Ressource: Agent

Eine dialogfähige Entität, die eine Marke repräsentiert.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "brandName": string,
  "isArchived": boolean,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Felder
name

string

Die eindeutige Kennung des Agenten.

Schreibgeschützt. Von der Plattform definiert.

displayName

string

Erforderlich. Der Name, der dem Benutzer vom Agenten angezeigt wird. Maximal 40 Zeichen.

Nach der Agentenprüfung nicht mehr änderbar.

brandName

string

Nur Ausgabe. Der Name der mit dem Agenten verbundenen Marke.

isArchived

boolean

Optional. Wenn true , wird der Agent archiviert und standardmäßig nicht in die Ergebnisliste aufgenommen.

Union-Feld detail_info . Enthält die für das jeweilige Produkt erforderlichen Felder.

Erforderlich. detail_info darf nur einen der folgenden Werte annehmen:

rcsBusinessMessagingAgent

object ( RcsBusinessMessagingAgent )

Detaillierte Agenteninformationen für RCS for Business.

RcsBusinessMessagingAgent

Agenteninformationen speziell für RCS for Business. Für die Agentenerstellung wird empfohlen, mindestens eine Kontaktmethode (Telefon, E-Mail oder Website) mit einer entsprechenden Bezeichnung anzugeben. Für die Aktivierung eines Agenten ist mindestens eine Kontaktmethode (Telefon, E-Mail oder Website) mit einer entsprechenden Bezeichnung erforderlich.

JSON-Darstellung 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}
Felder
description

string

Erforderlich. Beschreibung des Agenten, die für Benutzer sichtbar ist. Maximal 100 Zeichen. Detaillierte Anforderungen finden Sie unter „Agenteninformationen bearbeiten“ .

logoUri

string

Erforderlich. Öffentlich zugängliche URL des Logos des Agenten. Maximal 50 KB.

Nach der Agentenprüfung nicht mehr änderbar.

heroUri

string

Erforderlich. Öffentlich zugängliche URL des Heldenbildes des Agenten. Maximal 200 KB.

Nach der Agentenprüfung nicht mehr änderbar.

phoneNumbers[]

object ( PhoneEntry )

Optional. Telefonnummern des Maklers. Erforderlich, falls E-Mail-Adresse und Website nicht angegeben sind.

emails[]

object ( EmailEntry )

Optional. E-Mail-Adressen des Agenten. Erforderlich, falls Telefonnummer und Website nicht angegeben sind.

websites[]

object ( WebEntry )

Optional. Websites, die mit dem Makler in Verbindung stehen. Maximal 3. Erforderlich, wenn Telefonnummer und E-Mail-Adresse nicht angegeben werden.

privacy

object ( WebEntry )

Erforderlich. Datenschutzerklärung des Anbieters.

termsConditions

object ( WebEntry )

Erforderlich. Es gelten die Allgemeinen Geschäftsbedingungen des Agenten.

color

string

Erforderlich. Die für Benutzer sichtbare Designfarbe des Agenten im Hexadezimalformat. Beispiel: #FF6347.

billingConfig

object ( RcsBusinessMessagingAgentBillingConfig )

Erforderlich. Abrechnungskonfiguration für den Agenten.

agentUseCase

enum ( AgentUseCase )

Erforderlich. Anwendungsfall des Bots.

hostingRegion

enum ( HostingRegion )

Erforderlich. Hosting-Region für einen Agenten.

partner

object ( PartnerEntry )

Nur Ausgabe. Dem Agenten zugeordneter Partner.

launchDetails

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

Nur Ausgabe. Startdetails für den Agenten. Nur für Netzbetreiber ausgefüllt und nur mit den Startdetails des anrufenden Netzbetreibers.

indiaPrincipalEntityId

string

Optional. Geschäftsinhaberkennung (PE-ID) des mit dem Agenten verbundenen Unternehmens in Indien. Erforderlich, wenn die Einführung des Agenten in Indien geplant ist.

Telefoneingabe

Eine dem Agenten zugeordnete Telefonnummer.

JSON-Darstellung 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Felder
phoneNumber

object ( Phone )

Erforderlich. Telefonnummer in zwei möglichen Formaten: entweder im vollständigen E.164-Format (z. B. „+12223334444“) oder als unformatierte Orts-/gebührenfreie Telefonnummer ohne „+“, Vorwahl oder Landesvorwahl (z. B. „6502530000“). Hinweis: Notrufnummern sind nicht zulässig.

label

string

Erforderlich. Etikett für die Telefonnummer.

E-Mail-Eintrag

Eine dem Agenten zugeordnete E-Mail-Adresse.

JSON-Darstellung 
{
  "address": string,
  "label": string
}
Felder
address

string

Erforderlich. Eine E-Mail-Adresse.

label

string

Erforderlich. Bezeichnung für die E-Mail-Adresse.

WebEntry

Eine webbasierte Ressource, die mit dem Agenten verknüpft ist.

JSON-Darstellung 
{
  "uri": string,
  "label": string
}
Felder
uri

string

Erforderlich. Eine öffentlich zugängliche URI, die dem Agenten zugeordnet ist. Muss das HTTP- oder HTTPS-Protokoll verwenden.

label

string

Für websites erforderlich, ansonsten optional. Bezeichnung für die URI.

RcsBusinessMessagingAgentBillingConfig

Abrechnungskonfiguration für den Agenten.

JSON-Darstellung 
{
  "billingCategory": enum (BillingCategory)
}
Felder
billingCategory

enum ( BillingCategory )

Abrechnungskategorie für den Agenten.

Abrechnungskategorie

Unterstützte Abrechnungskategorien.

Aufzählungen
BILLING_CATEGORY_UNSPECIFIED Kategorie nicht angegeben.
CONVERSATIONAL_LEGACY

Diese Kategorie diente bisher der Unterstützung der Abrechnungskonfiguration bestehender Agenten. Verwenden Sie stattdessen CONVERSATIONAL .

CONVERSATIONAL Konzipiert für längere, komplexere Sitzungen, in denen Nutzer und Marke eine Reihe von Nachrichten austauschen.
NON_CONVERSATIONAL Stellt eine Abrechnungskategorie dar, die nicht auf Konversation basiert. Dies gilt für Agenten, die hauptsächlich einseitige Kommunikation (A2P) betreiben.

Agentenverwendungsfall

Im Speicherbereich verwendete Agenten-Anwendungsfalltypen.

Aufzählungen
AGENT_USE_CASE_UNSPECIFIED Anwendungsfall nicht angegeben.
TRANSACTIONAL Agenten, die nur essentielle, notwendige und zeitkritische Nachrichten versenden.
PROMOTIONAL Agenten, die Vertriebs-, Marketing- und Werbenachrichten versenden. Standardtyp.
OTP Agenten, die nur Einmalpasswörter senden.
MULTI_USE Agenten mit mehreren Anwendungsfällen. Dazu gehören Agenten, bei denen ein Anwendungsfall sofort gestartet wird, während der zweite für eine spätere Version geplant ist. Weitere Informationen finden Sie in der Dokumentation zu Mehrfachverwendung .

Hostingregion

Mögliche Hosting-Regionen für einen Agenten, die für das korrekte Routing von P2A-Nachrichten an den regionalisierten Server verwendet werden.

Aufzählungen
HOSTING_REGION_UNSPECIFIED Nicht spezifizierte Hosting-Region.
NORTH_AMERICA Nordamerika.
EUROPE Europa.
ASIA_PACIFIC Asien-Pazifik.

PartnerEntry

Mit dem Agenten verbundener Partner.

JSON-Darstellung 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
Felder
partnerId

string

Nur Ausgabe. Eindeutige Kennung für den Partner.

displayName

string

Nur Ausgabe. Der Name, der Unternehmen angezeigt wird, um Produktpartnern zugeordnet zu werden. Muss unter allen Partnern eindeutig sein.

company

string

Nur Ausgabe. Der öffentliche Name des Unternehmens des jeweiligen Partners.

RcsBusinessMessagingRegionLaunch

Details zum Start von RCS for Business-Agenten in den einzelnen Regionen.

JSON-Darstellung 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string,
  "isHidden": boolean
}
Felder
launchState

enum ( LaunchState )

Der Startstatus für eine Region.

comment

string

Kommentar des Fluggesellschaftsunternehmens.

updateTime

string ( Timestamp format)

Letzte Aktualisierung: Zeitpunkt.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30" .

isHidden

boolean

Optional. Gibt an, ob der Agent für den Netzbetreiber als ausgeblendet markiert ist, was sich auf die Sichtbarkeit in der Konsole und der API-Ansicht auswirkt.

Startzustand

Der Startstatus einer Entität. Informationen zu zulässigen Startstatusübergängen für Netzbetreiber und Partner finden Sie unter Empfangsereignisse .

Aufzählungen
LAUNCH_STATE_UNSPECIFIED Nicht spezifizierter Zustand.
LAUNCH_STATE_UNLAUNCHED Die Entität ist nicht gestartet.
LAUNCH_STATE_PENDING Markteinführung im Rückblick.
LAUNCH_STATE_LAUNCHED Eingeführt.
LAUNCH_STATE_REJECTED Der Start wurde abgelehnt.
LAUNCH_STATE_SUSPENDED Der Start wurde verschoben.
LAUNCH_STATE_PENDING_UNLAUNCH

Veraltet: Dieser Status wird nicht mehr verwendet.

Die Markteinführung wird überprüft.

LAUNCH_STATE_INVALID_IN_GMB

Veraltet: Dieser Status wird nicht mehr verwendet.

Der Startvorgang ist ungültig, da der zugehörige Google My Business-Eintrag keine Nachrichtenfunktion unterstützt. Durch die erneute Bestätigung in Google My Business wird der Vorgang automatisch hier neu gestartet. Gilt nur für Standorte.

Methoden

create

 Erstellt einen neuen Agenten zur Vertretung einer Marke.

delete
(deprecated)

 Veraltet: Das Löschen von Agenten ist veraltet.

get

 Informieren Sie sich über einen Agenten.

getLaunch

 Ruft die Startinformationen für einen Agenten ab.

getVerification

 Ruft die Verifizierungsinformationen für einen Agenten ab.

list

 Listet alle mit einer Marke verbundenen Agenten auf.

patch

 Aktualisiert Informationen über einen Agenten.

requestLaunch

 Startet den Einführungsprozess für einen Agenten.

requestVerification

 Übermittelt Geschäftsbestätigungsinformationen für einen Agenten.

updateLaunch

 Aktualisiert die Startinformationen für einen Agenten.

updateVerification

 Aktualisiert den Verifizierungsstatus eines Agenten.