Crea un chatbot

La API de Creación de app.neoagent.co proporciona la funcionalidad para crear un nuevo chatbot enviando una solicitud POST al endpoint /chat/Chatbot/Add.

Endpoint

URL de la Solicitud: https://app.neoagent.co/chat/Chatbot/Add
Método: POST

Headers requeridos

La solicitud API debe incluir los siguientes encabezados:

• Authorization: <Your-Secret-Key> - cadena, obligatorio - La clave secreta para autenticar la solicitud API
• Content-Type: application/json - cadena, obligatorio - El tipo de contenido del payload de la solicitud (debe ser application/json)

Cuerpo de la Solicitud

El cuerpo de la solicitud debe contener los siguientes parámetros:

{
  // cadena, obligatorio - La zona horaria del chatbot (ej., Asia/Shanghai, América/Nueva_York)
  "timeZone": "Asia/Shanghai",
  // entero, obligatorio - Debe ser 0 para un chatbot genérico
  "type": 0
}

Parámetros

• timeZone - cadena, obligatorio - La zona horaria del chatbot (ej., Asia/Shanghai, América/Nueva_York)
• type - entero, obligatorio - Debe ser 0 para un chatbot genérico

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/Add', {
  method: 'POST',
  headers: {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "timeZone": "Asia/Shanghai",
    "type": 0
  })
});

const data = await res.json();
console.log(data);

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/Add'
headers = {
  "Authorization": "<Your-Secret-Key>",
  "Content-Type": "application/json"
}
data = {
  "timeZone": "Asia/Shanghai",
  "type": 0
}

response = requests.post(url, headers=headers, json=data)
data = response.json()
print(data)

cURL

curl 'https://app.neoagent.co/chat/Chatbot/Add' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"timeZone":"Asia/Shanghai","type":0}'

HTTP Raw

POST /chat/Chatbot/Add HTTP/1.1
Host: app.neoagent.co
Authorization: <Your-Secret-Key>
Content-Type: application/json

{
  "timeZone": "Asia/Shanghai",
  "type": 0
}

Respuesta

La respuesta API será un objeto JSON con la siguiente estructura:

{
  // cadena - El identificador único (ID) del chatbot creado
  "Data": "3254a9d0424c4806b9ea3d0763xxxxxx",
  // cadena - Versión API
  "Version": "1.0.0",
  // booleano - Estado de éxito de la operación
  "Success": true,
  // entero - Código de estado HTTP
  "Code": 200,
  // cadena - Mensaje de error si está presente
  "Message": ""
}

Manejo de Errores

Si la solicitud falla, debes:

1. Verificar el código de estado HTTP para errores a nivel de red
2. Examinar los campos Code y Message en la respuesta para errores a nivel de negocio
3. El campo Message contendrá información detallada sobre el error

Importante

Asegúrate de reemplazar <Your-Secret-Key> con tu clave API válida.

Próximos Pasos

Después de crear el chatbot, puedes:

• Probar el chatbot con un chat