توسعه‌دهندگان

مرجع قابلیت‌های Zinn® Chat

Zinn® Chat کنش‌های خود را در API توانمندی‌های WordPress ثبت می‌کند. همین توانمندی‌ها ابزارهای MCP روی سرور خود سایت و مسیرهای REST در /wp-json/wp-abilities/v1 هستند. این صفحه از رجیستری خود افزونه تولید شده است.

راهنمای کاربر: اتصال یک برنامه هوش مصنوعی

نقاط پایانی

پروتکل کنترل مدل (MCP) روی HTTP (قابل پخش جریانی)

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

MCP از طریق WP-CLI (ورودی و خروجی استاندارد)

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

REST: فهرست کردن قابلیت‌ها

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

REST: اجرای یک قابلیت

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

احراز هویت و دسترسی‌ها

درخواست‌های HTTP با یک گذرواژه برنامه‌ای WordPress (پایه‌ای HTTP) احراز هویت می‌شوند. اتصال به سرور MCP به قابلیت نشان‌داده‌شده در زیر نیاز دارد؛ سپس هر توانایی، مجوز خود را به ازای هر شیء بررسی می‌کند. قابلیت‌های فقط‌خواندنی با متد GET و ورودی خود در رشته پرس‌وجو (Query String) اجرا می‌شوند؛ سایر قابلیت‌ها با متد 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
پاسخ به تیکت
به مشتری از طریق ایمیل (متن) پاسخ می‌دهد یا یک یادداشت داخلی اضافه می‌کند (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
از دستیار بپرسید
از دستیار هوش مصنوعی وب‌سایت سوال می‌پرسد و پاسخ آن را به همراه تمام منابعی که پیدا کرده است، برمی‌گرداند.
نسخه رایگان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
تغییر هم‌زمان چندین تیکت (Pro)
وضعیت، اولویت یا مسئول حداکثر ۱۰۰ تیکت (شناسه) را تغییر می‌دهد. هر تیکت از همان بررسی‌های تغییر تیکت به صورت تکی عبور می‌کند؛ نتیجه، هرکدام را فهرست می‌کند.
نسخه پرو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
پیش‌نویس کردن مقاله راهنما از یک تیکت (حرفه‌ای)
یک پیش‌نویس مقاله پایگاه دانش از یک تیکت حل‌شده می‌نویسد؛ این مقاله تا زمانی که شخصی آن را منتشر کند، پیش‌نویس باقی می‌ماند.
نسخه پرو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
پیش‌نویس مقالات راهنما برای سوالات بی‌جواب (حرفه‌ای)
پیش‌نویس مقالات پایگاه دانش را در پاسخ به سؤالات انتخاب‌شده (شناسه‌ها) می‌نویسد؛ آن‌ها در حالت پیش‌نویس باقی می‌مانند.
نسخه پرو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
مطالعه آمار پشتیبانی (حرفه‌ای)
شماره‌های چت و تیکت، زمان‌های پاسخگویی و امتیازات را برای 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
فهرست پاسخ‌های ذخیره‌شده (Pro)
فهرست پاسخ‌های ذخیره‌شده‌ای که کارشناسان می‌توانند به همراه میانبرهای آن‌ها درج کنند را نمایش می‌دهد.
نسخه پرو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
پاسخ در چت
یک پیام به بازدیدکننده ارسال می‌کند (متن)، یا یک یادداشت داخلی اضافه می‌کند که فقط نمایندگان آن را می‌بینند (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
جستجوی پایگاه دانش (حرفه ای)
یافتن مقالات راهنما برای پیوند دادن در پاسخ (پرسش: جستجو).
نسخه پرو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
تعیین دپارتمان و برچسب‌های گفتگو (حرفه‌ای)
بخش و برچسب‌های یک گفت‌وگو یا تیکت را تنظیم می‌کند (نوع: گفت‌وگو یا تیکت؛ شناسه).
نسخه پرو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
نشانه‌گذاری پرسش‌های بدون پاسخ (حرفه‌ای)
پرسش‌های بی‌پاسخ را به صورت باز، برنامه‌ریزی‌شده یا ردشده علامت‌گذاری می‌کند (شناسه‌ها، وضعیت).
نسخه پرو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
پیش‌نویس پاسخ با هوش مصنوعی (حرفه‌ای)
پیش‌نویس پاسخی برای یک گفت‌وگو یا تیکت از محتوای سایت تهیه می‌کند؛ چیزی ارسال نمی‌شود.
نسخه پروPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkهیچ‌کدام
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
خلاصه‌سازی یک مکالمه با هوش مصنوعی (Pro)
خلاصه‌ای از یک گفتگو یا تیکت را در چند سطر ارائه می‌دهد.
نسخه پرو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 (الزامی)