Chat API संदर्भ

प्रमाणीकरण

हर अनुरोध आपके वर्कस्पेस API कुंजी से प्रमाणित होता है, जिसे X-API-Key हेडर (या api_key पैरामीटर) में भेजा जाता है। कुंजियाँ ck_live_... जैसी दिखती हैं। कुंजी को पासवर्ड की तरह मानें - इसे रखने वाला कोई भी व्यक्ति ऐसे संदेश भेज सकता है जिनका बिल आपके वर्कस्पेस पर आएगा। इसे सेटिंग्स -> API एक्सेस से कभी भी घुमाएँ (rotate करें); पिछली कुंजी तुरंत काम करना बंद कर देती है।

संदेश भेजें

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

पैरामीटर:

• message (स्ट्रिंग) - विज़िटर संदेश। जब तक files संलग्न न हों, तब तक आवश्यक।
• ticket_id (स्ट्रिंग, वैकल्पिक) - किसी मौजूदा बातचीत को जारी रखें। नई शुरू करने के लिए इसे छोड़ दें।
• visitor_email / visitor_name (स्ट्रिंग, वैकल्पिक) - टिकट में संपर्क विवरण संलग्न करें।
• files (multipart, वैकल्पिक) - विज़िटर अटैचमेंट। इसके लिए फ़ाइल अपलोड वाला प्लान आवश्यक है।

प्रतिक्रिया

संदेश संग्रहीत होते ही यह कॉल 202 Accepted लौटाता है; AI उत्तर अतुल्यकालिक रूप से (asynchronously) उत्पन्न होता है।

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

बातचीत जारी रखने के लिए अगली कॉल में data.ticket_id को ticket_id के रूप में वापस पास करें। AI उत्तर प्राप्त करने के लिए, data.id द्वारा कीड किए गए चैनल को WebSocket (ActionCable) पर सब्सक्राइब करें - यह वही विज़िटर हैश है जिसका उपयोग एम्बेडेड विजेट करता है।

बातचीत पढ़ें

उसी X-API-Key के साथ टिकट और उनके संदेश प्राप्त करें। हर रीड एंडपॉइंट आपके वर्कस्पेस तक सीमित है और Business प्लान पर उपलब्ध है।

• GET /api/v1/chat/tickets - टिकट सूचीबद्ध करें, सबसे नए पहले। क्वेरी पैरामीटर: status, limit (अधिकतम 100), offset। tickets और pagination लौटाता है।
• GET /api/v1/chat/tickets/:id - एक अकेला टिकट।
• GET /api/v1/chat/tickets/:id/messages - किसी टिकट के संदेश क्रम में, हर एक में role, content और attachments शामिल हैं।

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

दर सीमाएँ और कोटा

अनुरोध प्रति कुंजी (और प्रति IP) लगभग 20 प्रति मिनट तक सीमित किए जाते हैं। प्रत्येक उत्पन्न उत्तर आपके प्लान के मासिक संदेश भत्ते से भी खर्च होता है; एक बार यह समाप्त हो जाने पर एंडपॉइंट उत्तर उत्पन्न करने के बजाय data.limit_reached: true के साथ 200 लौटाता है।

त्रुटियाँ

• 401 - कोई API कुंजी प्रदान नहीं की गई।
• 404 - कुंजी किसी भी वर्कस्पेस से मेल नहीं खाती (जैसे रोटेशन के बाद)।
• 403 plan_upgrade_required - वर्कस्पेस Business प्लान पर नहीं है।
• 403 - सब्सक्रिप्शन निष्क्रिय है, या अनुरोध ऐसे डोमेन से आया है जिसे विजेट की सेटिंग्स द्वारा अनुमति नहीं है।
• 422 - संदेश अनुपस्थित है (और कोई फ़ाइल संलग्न नहीं की गई थी)।