Ottieni lista Real Estate

L'API per il real estate di app.neoagent.co fornisce la funzionalità per ottenere una lista dei real estate inviando una richiesta POST all'endpoint /chat/Chatbot/RealEstateList.

warning

Attenzione: questa API è compatibile solo con i chatbot tradizionali e non è ancora compatibile con i chatbot basati su template.

Endpoint

URL della Richiesta: https://app.neoagent.co/chat/Chatbot/GetGoogleGoolgeSheetData
Metodo: POST

Headers richiesti

La richiesta API deve includere i seguenti header:

• chatrobot-sessionkey: <Your-Token> - stringa, obbligatoria - La chiave di sessione per autenticare la richiesta API (disponibile in Workspace -> Webhook API -> chatrobot-sessionkey)

Corpo della Richiesta

Il corpo della richiesta deve contenere i seguenti parametri:

{
// stringa, obbligatoria - ID del chatbot (disponibile nelle impostazioni del chatbot -> generale -> ID chatbot)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// stringa, facoltativa - Filtra le proprietà per nome della città
"CityName": "Los Angeles",
// stringa, facoltativa - Deve essere uno tra: [for_sale, for_rent]
"SaleType": "for_sale",
// stringa, facoltativa - Filtra le proprietà per numero MLS
"MLSNumber": "MLS123456",
// intero, facoltativo - Numero di pagina per l'impaginazione (predefinito: 1)
"PageNumber": 1,
// intero, facoltativo - Numero di elementi per pagina (predefinito: 20)
"PageSize": 20
}

Parametri

• SerialNumber - stringa, obbligatorio - ID del chatbot (disponibile nelle impostazioni del chatbot -> generale -> ID chatbot)
• CityName - stringa, facoltativo - Filtra le proprietà in base al nome della città
• SaleType - stringa, facoltativo - Deve essere uno tra: [for_sale, for_rent]
• MLSNumber - stringa, facoltativo - Filtra le proprietà in base al numero MLS
• PageNumber - intero, facoltativo - Numero di pagina per l'impaginazione (predefinito: 1)
• PageSize - intero, facoltativo - Numero di elementi per pagina (predefinito: 20)

Esempi di Richiesta

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 Angeles",
  "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 Angeles",
  "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 Angeles","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 Angeles",
  "SaleType": "for_sale",
  "PageNumber": 1,
  "PageSize": 20
}

Risposta

La risposta API sarà un oggetto JSON con la seguente struttura:

{
  // object - The response data
  "Data": {
    "List": [
      {
        "ID": 7459,
        "PropertyType": "Single Family Residential",
        "SaleType": "For Rent",
        "Status": "Active",
        "Images": "",
        "CurrencySymbol": "$",
        "Price": "80000.00",
        "State": "CA",
        "City": "Los Angeles",
        "Address": "123 Main St",
        "ZIP": "90001",
        "LATITUDE": 30.96,
        "LONGITUDE": -78.93,
        "Area": "Downtown",
        "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": "Beautiful property in prime location",
        "ExtensionColumn": "[{'Key':'Pool', 'value':'Yes'}]",
        "RentPrice": "80000.00",
        "SpaceType": "Entire place",
        "DepositFee": "5000.00",
        "SalePrice": "",
        "UnitAreaPrice": "",
        "ZestimatePrice": "",
        "HOAMonth": ""
      }
    ],
    "VirtualCount": 10
  },
  // string - API version
  "Version": "1.0.0",
  // boolean - Operation success status
  "Success": true,
  // integer - HTTP status code
  "Code": 200,
  // string - Error message if any
  "Message": ""
}

Gestione degli Errori

Se la richiesta fallisce, dovresti:

1. Controllare il codice di stato HTTP per errori a livello di rete
2. Esaminare i campi Code e Message nella risposta per errori a livello business
3. Il campo Message conterrà informazioni dettagliate sull'errore