REST Resource: brands.agents

Ressource: KI-Agent

Eine dialogorientierte Einheit, die eine Marke repräsentiert.

JSON-Darstellung
{ "name": string, "displayName": string, "brandName": string, // 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 ID des Agents. Schreibgeschützt. Von der Plattform definiert.
displayName	string Erforderlich. Der Name, den der Agent Nutzern anzeigt. Maximal 40 Zeichen. Nach der Bestätigung des Kundenservicemitarbeiters nicht mehr änderbar.
brandName	string Nur Ausgabe. Der Name der Marke, die mit dem Agenten verknüpft ist.
Union-Feld detail_info. Enthält die für das jeweilige Produkt erforderlichen Felder. Erforderlich. Für detail_info ist nur einer der folgenden Werte zulässig:
rcsBusinessMessagingAgent	object (RcsBusinessMessagingAgent) Ausführliche Agent-Informationen für RCS for Business.

RcsBusinessMessagingAgent

KI-Agenteninformationen speziell zu RCS for Business. Für die Erstellung von Kundenservicemitarbeitern wird empfohlen, mindestens eine Kontaktmethode (Telefon, E‑Mail oder Website) mit einem entsprechenden Label anzugeben. Für die Aktivierung des Agents ist mindestens eine Kontaktmethode (Telefon, E‑Mail oder Website) mit einem entsprechenden Label 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. Die Beschreibung des KI-Agenten, die für Nutzer sichtbar ist. Der Titel darf maximal 100 Zeichen lang sein. Weitere Informationen
logoUri	string Erforderlich. Öffentlich verfügbare URL des Logos für den Agent. Maximal 50 KB. Nach der Bestätigung des Kundenservicemitarbeiters nicht mehr änderbar.
heroUri	string Erforderlich. Öffentlich verfügbare URL des Hero-Bilds für den Agent. Maximal 200 KB Nach der Bestätigung des Kundenservicemitarbeiters nicht mehr änderbar.
phoneNumbers[]	object (PhoneEntry) Optional. Telefonnummern, die mit dem Agent verknüpft sind. Erforderlich, wenn keine E-Mail-Adresse und Website angegeben sind.
emails[]	object (EmailEntry) Optional. Mit dem Kundenservicemitarbeiter verknüpfte E‑Mail-Adressen. Erforderlich, wenn keine Telefonnummer und Website angegeben werden.
websites[]	object (WebEntry) Optional. Websites, die mit dem KI-Agenten verknüpft sind. Maximal 3. Erforderlich, wenn keine Telefonnummer und E-Mail-Adresse angegeben werden.
privacy	object (WebEntry) Erforderlich. Datenschutzerklärung, die dem KI-Agenten zugeordnet ist.
termsConditions	object (WebEntry) Erforderlich. Nutzungsbedingungen, die mit dem KI-Agenten verknüpft sind.
color	string Erforderlich. Die Designfarbe des Agents, die Nutzern im Hexadezimalformat angezeigt wird. Beispiel: #FF6347.
billingConfig	object (RcsBusinessMessagingAgentBillingConfig) Erforderlich. Abrechnungskonfiguration für den Agent.
agentUseCase	enum (AgentUseCase) Optional. Anwendungsfall des Bots.
hostingRegion	enum (HostingRegion) Erforderlich. Hosting-Region für einen Agent.
partner	object (PartnerEntry) Nur Ausgabe. Partner, der dem Agent zugeordnet ist.
launchDetails	map (key: string, value: object (RcsBusinessMessagingRegionLaunch)) Nur Ausgabe. Details zur Einführung des Agents. Das Feld wird nur für Mobilfunkanbieter ausgefüllt und enthält nur die Startdetails des Mobilfunkanbieters, der den Anruf tätigt.
indiaPrincipalEntityId	string Optional. Die PE-ID (Principal Entity ID) des Unternehmens in Indien, das mit dem Agenten verknüpft ist. Erforderlich, wenn Sie den Agenten in Indien einführen möchten.

PhoneEntry

Eine mit dem Agent verknüpfte Telefonnummer.

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

Felder
phoneNumber	object (Phone) Erforderlich. Telefonnummer in einem von zwei möglichen Formaten: entweder das vollständige E.164-Format (z. B. „[phone]“) oder eine unformatierte lokale/gebührenfreie Telefonnummer ohne „+“, Präfix oder Ländercode (z. B. „6502530000“). Hinweis: Notrufnummern sind nicht zulässig.
label	string Erforderlich. Label für die Telefonnummer.

EmailEntry

Eine mit dem KI-Agenten verknüpfte E‑Mail-Adresse.

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

Felder
address	string Erforderlich. Eine E-Mail-Adresse.
label	string Erforderlich. Label für die E‑Mail-Adresse.

WebEntry

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

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

Felder
uri	string Erforderlich. Ein öffentlich zugänglicher URI, der dem Agenten zugeordnet ist. Es muss das HTTP- oder HTTPS-Protokoll verwendet werden.
label	string Erforderlich für websites, ansonsten optional. Label für den URI.

RcsBusinessMessagingAgentBillingConfig

Abrechnungskonfiguration für den Agent.

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

Felder
billingCategory	enum (BillingCategory) Abrechnungskategorie für den KI-Agenten.

BillingCategory

Unterstützte Abrechnungskategorien.

Enums
BILLING_CATEGORY_UNSPECIFIED	Kategorie nicht angegeben.
CONVERSATIONAL_LEGACY	Alte Kategorie zur Unterstützung der Abrechnungskonfiguration vorhandener Agenten. Verwenden Sie stattdessen CONVERSATIONAL. Dieses Element wird nicht mehr unterstützt.
CONVERSATIONAL	Für längere, komplexere Sitzungen, in denen Nutzer und Marke eine Reihe von Nachrichten austauschen.
SINGLE_MESSAGE	RCS bietet mehr Möglichkeiten beim Chatten als SMS. Wird nie als CONVERSATIONAL abgerechnet. Dieses Element wird nicht mehr unterstützt.
BASIC_MESSAGE	Das Abrechnungsmodell ähnelt dem von SMS. Wird nie als CONVERSATIONAL abgerechnet. Dieses Element wird nicht mehr unterstützt.
NON_CONVERSATIONAL	Stellt eine Abrechnungskategorie ohne Unterhaltung dar, die die alten Kategorien SINGLE_MESSAGE und BASIC_MESSAGE ersetzt. Dies gilt für Agenten, die hauptsächlich in der Einwegkommunikation (A2P) tätig sind.

AgentUseCase

In der Speicherung verwendete Anwendungsfalltypen für Agenten.

Enums
AGENT_USE_CASE_UNSPECIFIED	Anwendungsfall nicht angegeben.
TRANSACTIONAL	Agents, die nur wichtige, notwendige und zeitkritische Nachrichten senden.
PROMOTIONAL	Agents, die Verkaufs-, Marketing- und Werbenachrichten senden. Standardtyp.
OTP	Agenten, die nur Einmalpasswörter senden.
MULTI_USE	Agenten mit mehreren Anwendungsfällen. Dazu gehören auch Agents, bei denen ein Anwendungsfall sofort eingeführt wird, während der zweite für die zukünftige Veröffentlichung geplant ist. Weitere Informationen finden Sie in der Dokumentation zu Mehrfachverwendung.

HostingRegion

Mögliche Hosting-Regionen für einen Agenten, die zum korrekten Weiterleiten von P2A-Nachrichten an den regionalisierten Server verwendet werden.

Enums
HOSTING_REGION_UNSPECIFIED	Nicht angegebene Hosting-Region.
NORTH_AMERICA	Nordamerika
EUROPE	Europa.
ASIA_PACIFIC	Asiatisch-pazifischer Raum

PartnerEntry

Partner, der dem Agent zugeordnet ist.

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 Partner für Produkte zu verknüpfen. Sollte unter Partnern eindeutig sein.
company	string Nur Ausgabe. Der öffentliche Name des Unternehmens für den angegebenen Partner. Beispiele: Twilio oder Cisco.

RcsBusinessMessagingRegionLaunch

Details zur Einführung von RCS for Business-Agenten in den einzelnen Regionen.

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

Felder
launchState	enum (LaunchState) Der Einführungsstatus für eine Region.
comment	string Kommentar des Transportunternehmens
updateTime	string (Timestamp format) Zeitpunkt der letzten Aktualisierung. 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".

LaunchState

Der Einführungsstatus einer Entität.

Enums
LAUNCH_STATE_UNSPECIFIED	Nicht angegebener Zustand.
LAUNCH_STATE_UNLAUNCHED	Die Entität wurde noch nicht veröffentlicht.
LAUNCH_STATE_PENDING	Die Veröffentlichung wird überprüft.
LAUNCH_STATE_LAUNCHED	Eingeführt
LAUNCH_STATE_REJECTED	Der Start wurde abgelehnt.
LAUNCH_STATE_SUSPENDED	Die Einführung wurde ausgesetzt.
LAUNCH_STATE_PENDING_UNLAUNCH	Eingestellt: Dieser Status wird nicht mehr verwendet. Die Rücknahme der Veröffentlichung wird überprüft. Dieses Element wird nicht mehr unterstützt.
LAUNCH_STATE_INVALID_IN_GMB	Eingestellt: Dieser Status wird nicht mehr verwendet. Die Einführung ist ungültig, da die Nachrichtenfunktion für den zugehörigen Google Unternehmensprofil-Eintrag nicht unterstützt wird. Die erneute Bestätigung in Google My Business wird hier automatisch neu gestartet. Gilt nur für Standorte. Dieses Element wird nicht mehr unterstützt.

Methoden
create	Erstellt einen neuen Agent, der eine Marke repräsentiert.
delete (deprecated)	Eingestellt: Das Löschen von KI-Agenten wurde eingestellt.
get	Informationen zu einem Agent abrufen
getLaunch	Ruft die Informationen zur Einführung eines Agents ab.
getVerification	Ruft die Bestätigungsinformationen für einen Agent ab.
list	Listet alle Agenten auf, die mit einer Marke verknüpft sind.
patch	Aktualisiert Informationen zu einem Agent.
requestLaunch	Startet den Einführungsprozess für einen Agent.
requestVerification	Übermittelt Informationen zur Unternehmensüberprüfung für einen Agent.
updateLaunch	Aktualisiert die Informationen zur Einführung eines Agents.
updateVerification	Aktualisiert den Bestätigungsstatus für einen Agent.