Crea sesión de chat

La API de app.neoagent.co proporciona la funcionalidad para crear una nueva sesión de chat enviando una solicitud POST al endpoint /chat/Chatbot/GetSession.

Endpoint

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

Headers requeridos

La solicitud API debe incluir los siguientes headers:

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

Cuerpo de la Solicitud

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

{
// cadena, obligatorio - Identificador único (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
}

Parámetros

• serialNumber - cadena, obligatorio - Identificador único (ID) del chatbot

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/GetSession', {
  method: 'POST',
  headers: {
  "Authorization": "<Your-Secret-Key>",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
})
});

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

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/GetSession'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
}

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

cURL

curl 'https://app.neoagent.co/chat/Chatbot/GetSession' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763ccfxxx"}'

HTTP Raw

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

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx"
}

Respuesta

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

{
  "Data": {
    "SessionID": 123456
  },
  // cadena - versión de la 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 lo hay
  "Message": ""
}

Manejo de Errores

Si la solicitud falla, deberías:

1. Comprobar 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