Modifica un chatbot

L'API app.neoagent.co consente di aggiornare la configurazione di un chatbot specifico inviando una richiesta POST all'endpoint /chat/Chatbot/Edit.

Endpoint

URL della Richiesta: https://app.neoagent.co/chat/Chatbot/Edit
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 - Identificatore univoco (ID) del chatbot
"serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx",
// stringa, facoltativa - Nuovo nome per il chatbot
"Name": "NewName",
// stringa, facoltativa - ID del modello AI, puoi chiamare l'interfaccia Ottieni elenco modelli per ottenerlo
"Model": "2",
// stringa, facoltativa - Prompt di sistema per il chatbot
"SystemMessage": "new Prompt",
// intero, facoltativo - Impostazione della temperatura per le risposte
"Temperature": 0,
// stringa, facoltativa - Impostazione del fuso orario
"TimeZone": "Asia/Shanghai",
// stringa, facoltativa - Testo da aggiungere alle risposte
"AnswerSuffix": "Asia/Shanghai",
// stringa, facoltativa - ID file per l'immagine del profilo
"ChatProfilePicture": "34327",
// stringa, facoltativa - ID file per icona a fumetto
"ChatIcon": "34327",
// intero, facoltativo - Allineamento del fumetto della chat
"ChatBubbleAlign": 0,
// stringa, facoltativo - Colore del fumetto della chat (formato RGB)
"ChatBubbleColor": "rgb(37,99,235)",
// booleano, facoltativo - Se mostrare il popup una sola volta
"ChatbotPopupOnce": true,
// stringa, facoltativo - Descrizione dell'informativa sulla privacy
"ChatbotPrivacyPolicyDescription": "",
// stringa, facoltativo - Nome dell'informativa sulla privacy
"ChatbotPrivacyPolicyName": "informativa sulla privacy",
// stringa, facoltativo - URL dell'informativa sulla privacy
"ChatbotPrivacyPolicyUrl": "",
// booleano, facoltativo - Abilita la funzionalità push-to-talk
"EnablePushToTalk": false,
// booleano, facoltativo - Abilita la funzionalità di caricamento immagini
"EnableUploadImage": false,
// stringa, facoltativa - URL della pagina Facebook
"FacebookUrl": "",
// stringa, facoltativa - URL del profilo Instagram
"InstagramUrl": "",
// booleano, facoltativa - Cancella la cronologia chat alla chiusura del browser
"RemoveChatLogOnBrowserClose": false,
// stringa, facoltativa - Messaggi suggeriti
"SuggestedMessage": "",
// stringa, facoltativa - Email per il passaggio di consegne
"TalkToHumanEmail": "",
// stringa, facoltativa - Messaggio per il trasferimento a un utente
"TalkToHumanResponseMessage": "",
// stringa, facoltativa - Testo segnaposto per il campo di input
"UserInputPlaceholder": "",
// stringa, facoltativa - Colore dei messaggi utente (formato RGB)
"UserMessageColor": "rgb(59, 129, 246)",
// stringa, facoltativa - Messaggio di benvenuto iniziale
"WelcomeMessage": "Ciao, sono il tuo assistente AI! Come posso aiutarti?",
// stringa, facoltativa - URL del contatto WhatsApp
"WhatsappUrl": "",
// booleano, facoltativo - Abilita la verifica del dominio
"VerifyDomain": false,
// stringa, facoltativa - Domini consentiti per l'incorporamento
"Domains": "",
// intero, facoltativo - Numero massimo di messaggi consentiti
"RateLimitCount": 20,
// stringa, facoltativo - Messaggio con limite di frequenza superato
"RateLimitMessage": "Troppi messaggi consecutivi",
// intero, facoltativo - Durata del limite di frequenza in secondi
"RateLimitTime": 240,
// stringa, facoltativo - Dominio personalizzato per l'incorporamento
"CustomDomain": "",
// stringa, facoltativo - Email per i registri delle chat giornaliere
"EmailForDailyChatLogs": "",
// stringa, facoltativo - Email per i lead giornalieri
"EmailForDailyLeads": "",
// stringa, facoltativo - Lingua per le risposte dell'IA (utilizzare il nome completo della lingua, ad esempio ('Inglese', 'Spagnolo', 'Francese')
"AIResponseLanguage": "",
// intero, facoltativo - Numero massimo di messaggi consentiti ogni mese (il valore predefinito è -1, che significa illimitato)
"MessageLimit": -1
}

Parametri

• serialNumber - stringa, obbligatoria - Identificatore univoco (ID) del chatbot
• Name - stringa, facoltativa - Nuovo nome per il chatbot
• Model - stringa, facoltativa - ID del modello AI, è possibile richiamare l'interfaccia Get Model List per ottenerlo
• SystemMessage - stringa, facoltativa - Prompt di sistema per il chatbot
• Temperature - intero, facoltativo - Impostazione della temperatura per le risposte
• TimeZone - stringa, facoltativa - Impostazione del fuso orario
• AnswerSuffix - stringa, facoltativa - Testo da aggiungere alle risposte
• ChatProfilePicture - stringa, facoltativa - ID file per l'immagine del profilo
• ChatIcon - stringa, facoltativa - ID file per l'icona a fumetto
• ChatBubbleAlign - intero, facoltativo - Allineamento del fumetto della chat
• ChatBubbleColor - stringa, facoltativa - Colore del fumetto della chat (formato RGB)
• ChatbotPopupOnce - booleano, facoltativo - Indica se mostrare il popup una sola volta
• ChatbotPrivacyPolicyDescription - stringa, facoltativa - Descrizione dell'informativa sulla privacy
• ChatbotPrivacyPolicyName - stringa, facoltativa - Nome dell'informativa sulla privacy
• ChatbotPrivacyPolicyUrl - stringa, facoltativa - URL dell'informativa sulla privacy
• EnablePushToTalk - booleano, facoltativo - Abilita la funzionalità push-to-talk
• EnableUploadImage - booleano, facoltativo - Abilita la funzionalità di caricamento immagini
• FacebookUrl - stringa, facoltativa - URL della pagina Facebook
• InstagramUrl - stringa, facoltativa - URL del profilo Instagram
• RemoveChatLogOnBrowserClose - booleano, facoltativo - Cancella la cronologia chat alla chiusura del browser
• SuggestedMessage - stringa, facoltativa - Messaggi suggeriti
• TalkToHumanEmail - stringa, facoltativa - Email per il passaggio di consegne a un utente
• TalkToHumanResponseMessage - stringa, facoltativa - Messaggio per il trasferimento a un utente
• UserInputPlaceholder - stringa, facoltativa - Testo segnaposto per il campo di input
• UserMessageColor - stringa, facoltativa - Colore dei messaggi utente (formato RGB)
• WelcomeMessage - stringa, facoltativa - Messaggio di benvenuto iniziale
• WhatsappUrl - stringa, facoltativa - URL del contatto WhatsApp
• VerifyDomain - booleano, facoltativo - Abilita la verifica del dominio
• Domains - stringa, facoltativa - Domini consentiti per l'incorporamento
• RateLimitCount - intero, facoltativo - Numero massimo di messaggi consentiti
• RateLimitMessage - stringa, facoltativo - Messaggio di superamento del limite di frequenza
• RateLimitTime - intero, facoltativo - Durata del limite di frequenza in secondi
• CustomDomain - stringa, facoltativo - Dominio personalizzato per l'incorporamento
• EmailForDailyChatLogs - stringa, facoltativo - Email per i log delle chat giornaliere
• EmailForDailyLeads - stringa, facoltativo - Email per i lead giornalieri
• AIResponseLanguage - stringa, facoltativo - Lingua per le risposte AI (utilizzare il nome completo della lingua, ad esempio "Inglese", "Spagnolo", "Francese")
• MessageLimit - intero, facoltativo - Numero massimo di messaggi consentiti per ogni mese (il valore predefinito è -1, che significa illimitato)

Esempi di Richiesta

JavaScript (Fetch API)

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

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

Python (Requests)

import requests
import json

url = 'https://app.neoagent.co/chat/Chatbot/Edit'
headers = {
    "Authorization": "<Your-Secret-Key>",
    "Content-Type": "application/json"
}
data = {
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx",
  "Name": "NewName"
}

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

cURL

curl 'https://app.neoagent.co/chat/Chatbot/Edit' \
  -X POST \
  -H 'Authorization: <Your-Secret-Key>' \
  -H 'Content-Type: application/json' \
  -d '{"serialNumber":"3254a9d0424c4806b9ea3d0763ccfxxx","Name":"NewName"}'

HTTP Raw

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

{
  "serialNumber": "3254a9d0424c4806b9ea3d0763ccfxxx",
  "Name": "NewName"
}

Risposta

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

{
  // integer - Operation result (1 indicates success)
  "Data": 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 Codice e Messaggio nella risposta per errori a livello aziendale
3. Il campo Messaggio conterrà informazioni dettagliate sull'errore