डेवलपर्स

Zinn® Chat क्षमता संदर्भ

Zinn® Chat अपने कार्यों को WordPress Abilities API के साथ पंजीकृत करता है। वही क्षमताएं साइट के अपने सर्वर पर MCP टूल और /wp-json/wp-abilities/v1 के अंतर्गत REST रूट हैं। यह पृष्ठ प्लगइन की अपनी रजिस्ट्री से जनरेट किया गया है।

उपयोगकर्ता मार्गदर्शिका: एक AI ऐप कनेक्ट करें

एंडपॉइंट्स

HTTP पर MCP (स्ट्रीम योग्य)

https://example.com/wp-json/zinn-chat/v1/mcp

WP-CLI पर MCP (स्टैंडर्ड इनपुट और आउटपुट)

wp mcp-adapter serve --server=zinn-chat --user=<login>

REST: क्षमताen सूचीबद् करें

/wp-json/wp-abilities/v1/abilities?category=zinn-chat

REST: एक एबिलिटी चलाएँ

/wp-json/wp-abilities/v1/abilities/<name>/run

प्रमाणन और अनुमतियाँ

HTTP अनुरोध एक WordPress एप्लिकेशन पासवर्ड (HTTP Basic) के साथ प्रमाणित होते हैं। MCP सर्वर से कनेक्ट करने के लिए नीचे दिखाई गई क्षमता की आवश्यकता होती है; फिर प्रत्येक क्षमता प्रति ऑब्जेक्ट अपनी स्वयं की अनुमति की जाँच करती है। केवल-पढ़ने वाली क्षमताएँ (Read-only) GET के साथ और उनका इनपुट क्वेरी स्ट्रिंग में चलता है; अन्य POST और JSON बॉडी {"input": {…}} के साथ चलती हैं।

उदाहरण

# REST: एक एबिलिटी चलाएँ
curl -u your-username:your-application-password \
  "https://example.com/wp-json/wp-abilities/v1/abilities/zinn-chat/get-overview/run"
# MCP (JSON-RPC over HTTP, after "initialize")
{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"zinn-chat-get-overview","arguments":{}}}

सभी क्षमताएँ

प्लगइन की abilities.json से जेनरेट किया गया, जो खुद एक रनिंग साइट से जेनरेट होती है; दोनों के मेल न खाने पर एक टेस्ट असफल हो जाता है।

क्षमतायह क्या करता हैसंस्मरणशेषअनुमतिपैरामीटर
zinn-chat/answer-ticket
zinn-chat-answer-ticket
टिकट का उत्तर दें
ग्राहकों को ईमेल (text) द्वारा उत्तर देता है, या एक आंतरिक नोट (note: true) जोड़ता है; स्थिति वैकल्पिक रूप से टिकट की स्थिति बदलती है।
फ्री संस्करणPOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
सहायक से पूछें
साइट के AI सहायक से एक प्रश्न पूछता है और मिले हुए प्रत्येक स्रोत के साथ उसका उत्तर लौटाता है।
फ्री संस्करणPOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
एक साथ कई टिकट बदलें (प्रो)
अधिकतम 100 टिकटों (आईडी) की स्थिति, प्राथमिकता या असाइनी बदलता है। प्रत्येक टिकट उसी जाँच प्रक्रिया से गुजरता है जैसे अकेले बदलने पर होता है; परिणाम प्रत्येक को सूचीबद्ध करता है।
प्रो एडिशनPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (आवश्यक), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
चैट को टिकट में बदलें
चैट से एक टिकट खोलता है ताकि इसका उत्तर ईमेल द्वारा दिया जा सके (इसके लिए आगंतुक के ईमेल पते की आवश्यकता होती है)।
फ्री संस्करणPOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/close-chat
zinn-chat-close-chat
चैट बंद करें
चैट समाप्त करता है; विज़िटर अभी भी ट्रांसक्रिप्ट का अनुरोध कर सकता है।
फ्री संस्करणPOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/create-ticket
zinn-chat-create-ticket
टिकट खोलें
ग्राहक की ओर से एक टिकट खोलता है (उनका ईमेल, एक विषय और पहला संदेश)।
फ्री संस्करणPOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
सहेजा गया उत्तर हटाएं (प्रो)
एक सहेजे गए उत्तर को हटाता है।
प्रो एडिशनPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
टिकट हटाएँ
एक टिकट और उसकी बातचीत को हमेशा के लिए हटा देता है (केवल प्रबंधकों के लिए)।
फ्री संस्करणPOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
टिकट से एक सहायता लेख का मसौदा तैयार करें (Pro)
एक हल की गई टिकट से नॉलेज-बेस लेख का एक ड्राफ्ट तैयार करता है; यह तब तक ड्राफ्ट रहता है जब तक कोई व्यक्ति इसे प्रकाशित नहीं करता।
प्रो एडिशनPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)कोई नहीं
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
अनुत्तरित प्रश्नों के लिए सहायता लेख का मसौदा तैयार करें (प्रो)
चुने गए प्रश्नों (ids) के उत्तर देते हुए नॉलेज-बेस के ड्राफ्ट लेख लिखता है; वे ड्राफ्ट ही रहते हैं।
प्रो एडिशनPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)कोई नहीं
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
सहेजा गया उत्तर भरें (प्रो)
एक सहेजे गए उत्तर का पाठ उसके प्लेसहोल्डर भरे हुए के साथ एक चैट या टिकट के लिए लौटाता है।
प्रो एडिशनPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/get-chat
zinn-chat-get-chat
चैट पढ़ें
एक चैट के संदेश और आगंतुक विवरण लौटाता है (after: इस आईडी से नए संदेश)।
फ्री संस्करणGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/get-overview
zinn-chat-get-overview
समर्थन अवलोकन पढ़ें
यह लौटाता है कि प्रत्येक स्थिति में कितने टिकट हैं और कितने चैट किसी व्यक्ति की प्रतीक्षा कर रहे हैं (और उनके अपठित संदेश), और क्या चैट, सहायक और टिकट चालू हैं।
फ्री संस्करणGET …/abilities/zinn-chat/get-overview/runzinn_chat_answerकोई नहीं
zinn-chat/get-settings
zinn-chat-get-settings
चैट सेटिंग्स पढ़ें
सभी चैट सेटिंग्स लौटाता है: विजेट, सहायक, लोग और खुलने के समय, टिकट और ईमेल, साइट इंडेक्स, गोपनीयता और स्पैम।
फ्री संस्करणGET …/abilities/zinn-chat/get-settings/runzinn_chat_manageकोई नहीं
zinn-chat/get-stats
zinn-chat-get-stats
समर्थन आँकड़े पढ़ें (Pro)
पिछले N दिनों (दिनों) के लिए चैट और टिकट संख्या, प्रतिक्रिया समय और रेटिंग देता है।
प्रो एडिशनGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/get-ticket
zinn-chat-get-ticket
टिकट पढ़ें
एक टिकट को उसकी पूरी बातचीत, स्थिति, प्राथमिकता और असाइनी के साथ लौटाता है।
फ्री संस्करणGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
चैट को वापस सहायक को सौंपें
एआई सहायक को एक चैट लौटाता है, जो साइट की सामग्री से आगंतुक का उत्तर देता है।
फ्री संस्करणPOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
सहेजे गए उत्तरों की सूची (प्रो)
सहेजे गए उत्तरों की सूची बनाता है जिन्हें एजेंट सम्मिलित कर सकते हैं, उनके शॉर्टकट के साथ।
प्रो एडिशनGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/list-chats
zinn-chat-list-chats
लाइव चैट सूची देखें
प्रतीक्षा में मौजूद, प्रगति पर और हाल ही में बंद की गईचैटों को सूचीबद्ध करता है, साथ ही यह भी दर्शाता है कि प्रत्येक को कौन संभाल रहा है।
फ्री संस्करणGET …/abilities/zinn-chat/list-chats/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/list-indexed-content
zinn-chat-list-indexed-content
सहायक क्या जानता है उसकी सूची बनाएं
एक समय में एक पृष्ठ, इसके इंडेक्स स्टेटस के साथ वह सामग्री सूचीबद्ध करता है जिससे सहायक उत्तर देता है।
फ्री संस्करणGET …/abilities/zinn-chat/list-indexed-content/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/list-kb-gaps
zinn-chat-list-kb-gaps
अनुत्तरित प्रश्नों की सूची (प्रो)
उन प्रश्नों की सूची बनाता है जो आगंतुकों ने पूछे थे जिनका उत्तर ज्ञान आधार (नॉलेज बेस) नहीं दे सका।
प्रो एडिशनGET …/abilities/zinn-chat/list-kb-gaps/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/list-tickets
zinn-chat-list-tickets
टिकट सूची
स्थिति या खोज द्वारा फ़िल्टर किए गए समर्थन टिकटों की सूची एक बार में एक पृष्ठ दिखाती है।
फ्री संस्करणGET …/abilities/zinn-chat/list-tickets/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/reembed-content
zinn-chat-reembed-content
सहायक के खोज सूचकांक को पुनः बनाएँ
एक आइटम (item_id) या सब कुछ (all: true) के लिए सर्च वेक्टर रीबिल्ड करता है (केवल प्रबंधकों के लिए)।
फ्री संस्करणPOST …/abilities/zinn-chat/reembed-content/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/reindex-content
zinn-chat-reindex-content
सामग्री को सहायक में दोबारा पढ़ें
सहायक के इंडेक्स में किसी एक आइटम (item_id) या सभी (all: true) को दोबारा लोड करता है (केवल प्रबंधकों के लिए)।
फ्री संस्करणPOST …/abilities/zinn-chat/reindex-content/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/reply-chat
zinn-chat-reply-chat
चैट में उत्तर दें
आगंतुक को एक संदेश भेजता है (text), या केवल एजेंटों को दिखने वाला एक आंतरिक नोट जोड़ता है (note: true)।
फ्री संस्करणPOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
सहेजा गया उत्तर सहेजें (प्रो)
सहेजे गए उत्तर को बनाता या बदलता है (शीर्षक, शॉर्टकट, मुख्य भाग, विभाग; बदलने के लिए आईडी)।
प्रो एडिशनPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/save-kb-article
zinn-chat-save-kb-article
एक सहायता लेख लिखें (प्रो)
ज्ञान-आधार लेख बनाता है, या किसी (id) को बदलता है: शीर्षक, सामग्री, सारांश, श्रेणियां और स्थिति (ड्राफ्ट, या जब आप प्रकाशित कर सकें तब प्रकाशित करें)।
प्रो एडिशनPOST …/abilities/zinn-chat/save-kb-article/runedit_postsid: integer, title: string, content: string, excerpt: string, categories: array, status: draft|publish
zinn-chat/search-kb
zinn-chat-search-kb
ज्ञान आधार (प्रो) खोजें
उत्तर में लिंक करने के लिए सहायता लेख ढूँढता है (q: खोज)।
प्रो एडिशनGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
बातचीत का विभाग और टैग सेट करें (Pro)
चैट या टिकट का विभाग और टैग सेट करता है (kind: chat या ticket; id)।
प्रो एडिशनPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
अनुत्तरित प्रश्नों को चिह्नित करें (Pro)
बिना उत्तर वाले प्रश्नों को खुला, योजनाबद्ध या खारिज के रूप में चिह्नित करता है (आईडी, स्थिति)।
प्रो एडिशनPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/set-presence
zinn-chat-set-presence
अपनी उपलब्धता निर्धारित करें
साइन-इन किए गए एजेंट को नई चैट के लिए उपलब्ध या अनुपलब्ध के रूप में चिह्नित करता है (अनुपलब्ध: true या false)।
फ्री संस्करणPOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/suggest-reply
zinn-chat-suggest-reply
AI (प्रो) के साथ उत्तर का मसौदा तैयार करें
साइट की सामग्री से चैट या टिकट का उत्तर तैयार करता है; कुछ भी भेजा नहीं जाता।
प्रो एडिशनPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
AI (प्रो) के साथ बातचीत का सारांश दें
चैट या टिकट को कुछ पंक्तियों में सारांशित करता है।
प्रो एडिशनPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkकोई नहीं
zinn-chat/take-chat
zinn-chat-take-chat
चैट करें
साइन-इन किए गए एजेंट को एक प्रतीक्षारत चैट असाइन करता है, ताकि विज़िटर किसी व्यक्ति से बात कर सके।
फ्री संस्करणPOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (आवश्यक)
zinn-chat/update-settings
zinn-chat-update-settings
चैट सेटिंग्स बदलें
आपके द्वारा भेजी गई सेटिंग्स (सेटिंग्स: कुंजी से मान) को बदलता है और बाकी को वैसे ही रखता है। प्रत्येक मान की जाँच सेटिंग्स स्क्रीन की तरह ही की जाती है; get-settings कुंजियों की सूची देता है।
फ्री संस्करणPOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (आवश्यक)
zinn-chat/update-ticket
zinn-chat-update-ticket
टिकट बदलें
टिकट की स्थिति, प्राथमिकता या असाइनी बदलता है।
फ्री संस्करणPOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (आवश्यक)