Bot API se basa en REST. Puede llamar a nuestras APIs a través de una petición HTTP estándar con su clave api colocada en el parámetro de consulta. A su vez, WOZTELL devolverá una respuesta codificada en JSON, con los datos correspondientes que pueden determinar si las operaciones relacionadas se han completado.

Si su navegador no puede descargar los archivos JSON después de hacer clic en la URL...

Haga clic con el botón derecho del ratón y seleccione "Inspeccionar" para abrir las herramientas de desarrollo. Selecciona "Fuente" y haz clic con el botón derecho para descargar el archivo fuente mediante "Guardar como...".

Autenticación

Código de acceso

El token de acceso debe colocarse como parámetro de consulta como accessToken en la solicitud. El token de acceso puede generarse siguiendo esta guía.

Cada API puede tener un ámbito de aplicación diferente, pero basta con elegir uno para llamar a la API.

CONSEJO

Alternativamente, el token de acceso también se puede poner en la cabecera de autorización como token portador.

Envía respuestas

Para enviar respuestas en nombre de su chatbot a un miembro específico en WOZTELL.

Generar plantilla en JSON

WOZTELL le permite crear y gestionar plantillas de mensajes en la plataforma. Al enviar respuestas con Bot API, existe una forma cómoda de obtener el contenido de una plantilla en JSON.

1. En "Recursos", seleccione "Respuestas".

2. Seleccione "+ Nueva respuesta".

3. Despliega la pestaña. Seleccione "Añadir plataforma" y seleccione "WhatsApp Cloud". Esto le permitirá aplicar tipos de mensajes específicos de WhatsApp Cloud.

4. Seleccione "Plantilla de mensaje" entre los tipos de mensaje.

5. Seleccione la "Integración" correspondiente y haga clic en "Actualizar plantilla de mensaje".

6. Elija la "Plantilla de mensaje" que desee utilizar. A continuación, seleccione la "Política lingüística" y el "Idioma" correspondientes.

7. Rellene los componentes necesarios de la plantilla, por ejemplo, imágenes y parámetros. Haga clic en "Confirmar" para salir de esta ventana.

8. En la respuesta, cambie a "Avanzado" para obtener el contenido de la plantilla en JSON.

Solicitar

Autorizaciones: accessToken(bot:sendResponses, bot:admin)

Parámetros de consulta:

Esquema del cuerpo de la solicitud: application/json

Solicitud de muestras

• Tipo de contenido: application/json

{
  "channelId": "5fe729b3094223123123",
  "recipientId": "85291239123",
  "response": [
    {
      "type": "TEMPLATE",
      "elementName": "testing",
      "languageCode": "zh_CN",
      "components": [
        {
          "type": "header",
          "parameters": [
            {
              "type": "video",
              "video": {
                "id": "caf8bc1a-fbc0-4dc3-9d08-434sdf6df"
              }
            }
          ]
        },
        {
          "type": "button",
          "sub_type": "quick_reply",
          "index": "0",
          "parameters": [
            {
              "type": "payload",
              "payload": "123"
            }
          ]
        }
      ]
    }
  ]
}

Respuesta

Cuerpo de la respuesta Esquema: application/json

Esquema del cuerpo de la respuesta: application/json

Muestra de respuesta

1. Código de estados: 200
   
2. Tipo de contenido: application/json
   

{
  "ok": 1,
  "member": "5ece50f3bf385b25c4e08db5",
  "sendResult": {
    "ok": 1,
    "member": "5ece50f3bf385b25c4e08db5",
    "result": [
      {
        "result": {
          "messages": [
            {
              "id": "gBGGhSZphigfAglySd38a9T4jAE"
            }
          ],
          "meta": {
            "api_status": "stable",
            "version": "2.31.5"
          }
        },
        "messageEvent": {
          "from": 85291239123,
          "to": 85232193219,
          "data": {
            "text": "Hello World"
          },
          "type": "TEXT",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZphigfAglySd38a9T4jAE"
        },
        "chatId": "5ece50f3bfa915g5c4e08db5"
      },
      {
        "result": {
          "messages": [
            {
              "id": "gBGGhSZafi5th8lySd38a9T4jAE"
            }
          ],
          "meta": {
            "api_status": "stable",
            "version": "2.31.5"
          }
        },
        "messageEvent": {
          "from": 85291239123,
          "to": 85232193219,
          "data": {
            "url": "https://miro.medium.com/max/1200/1*mk1-6aYaf_Bes1E3Imhc0A.jpeg"
          },
          "type": "IMAGE",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZafi5th8lySd38a9T4jAE"
        },
        "chatId": "5ece50f3bfa915g5c4e08db6"
      }
    ]
  }
}

• Código de estados: 500
• Tipo de contenido: application/json

{
  "ok": 0,
  "err": "User is not authorized."
}

Redirigir miembro a nodo

Redirigir un miembro a un nodo específico del árbol y ejecutar todos o parte de los componentes del nodo. Esto es útil para realizar operaciones complejas en un miembro y mantener toda la lógica del bot en el árbol en lugar de codificarla en una api.

Si no se proporciona memberId, el sistema buscará un miembro con el recipientId proporcionado.

Meta objeto

Para utilizar el objeto meta pasado por la API en la respuesta de transformación o en las acciones del nodo objetivo, utilice el siguiente código para acceder a su meta.

this.agendaMeta

Ejemplo:

return new Promise((resolve, reject) => {
  // ...
  const name = this.agendaMeta.name // "Sanuker"
  const orderId = this.agendaMeta.orderId // "5ecf6be76fcfda6b139d802c"
  // ...
})

Solicitar

Correo electrónico https://bot.api.woztell.com/redirectMemberToNode

Autorizaciones: accessToken(bot:redirectMemberToNode, bot:admin, api:admin)

Parámetro de consulta:

Request Body Schema: application/json

Solicitud de muestra 

Tipo de contenido: application/json

{
  "channelId": "5ece50e72efaabd58ef55027",
  "memberId": "5ece50f3bf385b25c4e08db5",
  "recipientId": null,
  "redirect": {
    "tree": "5ecf6cfba3b6643c33a64079",
    "nodeCompositeId": "j4Bivxm0GWhnNV1m",
    "runPreAction": true,
    "sendResponse": true,
    "runPostAction": true
  },
  "meta": {
    "name": "Sanuker",
    "orderId": "5ecf6be76fcfda6b139d802c"
  }
}

Respuesta

Esquema del cuerpo de la respuesta: application/json

Solicitud de muestra

• Estado de código: 200
• Contenido: application/json

{
  "ok": 1,
  "member": "5ece50f3bf385b25c4e08db5",
  "sendResult": {
    "ok": 1,
    "member": "5ece50f3bf385b25c4e08db5",
    "result": [
      {
        "ok": 1,
        "messageEvent": {
          "from": 85291239123,
          "to": 85232193219,
          "data": {
            "text": "Hello World"
          },
          "type": "TEXT",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZphigfAglySd38a9T4jAE"
        }
      },
      {
        "ok": 1,
        "messageEvent": {
          "from": 85291239123,
          "to": 85232193219,
          "data": {
            "url": "https://miro.medium.com/max/1200/1*mk1-6aYaf_Bes1E3Imhc0A.jpeg"
          },
          "type": "IMAGE",
          "timestamp": 1611900841740,
          "messageId": "gBGGhSZafi5th8lySd38a9T4jAE"
        }
      }
    ]
  }
}

• Estado de código: 500
• Contenido application/json

{
  "ok": 0,
  "err_code": 108,
  "err": "channelId is required."
}

Error de Códigos

WOZTELL devolverá los códigos de error correspondientes a la solicitud cuando se produzca un error.