Chat API-reference

Godkendelse

Hver anmodning godkendes med dit arbejdsområdes API-nøgle, som sendes i X-API-Key-headeren (eller som en api_key-parameter). Nøgler ser ud som ck_live_.... Behandl nøglen som en adgangskode - enhver, der har den, kan sende beskeder, der faktureres til dit arbejdsområde. Rotér den når som helst fra Indstillinger -> API-adgang; den forrige nøgle holder straks op med at virke.

Send en besked

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

Parametre:

• message (streng) - beskeden fra den besøgende. Påkrævet, medmindre files er vedhæftet.
• ticket_id (streng, valgfri) - fortsæt en eksisterende samtale. Udelad for at starte en ny.
• visitor_email / visitor_name (streng, valgfri) - vedhæft kontaktoplysninger til sagen.
• files (multipart, valgfri) - vedhæftninger fra den besøgende. Kræver en plan med filuploads.

Svar

Kaldet returnerer 202 Accepted, så snart beskeden er gemt; AI-svaret genereres asynkront.

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

Send data.ticket_id tilbage som ticket_id i næste kald for at holde samtalen i gang. For at modtage AI-svaret skal du abonnere over WebSocket (ActionCable) på kanalen, der er identificeret ved data.id - den samme besøgende-hash, som den indlejrede widget bruger.

Læs samtaler

Hent sager og deres beskeder med den samme X-API-Key. Hvert læse-endpoint er begrænset til dit arbejdsområde og tilgængeligt på Business-planen.

• GET /api/v1/chat/tickets - vis sager, nyeste først. Forespørgselsparametre: status, limit (maks. 100), offset. Returnerer tickets og pagination.
• GET /api/v1/chat/tickets/:id - en enkelt sag.
• GET /api/v1/chat/tickets/:id/messages - en sags beskeder i rækkefølge, hver med role, content og attachments.

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

Hastighedsgrænser & kvote

Anmodninger begrænses til cirka 20 pr. minut pr. nøgle (og pr. IP). Hvert genereret svar trækker også fra din plans månedlige beskedkvote; når den er opbrugt, returnerer endpointet en 200 med data.limit_reached: true i stedet for at generere et svar.

Fejl

• 401 - ingen API-nøgle angivet.
• 404 - nøglen matcher ikke noget arbejdsområde (f.eks. efter rotation).
• 403 plan_upgrade_required - arbejdsområdet er ikke på Business-planen.
• 403 - abonnementet er inaktivt, eller anmodningen kom fra et domæne, der ikke er tilladt af widgettens indstillinger.
• 422 - beskeden mangler (og ingen filer blev vedhæftet).