Chat API-referens

Autentisering

Varje begäran autentiseras med din arbetsytas API-nyckel, som skickas i huvudet X-API-Key (eller som en api_key-parameter). Nycklar ser ut som ck_live_.... Behandla nyckeln som ett lösenord - vem som helst som har den kan skicka meddelanden som debiteras din arbetsyta. Rotera den när som helst från Inställningar -> API-åtkomst; den tidigare nyckeln slutar fungera omedelbart.

Skicka ett meddelande

POST https://chatixy.com/api/v1/chat

curl https://chatixy.com/api/v1/chat \
  -H "X-API-Key: ck_live_YOUR_KEY" \
  -F "message=How do I reset my password?"

Parametrar:

• message (sträng) - besökarmeddelandet. Krävs om inte files bifogas.
• ticket_id (sträng, valfri) - fortsätt en befintlig konversation. Utelämna för att starta en ny.
• visitor_email / visitor_name (sträng, valfri) - bifoga kontaktuppgifter till ärendet.
• files (multipart, valfri) - besökarbilagor. Kräver en plan med filuppladdningar.

Svar

Anropet returnerar 202 Accepted så snart meddelandet har lagrats; AI-svaret genereras asynkront.

{
  "status": { "code": 202, "message": "Message received and being processed" },
  "data": {
    "ticket_id": 1234,
    "ticket_number": "T-1234",
    "id": "<visitor_hash>",
    "processing": true
  }
}

Skicka tillbaka data.ticket_id som ticket_id i nästa anrop för att hålla konversationen igång. För att ta emot AI-svaret, prenumerera via WebSocket (ActionCable) på kanalen som identifieras av data.id - samma besökarhash som den inbäddade widgeten använder.

Läs konversationer

Hämta ärenden och deras meddelanden med samma X-API-Key. Varje lässlutpunkt är begränsad till din arbetsyta och tillgänglig i Business-planen.

• GET /api/v1/chat/tickets - lista ärenden, nyaste först. Frågeparametrar: status, limit (max 100), offset. Returnerar tickets och pagination.
• GET /api/v1/chat/tickets/:id - ett enskilt ärende.
• GET /api/v1/chat/tickets/:id/messages - ett ärendes meddelanden i ordning, var och en med role, content och attachments.

curl https://chatixy.com/api/v1/chat/tickets \
  -H "X-API-Key: ck_live_YOUR_KEY"

Hastighetsgränser & kvot

Begäranden begränsas till ungefär 20 per minut per nyckel (och per IP). Varje genererat svar dras också från din plans månatliga meddelandekvot; när den är förbrukad returnerar slutpunkten en 200 med data.limit_reached: true i stället för att generera ett svar.

Fel

• 401 - ingen API-nyckel angiven.
• 404 - nyckeln matchar ingen arbetsyta (t.ex. efter rotation).
• 403 plan_upgrade_required - arbetsytan har inte Business-planen.
• 403 - prenumerationen är inaktiv, eller begäran kom från en domän som inte tillåts av widgetens inställningar.
• 422 - meddelandet saknas (och inga filer bifogades).