Chat-API-referenssi

Todennus

Jokainen pyyntö todennetaan työtilasi API-avaimella, joka lähetetään X-API-Key-otsakkeessa (tai api_key-parametrina). Avaimet näyttävät tältä: ck_live_.... Käsittele avainta kuin salasanaa - kuka tahansa sen haltija voi lähettää viestejä, jotka laskutetaan työtilaltasi. Vaihda se milloin tahansa kohdasta Asetukset -> API-käyttö; edellinen avain lakkaa toimimasta välittömästi.

Lähetä viesti

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

Parametrit:

• message (merkkijono) - kävijän viesti. Pakollinen, ellei files ole liitetty.
• ticket_id (merkkijono, valinnainen) - jatka olemassa olevaa keskustelua. Jätä pois aloittaaksesi uuden.
• visitor_email / visitor_name (merkkijono, valinnainen) - liitä yhteystiedot tikettiin.
• files (multipart, valinnainen) - kävijän liitteet. Vaatii tilauksen, jossa on tiedostojen lataus.

Vastaus

Kutsu palauttaa 202 Accepted heti kun viesti on tallennettu; tekoälyn vastaus luodaan asynkronisesti.

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

Välitä data.ticket_id takaisin ticket_id-arvona seuraavassa kutsussa, jotta keskustelu jatkuu. Vastaanottaaksesi tekoälyn vastauksen tilaa WebSocketin (ActionCable) kautta kanava, joka on tunnistettu arvolla data.id - sama kävijän tiiviste, jota upotettu widget käyttää.

Lue keskusteluja

Hae tikettejä ja niiden viestejä samalla X-API-Key-avaimella. Jokainen lukupääte on rajattu työtilaasi ja käytettävissä Business-tilauksessa.

• GET /api/v1/chat/tickets - listaa tiketit, uusimmat ensin. Kyselyparametrit: status, limit (enintään 100), offset. Palauttaa tickets ja pagination.
• GET /api/v1/chat/tickets/:id - yksittäinen tiketti.
• GET /api/v1/chat/tickets/:id/messages - tiketin viestit järjestyksessä, kukin sisältäen role, content ja attachments.

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

Nopeusrajat & kiintiö

Pyynnöt on rajoitettu noin 20:een minuutissa avainta kohti (ja IP:tä kohti). Jokainen luotu vastaus vähentää myös tilauksesi kuukausittaista viestikiintiötä; kun se on käytetty loppuun, päätepiste palauttaa arvon 200 ja data.limit_reached: true vastauksen luomisen sijaan.

Virheet

• 401 - API-avainta ei toimitettu.
• 404 - avain ei vastaa mitään työtilaa (esim. vaihdon jälkeen).
• 403 plan_upgrade_required - työtilalla ei ole Business-tilausta.
• 403 - tilaus on passiivinen, tai pyyntö tuli verkkotunnuksesta, jota widgetin asetukset eivät salli.
• 422 - viesti puuttuu (eikä tiedostoja liitetty).