REST Resource: brands.agents.integrations

Ressource: Integration

Informationen zur Integration.

JSON-Darstellung 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // End of list of possible types for union field integration_info.
}
Felder
name

string

Nur Ausgabe. Die eindeutige ID der Integration. Schreibgeschützt. Von der Plattform definiert.
status

enum (IntegrationStatus)

Nur Ausgabe. Integrationsstatus.
Union-Feld integration_info. Detaillierte Informationen zur Integration. Für integration_info ist nur einer der folgenden Werte zulässig:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informationen zu einem zugehörigen Dialogflow ES-Projekt. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informationen zu einem zugehörigen Dialogflow CX-Projekt. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Informationen zum Webhook für einen Agent. Wenn ein Webhook auf Agent-Ebene konfiguriert ist, wird der Webhook auf Partnerebene überschrieben.

IntegrationStatus

Integrationsstatus.

Enums
INTEGRATION_STATUS_UNSPECIFIED Der Integrationsstatus ist nicht angegeben.
ENABLED Aktiviert.
DISABLED Deaktiviert.

DialogflowEsIntegration

Informationen zur Verknüpfung eines Business Messages-Agents und eines Dialogflow ES-Projekts.

JSON-Darstellung 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Felder
dialogflowProjectId

string

Erforderlich. Die Dialogflow-Projekt-ID.

Nicht bearbeitbar. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt für diesen Agent löschen und dann eine neue Integration erstellen.
autoResponseStatus

enum (AutoResponseStatus)

Erforderlich. Wenn ENABLED, werden die Dialogflow-Antworten automatisch über Business Messages an Nutzer gesendet.
dialogflowServiceAccountEmail

string

Nur Ausgabe. Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Agent-Bearbeiter in Dialogflow-Konsole“ und „Dialogflow API-Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren.
operationInfo

object (OperationInfo)

Nur Ausgabe. Informationen zum Betriebsstatus der Dialogflow-Integration.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Wissensdatenbanken, die dem Dialogflow-Projekt zugeordnet sind.

Optional

AutoResponseStatus

Status der automatischen Antwort von Dialogflow.

Enums
AUTO_RESPONSE_STATUS_UNSPECIFIED Die automatische Antwort ist nicht angegeben.
ENABLED Die automatische Antwort ist aktiviert.
DISABLED Die automatische Antwort ist deaktiviert.

OperationInfo

Die Dialogflow-Vorgangsinformationen.

JSON-Darstellung 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Felder
operationName

string

Nur Ausgabe. Der vom Server zugewiesene Name (Vorgangs-ID), der nur innerhalb des Dienstes eindeutig ist, der ihn ursprünglich zurückgibt.
operationType

enum (OperationType)

Nur Ausgabe. Dialogflow-Vorgangstyp.
operationState

enum (OperationState)

Nur Ausgabe. Dialogflow-Vorgangsstatus.
error

object (Status)

Nur Ausgabe. Fehlerergebnis, falls vorhanden.

OperationType

Dialogflow-Vorgangstypen.

Enums
OPERATION_TYPE_UNSPECIFIED Nicht definierter Typ.
ASSOCIATE_DIALOGFLOW Dialogflow verknüpfen
DISSOCIATE_DIALOGFLOW Dialogflow-Verknüpfung aufheben
ADD_DOCUMENT_TO_KNOWLEDGEBASE Dokument der Wissensdatenbank hinzufügen.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Löscht ein Dokument aus der Wissensdatenbank.

OperationState

Status von Vorgängen in Dialogflow.

Enums
OPERATION_STATE_UNSPECIFIED Nicht angegebener Zustand.
PROCESSING Wird verarbeitet.
COMPLETED Abgeschlossen.
FAILED Fehlgeschlagen.

Status

Mit dem Typ Status wird ein logisches Fehlermodell definiert, das für verschiedene Programmierumgebungen wie REST APIs und RPC APIs geeignet ist. Dieses Modell wird von gRPC verwendet. Jede Status-Meldung enthält die folgenden drei Datenelemente: Fehlercode, Fehlermeldung und Fehlerdetails.

Weitere Informationen zu diesem Fehlermodell und zur Arbeit damit finden Sie in der API-Designanleitung.

JSON-Darstellung 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Felder
code

integer

Der Statuscode, der idealerweise ein ENUM-Wert von google.rpc.Code ist.
message

string

Eine an Entwickler gerichtete Fehlermeldung, die englischsprachig sein sollte. Jede für Nutzer sichtbare Fehlermeldung sollte lokalisiert und im Feld google.rpc.Status.details gesendet werden. Sie kann auch clientseitig lokalisiert werden.
details[]

object

Eine Auflistung aller Meldungen, die die Fehlerdetails enthalten. Es gibt einen gemeinsamen Satz von Nachrichtentypen, die APIs verwenden können.

Ein Objekt, das Felder eines beliebigen Typs enthält. Ein zusätzliches Feld "@type" enthält einen URI zur Identifizierung des Typs. Beispiel: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informationen aus der Wissensdatenbank. Eine Wissensdatenbank kann mehrere FAQ-URLs haben.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Felder
name

string

Nur Ausgabe. Wissensdatenbank-ID.

Eindeutige Kennung, die vom Dialogflow-Dienst nach der Erstellung einer Wissensdatenbank zurückgegeben wird. Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“ und die Wissensdatenbank-ID „1111“ lauten, wird dieser Parameter zu „brands/1234/agents/5678/integrations/9092/knowledgebases/1111“.
displayName

string

Erforderlich. Anzeigename der Wissensdatenbank.
documents[]

object (DialogflowDocument)

Dokumente der Wissensdatenbank.

Optional
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem die Wissensdatenbank erstellt oder aktualisiert wurde.

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".

DialogflowDocument

Ein Wissensdatenbankdokument. Ein Dokument kann entweder eine Website-URL oder eine URL zu einer CSV-Datei sein. Die URLs müssen öffentlich zugänglich sein. CSV-Dateien müssen ein oder mehrere Frage-/Antwortpaare enthalten, wobei jedes Paar in einer eigenen Zeile steht.

JSON-Darstellung 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
Felder
name

string

Vom System generierte Dokument-ID.

Wenn die Marken-ID „1234“, die Agent-ID „5678“, die Integrations-ID „9092“, die Wissensdatenbank-ID „1111“ und die Dokument-ID „2222“ lauten, wird dieser Parameter zu „brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222“.
displayName

string

Erforderlich. Anzeigename eines FAQ-Dokuments.
updateTime

string (Timestamp format)

Nur Ausgabe. Zeitpunkt, zu dem das Dokument erstellt/aktualisiert wurde.

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".
operationInfo

object (OperationInfo)

Nur Ausgabe. „Operation Information“ wird nur ausgefüllt, wenn ein Dokument einer vorhandenen Wissensdatenbank hinzugefügt wird.
Union-Feld content. Inhalt des Dokuments. Für content ist nur einer der folgenden Werte zulässig:
faqUrl

string

URL eines FAQ-Dokuments.
rawContent

string (bytes format)

Der Rohinhalt des Dokuments.

Ein base64-codierter String.

DialogflowCxIntegration

Informationen zur Verknüpfung eines Business Messages-Agents mit einem Dialogflow CX-Projekt.

JSON-Darstellung 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Felder
dialogflowProjectId

string

Erforderlich. Die Dialogflow-Projekt-ID.

Nicht bearbeitbar. Wenn Sie diesen Wert ändern möchten, müssen Sie das Dialogflow-Projekt für diesen Agent löschen und dann eine neue Integration erstellen.
dialogflowAgentId

string

Erforderlich. Die Dialogflow-Agent-ID.
autoResponseStatus

enum (AutoResponseStatus)

Erforderlich. Wenn ENABLED, werden die Dialogflow-Antworten automatisch über Business Messages an Nutzer gesendet.
dialogflowServiceAccountEmail

string

Nur Ausgabe. Das Dienstkonto, das im Dialogflow-Projekt mit den Rollen „Agent-Bearbeiter in Dialogflow-Konsole“ und „Dialogflow API-Client“ konfiguriert werden muss. Dies ist erforderlich, um Zugriff auf die Dialogflow API zu gewähren.
operationInfo

object (OperationInfo)

Nur Ausgabe. Informationen zum Betriebsstatus der Dialogflow-Integration.

AgentWebhookIntegration

Informationen zum Webhook für einen Business Messages-Agenten.

JSON-Darstellung 
{
  "webhookUri": string,
  "verificationToken": string
}
Felder
webhookUri

string

Erforderlich. Die Webhook-URL, an die die Nachrichten gesendet werden.
verificationToken

string

Nur Eingabe. Das Bestätigungstoken.

Methoden

create

 Integration erstellen

delete

 Integration löschen

get

 Integration abrufen

list

 Integrationen auflisten

patch

 Integration aktualisieren