Message AI Agent

Üzenet Küldése az AI Ügynöknek

A GPT4Business API lehetővé teszi az AI ügynökkel való interakciót POST kérés küldésével. Ezáltal üzeneteket küldhetsz, válaszokat fogadhatsz és még sok más lehetőséget kihasználhatsz.


API Végpont

Az alábbi URL-t kell használnod az API eléréséhez:

https://admin.gpt4business.ai/en/chatbot/api/v1/message/

Kérés Fejlécek

Az API használatához a következő fejléc mezőket kell megadni:

  • Content-Type: application/json

  • Authorization: Token <Your-API-Token>


Kérés Törzse (Request Body)

A kérés törzsének az alábbi paramétereket kell tartalmaznia:

  • chatbot_uuid (Típus: UUID, Kötelező)

    • Az AI chatbot egyedi azonosítója (UUID), amelyet a chatbot adatlapján találhatsz meg.

  • query (Típus: String, Kötelező)

    • A chatbot számára elküldendő üzenet/kérdés (max. 5000 karakter).

  • user_key (Típus: String, Kötelező)

    • Egyedi azonosító, amely megkülönbözteti a felhasználókat.

Példa API Kérésre

import requests

# API végpont
url = "https://admin.gpt4business.ai/en/chatbot/api/v1/message/"

# Kérés fejlécek
headers = {
    'Authorization': 'Token <YOUR-API-TOKEN>',
    'Content-Type': 'application/json'
}

# Kérés törzs adat
data = {
    "chatbot_uuid": "12345678-1234-5678-1234-567812345678",
    "query": "Your message/string here.",
    "user_key": "Your message/string here."
}

# API kérés küldése
response = requests.post(url, headers=headers, json=data)

# Válasz ellenőrzése
if response.status_code == 200:
    print("Válasz:", response.json().get('data'))
else:
    error_data = response.json()
    print("Hiba:", error_data.get('message', '') + error_data.get('error', ''))

Példa API Válaszra

{
    "message": "AI Agent successfully answered.",
    "data": {
        "answer": "If you have a specific question or need assistance with something, please let me know and I`ll be happy to help.",
        "chat_id": 634
    }
}

Hibakezelés

Az API hibás kérés esetén strukturált válaszokat küld. Fontos, hogy minden nem 200-as státuszkódot megfelelően kezelj.

Példa Hibás Kérésekre

Ha nincs megadva API token:

{
    "detail": "Authentication credentials were not provided."
}

Ha a paraméterek hibásak vagy hiányoznak:

{
    "message": "The provided parameters are not valid. Please check and try again.",
    "errors": {
        "chatbot_uuid": [
            "This field is required."
        ]
    }
}

📌 Megjegyzés: Győződj meg róla, hogy minden kötelező paramétert megadsz, és hogy az API tokent helyesen illeszted be a kérés fejlécébe.

Last updated

Was this helpful?