डेवलपर्स
Zinn® Chat क्षमता संदर्भ
Zinn® Chat अपने कार्यों को WordPress Abilities API के साथ पंजीकृत करता है। वही क्षमताएं साइट के अपने सर्वर पर MCP टूल और /wp-json/wp-abilities/v1 के अंतर्गत REST रूट हैं। यह पृष्ठ प्लगइन की अपनी रजिस्ट्री से जनरेट किया गया है।
एंडपॉइंट्स
HTTP पर MCP (स्ट्रीम योग्य)
https://example.com/wp-json/zinn-chat/v1/mcpWP-CLI पर MCP (स्टैंडर्ड इनपुट और आउटपुट)
wp mcp-adapter serve --server=zinn-chat --user=<login>REST: क्षमताen सूचीबद् करें
/wp-json/wp-abilities/v1/abilities?category=zinn-chatREST: एक एबिलिटी चलाएँ
/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-ticketzinn-chat-answer-ticket | टिकट का उत्तर दें ग्राहक को ईमेल (text) द्वारा उत्तर देता है, या एक आंतरिक नोट जोड़ता है (note: true); स्थिति वैकल्पिक रूप से टिकट की स्थिति को बदलती है। | फ्री संस्करण | POST …/abilities/zinn-chat/answer-ticket/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/ask-assistantzinn-chat-ask-assistant | सहायक से पूछें साइट के AI सहायक से एक प्रश्न पूछता है और मिले हुए प्रत्येक स्रोत के साथ इसका उत्तर देता है। | फ्री संस्करण | POST …/abilities/zinn-chat/ask-assistant/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/bulk-update-ticketszinn-chat-bulk-update-tickets | एक साथ कई टिकट बदलें (प्रो) अधिकतम 100 टिकटों (आईडी) की स्थिति, प्राथमिकता या असाइनी को बदलता है। प्रत्येक टिकट उसी जाँच प्रक्रिया से गुजरता है जैसे उसे अलग से बदलने पर होती है; परिणाम प्रत्येक को सूचीबद्ध करता है। | प्रो एडिशन | POST …/abilities/zinn-chat/bulk-update-tickets/run | zinn_chat_answer | ids: array (आवश्यक), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer |
zinn-chat/chat-to-ticketzinn-chat-chat-to-ticket | चैट को टिकट में बदलें चैट से एक टिकट खोलता है ताकि इसका उत्तर ईमेल द्वारा दिया जा सके (इसके लिए आगंतुक के ईमेल पते की आवश्यकता होती है)। | फ्री संस्करण | POST …/abilities/zinn-chat/chat-to-ticket/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/close-chatzinn-chat-close-chat | चैट बंद करें चैट समाप्त करता है; विज़िटर अभी भी ट्रांसक्रिप्ट के लिए कह सकता है। | फ्री संस्करण | POST …/abilities/zinn-chat/close-chat/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/create-ticketzinn-chat-create-ticket | टिकट खोलें ग्राहक की ओर से एक टिकट खोलता है (उनका ईमेल, एक विषय और पहला संदेश)। | फ्री संस्करण | POST …/abilities/zinn-chat/create-ticket/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/delete-canned-replyzinn-chat-delete-canned-reply | सहेजे गए उत्तर को हटाएं (Pro) एक सहेजा गया उत्तर हटाता है। | प्रो एडिशन | POST …/abilities/zinn-chat/delete-canned-reply/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/delete-ticketzinn-chat-delete-ticket | टिकट हटाएँ एक टिकट और उसकी बातचीत को हमेशा के लिए हटा देता है (केवल प्रबंधकों के लिए)। | फ्री संस्करण | POST …/abilities/zinn-chat/delete-ticket/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/draft-kb-articlezinn-chat-draft-kb-article | टिकट से एक सहायता लेख का मसौदा तैयार करें (प्रो) हल किए गए टिकट से ज्ञान-आधारित आलेख का एक ड्राफ्ट तैयार करता है; जब तक कोई व्यक्ति इसे प्रकाशित नहीं करता, यह ड्राफ्ट ही रहता है। | प्रो एडिशन | POST …/abilities/zinn-chat/draft-kb-article/run | edit_posts (the REST route's own check) | कोई नहीं |
zinn-chat/draft-kb-from-gapszinn-chat-draft-kb-from-gaps | अनुत्तरित प्रश्नों के लिए सहायता लेख ड्राफ्ट करें (Pro) चयनित प्रश्नों (ids) के उत्तर देने वाले ड्राफ्ट नॉलेज-बेस लेख लिखता है; वे ड्राफ्ट ही रहते हैं। | प्रो एडिशन | POST …/abilities/zinn-chat/draft-kb-from-gaps/run | edit_posts (the REST route's own check) | कोई नहीं |
zinn-chat/fill-canned-replyzinn-chat-fill-canned-reply | सहेजा गया उत्तर भरें (Pro) एक चैट या टिकट के लिए उसके प्लेसहोल्डर भरे हुए सहेजे गए उत्तर का पाठ लौटाता है। | प्रो एडिशन | POST …/abilities/zinn-chat/fill-canned-reply/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/get-chatzinn-chat-get-chat | चैट पढ़ें एक चैट के संदेश और आगंतुक विवरण लौटाता है (after: इस आईडी से नए संदेश)। | फ्री संस्करण | GET …/abilities/zinn-chat/get-chat/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/get-overviewzinn-chat-get-overview | समर्थन अवलोकन पढ़ें यह लौटाता है कि प्रत्येक स्थिति में कितने टिकट हैं और कितने चैट किसी व्यक्ति की प्रतीक्षा कर रहे हैं (और उनके न पढ़े गए संदेश), और क्या चैट, सहायक और टिकट चालू हैं। | फ्री संस्करण | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | कोई नहीं |
zinn-chat/get-settingszinn-chat-get-settings | चैट सेटिंग्स पढ़ें प्रत्येक चैट सेटिंग लौटाता है: विजेट, सहायक, लोग और खुलने के समय, टिकट और ईमेल, साइट इंडेक्स, गोपनीयता और स्पैम। | फ्री संस्करण | GET …/abilities/zinn-chat/get-settings/run | zinn_chat_manage | कोई नहीं |
zinn-chat/get-statszinn-chat-get-stats | समर्थन आँकड़े पढ़ें (प्रो) पिछले N दिनों (दिनों) के लिए चैट और टिकट नंबर, प्रतिक्रिया समय और रेटिंग लौटाता है। | प्रो एडिशन | GET …/abilities/zinn-chat/get-stats/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/get-ticketzinn-chat-get-ticket | टिकट पढ़ें एक टिकट को उसकी पूरी बातचीत, स्थिति, प्राथमिकता और असाइनी के साथ लौटाता है। | फ्री संस्करण | GET …/abilities/zinn-chat/get-ticket/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/hand-chat-to-assistantzinn-chat-hand-chat-to-assistant | चैट को वापस सहायक को सौंपें AI सहायक को चैट लौटाता है, जो साइट की सामग्री से आगंतुक का उत्तर देता है। | फ्री संस्करण | POST …/abilities/zinn-chat/hand-chat-to-assistant/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/list-canned-replieszinn-chat-list-canned-replies | सहेजे गए उत्तरों की सूची (प्रो) उन सहेजे गए उत्तरों को सूचीबद्ध करता है जिन्हें एजेंट उनके शॉर्टकट के साथ सम्मिलित कर सकते हैं। | प्रो एडिशन | GET …/abilities/zinn-chat/list-canned-replies/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/list-chatszinn-chat-list-chats | लाइव चैट सूची देखें प्रतीक्षा में, प्रगति पर और हाल ही में बंद की गई चैट की सूची बनाता है, साथ ही यह भी दिखाता है कि प्रत्येक को कौन संभाल रहा है। | फ्री संस्करण | GET …/abilities/zinn-chat/list-chats/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/list-indexed-contentzinn-chat-list-indexed-content | सहायक क्या जानता है उसकी सूची बनाएं सहायक जिन सामग्रियों से उत्तर देता है, उनकी सामग्री को उनके इंडेक्स स्टेटस के साथ, एक बार में एक पृष्ठ पर सूचीबद्ध करता है। | फ्री संस्करण | GET …/abilities/zinn-chat/list-indexed-content/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/list-kb-gapszinn-chat-list-kb-gaps | बिना उत्तर वाले प्रश्न सूचीबद्ध करें (प्रो) उन प्रश्नों को सूचीबद्ध करता है जो आगंतुकों ने पूछे थे जिनका उत्तर ज्ञान आधार (नॉलेज बेस) नहीं दे सका। | प्रो एडिशन | GET …/abilities/zinn-chat/list-kb-gaps/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/list-ticketszinn-chat-list-tickets | टिकटों की सूची बनाएँ स्थिति या खोज के आधार पर फ़िल्टर की गई सहायता टिकट्स की सूची, एक बार में एक पृष्ठ। | फ्री संस्करण | GET …/abilities/zinn-chat/list-tickets/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/reembed-contentzinn-chat-reembed-content | सहायक का खोज सूचकांक पुनर्निर्माण करें एक आइटम (item_id) या सब कुछ (all: true) के लिए खोज वैक्टर को फिर से बनाता है (केवल प्रबंधकों के लिए)। | फ्री संस्करण | POST …/abilities/zinn-chat/reembed-content/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/reindex-contentzinn-chat-reindex-content | सामग्री को सहायक में दोबारा पढ़ें सहायक के इंडेक्स में एक आइटम (item_id) या सब कुछ (all: true) पुनः लोड करता है (केवल प्रबंधकों के लिए)। | फ्री संस्करण | POST …/abilities/zinn-chat/reindex-content/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/reply-chatzinn-chat-reply-chat | चैट में उत्तर दें विज़िटर को एक संदेश (text) भेजता है, या केवल एजेंटों को दिखने वाला एक आंतरिक नोट जोड़ता है (note: true)। | फ्री संस्करण | POST …/abilities/zinn-chat/reply-chat/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/save-canned-replyzinn-chat-save-canned-reply | सहेजे गए उत्तर को सहेजें (प्रो) सहेजे गए उत्तर को बनाता या बदलता है (शीर्षक, शॉर्टकट, मुख्य भाग, विभाग; किसी एक को बदलने के लिए आईडी)। | प्रो एडिशन | POST …/abilities/zinn-chat/save-canned-reply/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/save-kb-articlezinn-chat-save-kb-article | एक सहायता लेख लिखें (प्रो) एक नॉलेजबेस लेख बनाता है, या किसी (id) को बदलता है: शीर्षक, सामग्री, अंश, श्रेणियां और स्थिति (ड्राफ्ट, या जब आप प्रकाशित कर सकें तब प्रकाशित करें)। | प्रो एडिशन | POST …/abilities/zinn-chat/save-kb-article/run | edit_posts | id: integer, title: string, content: string, excerpt: string, categories: array, status: draft|publish |
zinn-chat/search-kbzinn-chat-search-kb | नॉलेज बेस खोजें (प्रो) प्रतिक्रिया में लिंक करने के लिए सहायता लेख ढूँढता है (q: खोज)। | प्रो एडिशन | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/set-conversation-detailszinn-chat-set-conversation-details | वार्ता का विभाग और टैग सेट करें (Pro) चैट या टिकट का विभाग और टैग सेट करता है (kind: chat या ticket; id)। | प्रो एडिशन | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/set-kb-gap-statuszinn-chat-set-kb-gap-status | अनुत्तरित प्रश्नों को चिह्नित करें (प्रो) बिना उत्तर दिए गए प्रश्नों को खुला, नियोजित या खारिज के रूप में चिह्नित करता है (आईडी, स्थिति)। | प्रो एडिशन | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/set-presencezinn-chat-set-presence | अपनी उपलब्धता सेट करें साइन-इन किए गए एजेंट को नई चैट के लिए उपलब्ध या अनुपलब्ध के रूप में चिह्नित करता है (अनुपलब्ध: true या false)। | फ्री संस्करण | POST …/abilities/zinn-chat/set-presence/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/suggest-replyzinn-chat-suggest-reply | एआई (प्रो) के साथ उत्तर का मसौदा तैयार करें साइट की सामग्री से चैट या टिकट का उत्तर तैयार करता है; कुछ भी भेजा नहीं जाता। | प्रो एडिशन | POST …/abilities/zinn-chat/suggest-reply/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | AI (Pro) के साथ बातचीत का सारांश दें कुछ ही पंक्तियों में चैट या टिकट का सारांश देता है। | प्रो एडिशन | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | कोई नहीं |
zinn-chat/take-chatzinn-chat-take-chat | चैट करें साइन-इन किए गए एजेंट को एक प्रतीक्षारत चैट असाइन करता है, जिससे विज़िटर किसी व्यक्ति से बात कर सके। | फ्री संस्करण | POST …/abilities/zinn-chat/take-chat/run | the REST route's own per-item permission check | id: string (आवश्यक) |
zinn-chat/update-settingszinn-chat-update-settings | चैट सेटिंग्स बदलें आपके द्वारा भेजी जाने वाली सेटिंग (सेटिंग: कुंजी से मान) बदलता है और बाकी को वैसे ही रखता है। प्रत्येक मान की जाँच वैसे ही की जाती है जैसे सेटिंग स्क्रीन पर की जाती है; get-settings कुंजियों की सूची देता है। | फ्री संस्करण | POST …/abilities/zinn-chat/update-settings/run | zinn_chat_manage | settings: object (आवश्यक) |
zinn-chat/update-ticketzinn-chat-update-ticket | टिकट बदलें टिकट की स्थिति, प्राथमिकता या असाइनी बदलता है। | फ्री संस्करण | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: string (आवश्यक) |