Chat API atsauce

Autentifikācija

Katrs pieprasījums tiek autentificēts ar jūsu darbvietas API atslēgu, kas tiek nosūtīta X-API-Key galvenē (vai kā api_key parametrs). Atslēgas izskatās šādi: ck_live_.... Izturieties pret atslēgu kā pret paroli - ikviens, kam tā ir, var sūtīt ziņas, par kurām rēķins tiek izrakstīts jūsu darbvietai. Rotējiet to jebkurā laikā no Iestatījumi -> API piekļuve; iepriekšējā atslēga uzreiz pārstāj darboties.

Nosūtīt ziņu

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

Parametri:

• message (virkne) - apmeklētāja ziņa. Obligāta, ja vien nav pievienoti files.
• ticket_id (virkne, neobligāts) - turpiniet esošu sarunu. Izlaidiet, lai sāktu jaunu.
• visitor_email / visitor_name (virkne, neobligāts) - pievienojiet pieteikumam kontaktinformāciju.
• files (multipart, neobligāts) - apmeklētāja pielikumi. Nepieciešams plāns ar failu augšupielādēm.

Atbilde

Izsaukums atgriež 202 Accepted, tiklīdz ziņa ir saglabāta; AI atbilde tiek ģenerēta asinhroni.

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

Nododiet data.ticket_id atpakaļ kā ticket_id nākamajā izsaukumā, lai turpinātu sarunu. Lai saņemtu AI atbildi, abonējiet WebSocket (ActionCable) kanālu, kas identificēts ar data.id - to pašu apmeklētāja jaucējkodu, ko izmanto iegultais logrīks.

Lasīt sarakstes

Ielādējiet pieteikumus un to ziņojumus ar to pašu X-API-Key. Katrs lasīšanas galapunkts ir ierobežots ar jūsu darbvietu un pieejams Business plānā.

• GET /api/v1/chat/tickets - uzskaita pieteikumus, jaunākos vispirms. Vaicājuma parametri: status, limit (maks. 100), offset. Atgriež tickets un pagination.
• GET /api/v1/chat/tickets/:id - viens pieteikums.
• GET /api/v1/chat/tickets/:id/messages - pieteikuma ziņojumi secībā, katrs ar role, content un attachments.

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

Ātruma ierobežojumi un kvota

Pieprasījumi tiek ierobežoti aptuveni līdz 20 minūtē uz atslēgu (un uz IP). Katra ģenerētā atbilde arī izmanto jūsu plāna mēneša ziņu limitu; kad tas ir izsmelts, galapunkts atgriež 200 ar data.limit_reached: true, nevis ģenerē atbildi.

Kļūdas

• 401 - API atslēga nav norādīta.
• 404 - atslēga neatbilst nevienai darbvietai (piemēram, pēc rotācijas).
• 403 plan_upgrade_required - darbvieta nav Business plānā.
• 403 - abonements nav aktīvs vai pieprasījums nāca no domēna, kuru neatļauj logrīka iestatījumi.
• 422 - ziņa trūkst (un nav pievienoti faili).