Cita/Lead Data API

Esta API permite el envío de los datos de un lead o una cita adquirida enviando una solicitud POST al endpoint /chat/Chatbot/LeadList.

Endpoint

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

Encabezados 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 - Identificador único (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx",
// cadena, opcional - Fecha de inicio del filtrado (formato: AAAA-MM-DD) - La zona horaria es UTC.
"startTime": "2025-01-01",
// cadena, opcional - Fecha de fin del filtrado (formato: AAAA-MM-DD) - La zona horaria es UTC.
"endTime": "2025-02-01",
// entero, opcional - ID de sesión para filtrar conversaciones específicas
"sessionID": 1111
}

Parámetros

• serialNumber - cadena, obligatorio - Identificador único (ID) del chatbot
• startTime - cadena, opcional - Fecha de inicio del filtrado (formato: AAAA-MM-DD) - La zona horaria es UTC.
• endTime - cadena, opcional - Fecha de fin del filtrado (formato: AAAA-MM-DD) - La zona horaria es UTC.
• sessionID - entero, opcional - ID de sesión para filtrar conversaciones específicas

Ejemplos de Solicitud

JavaScript (Fetch API)

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

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

Python (Requests)

import requests
import json

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

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

cURL

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

HTTP Raw

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

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx",
  "startTime": "2025-01-01",
  "endTime": "2025-02-01"
}

Respuesta

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

{
  // array - Lista de leads y citas
  "Data": [
    {
      "Type": "Lead",
      "Name": "test",
      "Email": "test@qq.com",
      "PhoneNumber": "",
      "CreateTime": "2023-11-23T18:36:21.512302-08:00",
      "Content": "test",
      "SessionID": 31305,
      "URI": "www.xxx.com",
      "Count": 2
    },
    {
      "Type": "Appointment",
      "Name": "test444",
      "Email": "test444@qq.com",
      "PhoneNumber": "",
      "CreateTime": "2023-11-21T19:13:44.054019-08:00",
      "Content": "Please share anything",
      "SessionID": 31313,
      "URI": "www.xxx.com",
      "Count": 2
    }
  ],
  // 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, debes:

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