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

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