REST Resource: brands.agents.integrations

Risorsa: integrazione

Informazioni sull'integrazione.

Rappresentazione JSON 
{
  "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.
}
Campi
name

string

Solo output. L'identificatore univoco dell'integrazione. Sola lettura. Definite dalla piattaforma.
status

enum (IntegrationStatus)

Solo output. Stato integrazione.
Campo unione integration_info. Informazioni dettagliate per l'integrazione. integration_info può essere solo uno dei seguenti:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Informazioni su un progetto Dialogflow ES associato. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Informazioni su un progetto Dialogflow CX associato. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Informazioni sul webhook per un agente. Se un webhook è configurato a livello di agente, sostituirà il webhook a livello di partner.

IntegrationStatus

Stati di integrazione.

Enum
INTEGRATION_STATUS_UNSPECIFIED Lo stato di integrazione non è specificato.
ENABLED Funzione attivata.
DISABLED Disabilitata.

DialogflowEsIntegration

Informazioni su un agente Business Messages e sull'associazione del progetto Dialogflow ES.

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

string

Obbligatorio. L'ID progetto Dialogflow.

Non modificabili. Per modificare questo valore, devi eliminare il progetto Dialogflow da questo agente e poi creare una nuova integrazione.
autoResponseStatus

enum (AutoResponseStatus)

Obbligatorio. Se ENABLED, Business Messages invia automaticamente le risposte Dialogflow agli utenti.
dialogflowServiceAccountEmail

string

Solo output. L'account di servizio che deve essere configurato nel progetto Dialogflow con "Editor agente console Dialogflow" e "Client API Dialogflow" ruoli. Questa operazione è necessaria per fornire l'accesso all'API Dialogflow.
operationInfo

object (OperationInfo)

Solo output. Informazioni sullo stato operativo dell'integrazione di Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Knowledge base associate al progetto Dialogflow.

Facoltativo

AutoResponseStatus

Stato della risposta automatica di Dialogflow.

Enum
AUTO_RESPONSE_STATUS_UNSPECIFIED La risposta automatica non è specificata.
ENABLED Risposta automatica abilitata.
DISABLED La risposta automatica è disabilitata.

OperationInfo

Informazioni sull'operazione Dialogflow.

Rappresentazione JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Campi
operationName

string

Solo output. Il nome assegnato dal server (ID operazione), che è univoco soltanto all'interno dello stesso servizio che lo restituisce originariamente.
operationType

enum (OperationType)

Solo output. Tipo di operazione Dialogflow.
operationState

enum (OperationState)

Solo output. Stato dell'operazione Dialogflow.
error

object (Status)

Solo output. Risultato dell'errore, se presente.

OperationType

Tipi di operazioni Dialogflow.

Enum
OPERATION_TYPE_UNSPECIFIED Tipo non specificato.
ASSOCIATE_DIALOGFLOW Associa Dialogflow.
DISSOCIATE_DIALOGFLOW Dissocia Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Aggiungi il documento alla knowledge base.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Elimina il documento dalla knowledge base.

OperationState

Stati delle operazioni in Dialogflow.

Enum
OPERATION_STATE_UNSPECIFIED Stato non specificato.
PROCESSING Elaborazione…
COMPLETED Operazione completata.
FAILED Operazione non riuscita.

Stato

Il tipo Status definisce un modello di errore logico adatto a diversi ambienti di programmazione, tra cui API REST e API RPC. È utilizzato da gRPC. Ogni messaggio Status contiene tre dati: codice, messaggio di errore e dettagli dell'errore.

Per saperne di più su questo modello di errore e su come utilizzarlo, consulta la Guida alla progettazione dell'API.

Rappresentazione JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campi
code

integer

Il codice di stato, che deve essere un valore enum pari a google.rpc.Code.
message

string

Un messaggio di errore rivolto agli sviluppatori, che deve essere in inglese. Qualsiasi messaggio di errore rivolto agli utenti deve essere localizzato e inviato nel campo google.rpc.Status.details oppure deve essere localizzato dal client.
details[]

object

Un elenco di messaggi con i dettagli dell'errore. Le API possono utilizzare un insieme comune di tipi di messaggi.

Un oggetto che contiene campi di tipo arbitrario. Un campo aggiuntivo "@type" contiene un URI che identifica il tipo. Esempio: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Informazioni della knowledge base. Una knowledge base può avere più URL di domande frequenti.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Campi
name

string

Solo output. ID knowledge base.

Identificatore univoco restituito dal servizio Dialogflow dopo la creazione di una knowledge base. Se l'identificatore del brand è "1234", l'identificatore dell'agente è "5678", l'identificatore di integrazione è "9092" e l'identificatore della knowledge base è "1111", questo parametro si risolve in "brands/1234/agents/5678/integrations/9092/knowledgebases/1111".
displayName

string

Obbligatorio. Nome visualizzato della knowledge base.
documents[]

object (DialogflowDocument)

Documenti della knowledge base.

Facoltativo
updateTime

string (Timestamp format)

Solo output. Ora in cui la knowledge base è stata creata o aggiornata.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Un documento della knowledge base. Un documento può essere l'URL di un sito web o di un file CSV. Gli URL devono essere disponibili pubblicamente. I file CSV devono contenere una o più coppie di domanda/risposta, con una riga per ogni coppia.

Rappresentazione JSON 
{
  "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.
}
Campi
name

string

ID documento generato dal sistema.

Se l'identificatore del brand è "1234", l'identificatore dell'agente è "5678", l'identificatore di integrazione è "9092", l'identificatore della knowledge base è "1111" e l'identificatore del documento è "2222", questo parametro si risolve in "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/22".
displayName

string

Obbligatorio. Nome visualizzato di un documento delle domande frequenti.
updateTime

string (Timestamp format)

Solo output. Ora in cui il documento è stato creato/aggiornato.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Solo output. Le informazioni sull'operazione vengono compilate solo quando un documento viene aggiunto a una knowledge base esistente.
Campo unione content. Contenuti del documento. content può essere solo uno dei seguenti:
faqUrl

string

URL di un documento delle domande frequenti.
rawContent

string (bytes format)

I contenuti non elaborati del documento.

Una stringa con codifica base64.

DialogflowCxIntegration

Informazioni su un agente Business Messages e sull'associazione del progetto Dialogflow CX.

Rappresentazione JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Campi
dialogflowProjectId

string

Obbligatorio. L'ID progetto Dialogflow.

Non modificabili. Per modificare questo valore, devi eliminare il progetto Dialogflow da questo agente e poi creare una nuova integrazione.
dialogflowAgentId

string

Obbligatorio. L'ID agente Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Obbligatorio. Se ENABLED, Business Messages invia automaticamente le risposte Dialogflow agli utenti.
dialogflowServiceAccountEmail

string

Solo output. L'account di servizio che deve essere configurato nel progetto Dialogflow con "Editor agente console Dialogflow" e "Client API Dialogflow" ruoli. Questa operazione è necessaria per fornire l'accesso all'API Dialogflow.
operationInfo

object (OperationInfo)

Solo output. Informazioni sullo stato operativo dell'integrazione di Dialogflow.

AgentWebhookIntegration

Informazioni sul webhook per un agente Business Messages.

Rappresentazione JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
Campi
webhookUri

string

Obbligatorio. L'URL webhook a cui vengono recapitati i messaggi.
verificationToken

string

Solo input. Il token di verifica.

Metodi

create

 Crea un'integrazione.

delete

 Eliminare un'integrazione.

get

 Ottieni un'integrazione.

list

 Elenca le integrazioni.

patch

 Aggiorna un'integrazione.