Obtén lista de Bienes Raíces

La API para bienes raíces de app.neoagent.co proporciona la funcionalidad para obtener una lista de bienes raíces enviando una solicitud POST al endpoint /chat/Chatbot/RealEstateList.

aviso

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

Endpoint

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

Headers requeridos

La solicitud API debe incluir los siguientes encabezados:

• chatrobot-sessionkey: <Your-Token> - string, obligatorio - La clave de sesión para autenticar la solicitud API (disponible en Workspace -> Webhook API -> chatrobot-sessionkey)

Cuerpo de la Solicitud

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

{
// string, obligatorio - ID del chatbot (disponible en la configuración del chatbot -> general -> ID del chatbot)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// string, opcional - Filtra las propiedades por nombre de ciudad
"CityName": "Los Ángeles",
// string, opcional - Debe ser uno entre: [for_sale, for_rent]
"SaleType": "for_sale",
// string, opcional - Filtra las propiedades por número MLS
"MLSNumber": "MLS123456",
// entero, opcional - Número de página para la paginación (predeterminado: 1)
"PageNumber": 1,
// entero, opcional - Número de elementos por página (predeterminado: 20)
"PageSize": 20
}

Parámetros

• SerialNumber - string, obligatorio - ID del chatbot (disponible en la configuración del chatbot -> general -> ID del chatbot)
• CityName - string, opcional - Filtra las propiedades según el nombre de la ciudad
• SaleType - string, opcional - Debe ser uno entre: [for_sale, for_rent]
• MLSNumber - string, opcional - Filtra las propiedades según el número MLS
• PageNumber - entero, opcional - Número de página para la paginación (predeterminado: 1)
• PageSize - entero, opcional - Número de elementos por página (predeterminado: 20)

Ejemplos de Solicitud

JavaScript (Fetch API)

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateList', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Ángeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
})
});

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

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/RealEstateList'
headers = {
    "chatrobot-sessionkey": "<Your-Session-Key>"
}
data = {
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Ángeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
}

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

cURL

curl 'https://app.neoagent.co/chat/Chatbot/RealEstateList' \
  -X POST \
  -H 'chatrobot-sessionkey: <Your-Session-Key>' \
  -d '{"SerialNumber":"3254a9d0424c4806b9ea3d0763xxxxxx","CityName":"Los Ángeles","SaleType":"for_sale","PageNumber":1,"PageSize":20}'

HTTP Raw

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

{
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "CityName": "Los Ángeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
}

Respuesta

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

{
  // objeto - Los datos de respuesta
  "Data": {
    "List": [
      {
        "ID": 7459,
        "PropertyType": "Residencial Unifamiliar",
        "SaleType": "En Renta",
        "Status": "Activo",
        "Images": "",
        "CurrencySymbol": "$",
        "Price": "80000.00",
        "State": "CA",
        "City": "Los Ángeles",
        "Address": "123 Main St",
        "ZIP": "90001",
        "LATITUDE": 30.96,
        "LONGITUDE": -78.93,
        "Area": "Centro",
        "Bathrooms": "4",
        "Bedrooms": "4",
        "Url": "https://example.com/property/123",
        "Tours": "3D",
        "YearBuilt": "2020",
        "MLSNumber": "MLS123456",
        "DaysOnMarket": "20",
        "LotArea": "800",
        "BuildingArea": "2500",
        "ParkingSpots": "8",
        "Description": "Hermosa propiedad en ubicación privilegiada",
        "ExtensionColumn": "[{'Key':'Pool', 'value':'Sí'}]",
        "RentPrice": "80000.00",
        "SpaceType": "Toda la propiedad",
        "DepositFee": "5000.00",
        "SalePrice": "",
        "UnitAreaPrice": "",
        "ZestimatePrice": "",
        "HOAMonth": ""
      }
    ],
    "VirtualCount": 10
  },
  // string - 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,
  // string - mensaje de error si lo hay
  "Message": ""
}

Manejo de Errores

Si la solicitud falla, debes:

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