Elimina Bienes Raíces

La API para bienes raíces de app.neoagent.co proporciona la funcionalidad para eliminar un bien raíz enviando una solicitud POST al endpoint /chat/Chatbot/RealEstateDelete.

aviso

Atención: esta API es compatible solo con los chatbots tradicionales y aún no es compatible con los chatbots basados en plantillas.

Endpoint

URL de la Solicitud: https://app.neoagent.co/chat/Chatbot/RealEstateDelete
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, obligatoria - ID del chatbot (disponible en la configuración del chatbot -> general -> ID chatbot)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// array, obligatorio - Array de identificadores de propiedades a eliminar
"Keys": [
"PROP123456",
"PROP789012"
],
// cadena, obligatoria - Debe ser uno entre: [NewOaks, MLSNumber, URL]
"KeyType": "NewOaks"
}

Parámetros

• serialNumber - cadena, obligatorio - Identificador único (ID) del chatbot
• rows - array de objetos, obligatorio - Lista de datos de Google Sheet. //En cada elemento de fila, campos como URL, nombre, nombre del producto y precio son campos personalizados dinámicos. //Sus definiciones y valores son determinados por el usuario y pueden modificarse según requisitos específicos.

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateDelete', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "Keys": [
    "PROP123456"
  ],
  "KeyType": "NewOaks"
})
});

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

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/RealEstateDelete'
headers = {
    "chatrobot-sessionkey": "<Your-Session-Key>"
}
data = {
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "Keys": [
    "PROP123456"
  ],
  "KeyType": "NewOaks"
}

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

cURL

curl 'https://app.neoagent.co/chat/Chatbot/RealEstateDelete' \
  -X POST \
  -H 'chatrobot-sessionkey: <Your-Session-Key>' \
  -d '{"SerialNumber":"3254a9d0424c4806b9ea3d0763xxxxxx","Keys":["PROP123456"],"KeyType":"NewOaks"}'

HTTP Raw

POST /chat/Chatbot/RealEstateDelete HTTP/1.1
Host: app.neoagent.co
chatrobot-sessionkey: <Your-Session-Key>

{
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "Keys": [
    "PROP123456"
  ],
  "KeyType": "NewOaks"
}

Respuesta

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

{
  // objeto - El resultado de la eliminación
  "Data": {
    "SuccessCount": 1
  },
  // 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. Verificar 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