Chat API-referanse

Autentisering

Hver forespørsel autentiseres med arbeidsområdets API-nøkkel, som sendes i X-API-Key-headeren (eller som en api_key-parameter). Nøkler ser ut som ck_live_.... Behandle nøkkelen som et passord - hvem som helst som har den, kan sende meldinger som faktureres til arbeidsområdet ditt. Rotér den når som helst fra Innstillinger -> API-tilgang; den forrige nøkkelen slutter å virke umiddelbart.

Send en melding

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

Parametere:

• message (streng) - meldingen fra den besøkende. Påkrevd med mindre files er vedlagt.
• ticket_id (streng, valgfri) - fortsett en eksisterende samtale. Utelat for å starte en ny.
• visitor_email / visitor_name (streng, valgfri) - legg ved kontaktinformasjon til saken.
• files (multipart, valgfri) - vedlegg fra den besøkende. Krever en plan med filopplasting.

Svar

Kallet returnerer 202 Accepted så snart meldingen er lagret; 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 tilbake som ticket_id i neste kall for å holde samtalen i gang. For å motta AI-svaret må du abonnere over WebSocket (ActionCable) på kanalen som identifiseres av data.id - den samme besøkende-hashen som den innebygde widgeten bruker.

Les samtaler

Hent saker og meldingene deres med den samme X-API-Key. Hvert lese-endepunkt er begrenset til arbeidsområdet ditt og tilgjengelig på Business-planen.

• GET /api/v1/chat/tickets - list opp saker, nyeste først. Spørringsparametere: status, limit (maks 100), offset. Returnerer tickets og pagination.
• GET /api/v1/chat/tickets/:id - en enkelt sak.
• GET /api/v1/chat/tickets/:id/messages - en saks meldinger i rekkefølge, hver med role, content og attachments.

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

Hastighetsgrenser & kvote

Forespørsler begrenses til omtrent 20 per minutt per nøkkel (og per IP). Hvert genererte svar trekker også fra planens månedlige meldingskvote; når den er brukt opp, returnerer endepunktet en 200 med data.limit_reached: true i stedet for å generere et svar.

Feil

• 401 - ingen API-nøkkel oppgitt.
• 404 - nøkkelen samsvarer ikke med noe arbeidsområde (f.eks. etter rotasjon).
• 403 plan_upgrade_required - arbeidsområdet er ikke på Business-planen.
• 403 - abonnementet er inaktivt, eller forespørselen kom fra et domene som ikke er tillatt av widgetens innstillinger.
• 422 - meldingen mangler (og ingen filer ble vedlagt).