Sohbet API referansı

Kimlik doğrulama

Her istek, X-API-Key başlığında (veya bir api_key parametresi olarak) gönderilen çalışma alanı API anahtarınızla doğrulanır. Anahtarlar ck_live_... gibi görünür. Anahtara bir parola gibi davranın - eline geçiren herkes çalışma alanınıza faturalandırılan mesajlar gönderebilir. Anahtarı istediğiniz zaman Ayarlar -> API erişimi üzerinden döndürebilirsiniz; önceki anahtar hemen çalışmayı durdurur.

Mesaj gönderme

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

Parametreler:

• message (dize) - ziyaretçi mesajı. files ekli değilse zorunludur.
• ticket_id (dize, isteğe bağlı) - mevcut bir görüşmeye devam edin. Yeni bir görüşme başlatmak için boş bırakın.
• visitor_email / visitor_name (dize, isteğe bağlı) - iletişim bilgilerini Talebe ekleyin.
• files (multipart, isteğe bağlı) - ziyaretçi ekleri. Dosya yükleme özelliği olan bir plan gerektirir.

Yanıt

Çağrı, mesaj kaydedilir kaydedilmez 202 Accepted döndürür; yapay zeka yanıtı eşzamansız olarak oluşturulur.

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

Görüşmeyi sürdürmek için bir sonraki çağrıda data.ticket_id değerini ticket_id olarak geri gönderin. Yapay zeka yanıtını almak için, data.id ile anahtarlanan kanala WebSocket (ActionCable) üzerinden abone olun - bu, gömülü aracın kullandığı ziyaretçi karmasının aynısıdır.

Konuşmaları okuma

Talepleri ve mesajlarını aynı X-API-Key ile çekin. Her okuma uç noktası çalışma alanınızla sınırlıdır ve Business planında kullanılabilir.

• GET /api/v1/chat/tickets - talepleri en yeniden başlayarak listeler. Sorgu parametreleri: status, limit (en fazla 100), offset. tickets ve pagination döndürür.
• GET /api/v1/chat/tickets/:id - tek bir talep.
• GET /api/v1/chat/tickets/:id/messages - bir talebin mesajları sırayla, her biri role, content ve attachments ile birlikte.

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

Hız sınırları ve kota

İstekler, anahtar başına (ve IP başına) yaklaşık dakikada 20 ile sınırlandırılır. Oluşturulan her yanıt ayrıca planınızın aylık mesaj hakkından düşer; bu hak tükendiğinde uç nokta, yanıt oluşturmak yerine data.limit_reached: true ile birlikte 200 döndürür.

Hatalar

• 401 - API anahtarı sağlanmadı.
• 404 - anahtar herhangi bir çalışma alanıyla eşleşmiyor (ör. döndürmeden sonra).
• 403 plan_upgrade_required - çalışma alanı Business planında değil.
• 403 - abonelik etkin değil veya istek, aracın ayarlarında izin verilmeyen bir alan adından geldi.
• 422 - mesaj eksik (ve hiçbir dosya eklenmemiş).