REST Resource: brands.agents.integrations

Recurso: Integration

Es información sobre la integración.

Representación JSON

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`. }

{
  "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. Es un valor definido por la plataforma.
`status`	`enum (IntegrationStatus)` Solo salida. Es el estado de la integración.
Campo de unión `integration_info`. Es la información detallada de la integración. Las direcciones (`integration_info`) solo pueden ser una de las siguientes opciones:
`dialogflowEsIntegration`	`object (DialogflowEsIntegration)` Es información sobre un proyecto asociado de Dialogflow ES. https://cloud.google.com/dialogflow/es/docs
`dialogflowCxIntegration`	`object (DialogflowCxIntegration)` Es información sobre un proyecto asociado de Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics
`agentWebhookIntegration`	`object (AgentWebhookIntegration)` Es la información sobre el webhook de un agente. Si se configura un webhook a nivel del agente, este anulará el webhook a nivel del socio.

IntegrationStatus

Son los estados de integración.

Enums
`INTEGRATION_STATUS_UNSPECIFIED`	El estado de integración no está especificado.
`ENABLED`	Habilitado
`DISABLED`	Inhabilitada

DialogflowEsIntegration

Es información sobre la asociación entre un agente de Business Messages y un proyecto de Dialogflow ES.

Representación JSON

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

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

Campos
`dialogflowProjectId`	`string` Obligatorio. ID del proyecto de Dialogflow No se puede editar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una nueva integración.
`autoResponseStatus`	`enum (AutoResponseStatus)` Obligatorio. Si es `ENABLED`, Mensajes de Negocios envía automáticamente las respuestas de Dialogflow a los usuarios.
`dialogflowServiceAccountEmail`	`string` Solo salida. Es 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. Es información sobre el estado operativo de la integración de Dialogflow.
`dialogflowKnowledgeBases[]`	`object (DialogflowKnowledgebase)` Son las bases de conocimiento asociadas con el proyecto de Dialogflow. Opcional

AutoResponseStatus

Es el estado de la respuesta automática de Dialogflow.

Enums
`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

Es 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. Es el nombre asignado por el servidor (ID de operación), que solo es único dentro del mismo servicio que lo muestra en un principio.
`operationType`	`enum (OperationType)` Solo salida. Es el tipo de operación de Dialogflow.
`operationState`	`enum (OperationState)` Solo salida. Es el estado de la operación de Dialogflow.
`error`	`object (Status)` Solo salida. Es el resultado del error, si corresponde.

OperationType

Son los tipos de operaciones de Dialogflow.

Enums
`OPERATION_TYPE_UNSPECIFIED`	Tipo no especificado
`ASSOCIATE_DIALOGFLOW`	Asocia Dialogflow.
`DISSOCIATE_DIALOGFLOW`	Desvincula Dialogflow.
`ADD_DOCUMENT_TO_KNOWLEDGEBASE`	Agrega el documento a la base de conocimiento.
`DELETE_DOCUMENT_FROM_KNOWLEDGEBASE`	Borra un documento de la base de conocimiento.

OperationState

Son los estados de la operación en Dialogflow.

Enums
`OPERATION_STATE_UNSPECIFIED`	Significa que el estado no se especificó.
`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

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

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

Es la 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. Es el identificador único que devuelve el servicio de Dialogflow después de crear una base de conocimiento. Si el identificador de la marca es "1234", el identificador del agente es "5678", el identificador de la integración es "9092" y el identificador de la base de conocimiento es "1111", este parámetro se resuelve como "brands/1234/agents/5678/integrations/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. Fecha y hora en que se creó o actualizó la base de conocimiento. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` o `"2014-10-02T15:01:23+05:30"`.

DialogflowDocument

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

Representación JSON

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`. }

{
  "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` Es el ID del documento generado por el sistema. Si el identificador de la marca es "1234", el identificador del agente es "5678", el identificador de la integración es "9092", el identificador de la base de conocimiento es "1111" y el identificador del documento es "2222", este parámetro se resuelve como "brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222".
`displayName`	`string` Obligatorio. Es el nombre visible de un documento de preguntas frecuentes.
`updateTime`	`string (Timestamp format)` Solo salida. Fecha y hora en que se creó o actualizó el documento. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` o `"2014-10-02T15:01:23+05:30"`.
`operationInfo`	`object (OperationInfo)` Solo salida. La información de la operación solo se propaga cuando se agrega un documento a una base de conocimiento existente.
Campo de unión `content`. Es el contenido del documento. Las direcciones (`content`) solo pueden ser una de las siguientes opciones:
`faqUrl`	`string` Es la URL de un documento de preguntas frecuentes.
`rawContent`	`string (bytes format)` Es el contenido sin procesar del documento. String codificada en base64.

DialogflowCxIntegration

Es información sobre la asociación entre un agente de Business Messages y un proyecto de Dialogflow CX.

Representación JSON

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

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

Campos
`dialogflowProjectId`	`string` Obligatorio. ID del proyecto de Dialogflow No se puede editar. Para cambiar este valor, debes borrar el proyecto de Dialogflow de este agente y, luego, crear una nueva integración.
`dialogflowAgentId`	`string` Obligatorio. Es el ID del agente de Dialogflow.
`autoResponseStatus`	`enum (AutoResponseStatus)` Obligatorio. Si es `ENABLED`, Mensajes de Negocios envía automáticamente las respuestas de Dialogflow a los usuarios.
`dialogflowServiceAccountEmail`	`string` Solo salida. Es 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. Es información sobre el estado operativo de la integración de Dialogflow.

AgentWebhookIntegration

Es la información sobre el webhook de un agente de Business Messages.

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

Campos

Campos
`webhookUri`	`string` Obligatorio. Es la URL de webhook en la que se entregan los mensajes.
`verificationToken`	`string` Solo entrada. Es el token de verificación.

webhookUri

string

Obligatorio. Es la URL de webhook en la que se entregan los mensajes.

verificationToken

string

Solo entrada. Es el token de verificación.

Métodos
`create`	Crea una integración.
`delete`	Borra una integración.
`get`	Obtener una integración
`list`	Enumera las integraciones.
`patch`	Actualiza una integración.

REST Resource: brands.agents.integrations

Recurso: Integration

IntegrationStatus

DialogflowEsIntegration

AutoResponseStatus

OperationInfo

OperationType

OperationState

Estado

DialogflowKnowledgebase

DialogflowDocument

DialogflowCxIntegration

AgentWebhookIntegration

Métodos

`create`

`delete`

`get`

`list`

`patch`

REST Resource: brands.agents.integrations Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: Integration

IntegrationStatus

DialogflowEsIntegration

AutoResponseStatus

OperationInfo

OperationType

OperationState

Estado

DialogflowKnowledgebase

DialogflowDocument

DialogflowCxIntegration

AgentWebhookIntegration

Métodos

create

delete

get

list

patch

REST Resource: brands.agents.integrations

`create`

`delete`

`get`

`list`

`patch`