REST Resource: brands.agents.integrations

Recurso: Integración

Información sobre la integración.

Representación 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.
}
Campos
name

string

Solo salida. Es el identificador único de la integración. Solo lectura. Lo define la plataforma.
status

enum (IntegrationStatus)

Solo salida. Estado de integración
Campo de unión integration_info. Información detallada sobre la integración. Las direcciones (integration_info) solo pueden ser una de las siguientes opciones:
dialogflowEsIntegration

object (DialogflowEsIntegration)

Información sobre un proyecto de Dialogflow ES asociado. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

Información sobre un proyecto de Dialogflow CX asociado. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

Información sobre webhook para un agente. Si se configura un webhook a nivel de agente, este anulará el webhook a nivel de socio.

IntegrationStatus

Estados de integración

Enumeradores
INTEGRATION_STATUS_UNSPECIFIED No se especificó el estado de la integración.
ENABLED Habilitada.
DISABLED Inhabilitada.

DialogflowEsIntegration

Información sobre un agente de Business Messages y la asociación de proyectos de Dialogflow ES.

Representación JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
Campos
dialogflowProjectId

string

Obligatorio. El ID del proyecto de Dialogflow.

No se puede modificar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una integración nueva.
autoResponseStatus

enum (AutoResponseStatus)

Obligatorio. Si es ENABLED, Business Messages envía automáticamente las respuestas de Dialogflow a los usuarios.
dialogflowServiceAccountEmail

string

Solo salida. La cuenta de servicio que se debe configurar en el proyecto de Dialogflow con los roles “Editor del agente en la consola de Dialogflow” y “Cliente de la API de Dialogflow”. Esto es necesario para proporcionar acceso a la API de Dialogflow.
operationInfo

object (OperationInfo)

Solo salida. Información sobre el estado operativo de la integración de Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Bases de conocimiento asociadas con el proyecto de Dialogflow.

Opcional

AutoResponseStatus

Estado de respuesta automática de Dialogflow.

Enumeradores
AUTO_RESPONSE_STATUS_UNSPECIFIED La respuesta automática no está especificada.
ENABLED La respuesta automática está habilitada.
DISABLED La respuesta automática está inhabilitada.

OperationInfo

La información de la operación de Dialogflow.

Representación JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
Campos
operationName

string

Solo salida. El nombre asignado por el servidor (ID de operación), que solo es único dentro del mismo servicio que lo muestra originalmente.
operationType

enum (OperationType)

Solo salida. Tipo de operación de Dialogflow.
operationState

enum (OperationState)

Solo salida. Estado de la operación de Dialogflow.
error

object (Status)

Solo salida. Resultado del error, si existe.

OperationType

Tipos de operaciones de Dialogflow.

Enumeradores
OPERATION_TYPE_UNSPECIFIED Tipo no especificado
ASSOCIATE_DIALOGFLOW Asociar Dialogflow
DISSOCIATE_DIALOGFLOW Desasociar Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE Agregar documento a la base de conocimiento.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE Borrar documento de la base de conocimiento

OperationState

Estados de la operación en Dialogflow.

Enumeradores
OPERATION_STATE_UNSPECIFIED Estado sin especificar.
PROCESSING Procesando.
COMPLETED Se completó.
FAILED Se produjo un error.

Estado

El tipo de Status define un modelo de error lógico que es adecuado para entornos de programación diferentes, incluidas las API de REST y las API de RPC. Lo usa gRPC. Cada mensaje Status contiene tres datos: código de error, mensaje de error y detalles del error.

Puedes obtener más información sobre este modelo de error y cómo trabajar con él en la guía de diseño de API.

Representación JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

El código de estado, que debe ser un valor enum de google.rpc.Code.
message

string

Un mensaje de error dirigido al desarrollador, que debe estar en inglés. Cualquier mensaje de error dirigido al usuario debe localizarse y enviarse al campo google.rpc.Status.details; o el cliente debe localizarlo.
details[]

object

Una lista de mensajes que contienen los detalles del error. Hay un conjunto común de tipos de mensajes para que usen las API.

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

Información de la base de conocimiento. Una base de conocimiento puede tener varias URLs de preguntas frecuentes.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
Campos
name

string

Solo salida. ID de la base de conocimiento

Identificador único que muestra el servicio de Dialogflow después de crear una base de conocimiento. Si el identificador de marca es "1234", el identificador del agente es "5678", el identificador de integración es "9092" y el identificador de la base de conocimiento es "1111", este parámetro se resuelve como "brands/1234/agents/5678/integrates/9092/knowledgebases/1111".
displayName

string

Obligatorio. Es el nombre visible de la base de conocimiento.
documents[]

object (DialogflowDocument)

Documentos de la base de conocimiento.

Opcional
updateTime

string (Timestamp format)

Solo salida. Hora en la que se creó o actualizó la base de conocimiento.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

DialogflowDocument

Un documento de base de conocimiento Un documento puede ser una URL de sitio web o una URL que dirige a un archivo CSV. Las URLs deben estar disponibles públicamente. Los archivos CSV deben contener uno o más pares de preguntas y respuestas, con una fila para cada par.

Representación 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.
}
Campos
name

string

ID de documento generado por el sistema.

Si el identificador de marca es "1234", el identificador del agente es "5678", el identificador de integración es "9092", el identificador de la base de conocimiento es "1111" y el identificador de documento es "2222" y este parámetro se resuelve como "brands/1234/agents/5678/integrations/9092/knowledgebases/1112/documents/2".
displayName

string

Obligatorio. Es el nombre visible de un documento de Preguntas frecuentes.
updateTime

string (Timestamp format)

Solo salida. Hora a la que se creó o actualizó el documento

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

Solo salida. La información de la operación se propaga solo cuando se agrega un documento a una base de conocimiento existente.
Campo de unión content. Contenido del documento. Las direcciones (content) solo pueden ser una de las siguientes opciones:
faqUrl

string

URL de un documento de Preguntas frecuentes.
rawContent

string (bytes format)

Es el contenido sin procesar del documento.

String codificada en base64.

DialogflowCxIntegration

Información sobre la asociación de un agente de Business Messages y un proyecto de Dialogflow CX.

Representación JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
Campos
dialogflowProjectId

string

Obligatorio. El ID del proyecto de Dialogflow.

No se puede modificar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una integración nueva.
dialogflowAgentId

string

Obligatorio. El ID de agente de Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

Obligatorio. Si es ENABLED, Business Messages envía automáticamente las respuestas de Dialogflow a los usuarios.
dialogflowServiceAccountEmail

string

Solo salida. La cuenta de servicio que se debe configurar en el proyecto de Dialogflow con los roles “Editor del agente en la consola de Dialogflow” y “Cliente de la API de Dialogflow”. Esto es necesario para proporcionar acceso a la API de Dialogflow.
operationInfo

object (OperationInfo)

Solo salida. Información sobre el estado operativo de la integración de Dialogflow.

AgentWebhookIntegration

Información sobre el webhook para un agente de Business Messages.

Representación JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
Campos
webhookUri

string

Obligatorio. La URL de webhook a la que se entregan los mensajes.
verificationToken

string

Solo entrada. El token de verificación

Métodos

create

 Crea una integración.

delete

 Borra una integración.

get

 Obtén una integración.

list

 Haz una lista de integraciones.

patch

 Actualiza una integración.