Elimina Real Estate

L'API per il real estate di app.neoagent.co fornisce la funzionalità per eliminare un real estate inviando una richiesta POST all'endpoint /chat/Chatbot/RealEstateDelete.

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/RealEstateDelete
Metodo: POST

Headers richiesti

La richiesta API deve includere i seguenti header:

• Authorization: <Your-Secret-Key> - string, obbligatorio - La chiave segreta per autenticare la richiesta API
• Content-Type: application/json - string, obbligatorio - Il tipo di contenuto del payload della richiesta (deve essere application/json)

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",
// array, obbligatoria - Array di identificatori di proprietà da eliminare
"Keys": [
"PROP123456",
"PROP789012"
],
// stringa, obbligatoria - Deve essere uno tra: [NewOaks, MLSNumber, URL]
"KeyType": "NewOaks"
}

Parametri

• serialNumber - stringa, obbligatorio - Identificatore univoco (ID) del chatbot
• rows - array di oggetti, obbligatorio - Elenco dei dati di Google Sheet. //In ogni elemento di riga, campi come URL, nome, nome prodotto e prezzo sono campi personalizzati dinamici. //Le loro definizioni e valori sono determinati dall'utente e possono essere modificati in base a requisiti specifici.

Esempi di Richiesta

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"
}

Risposta

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

{
  // object - The deletion result
  "Data": {
    "SuccessCount": 1
  },
  // 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