開発者
Zinn® Chat 機能リファレンス
Zinn® Chat は、 WordPress Abilities API にアクションを登録します。同じ能力は、サイト自体のサーバー上の MCP ツールであり、/wp-json/wp-abilities/v1 以下の REST ルートです。このページはプラグイン自体のレジストリから生成されます。
エンドポイント
MCP over HTTP (ストリーマブル)
https://example.com/wp-json/zinn-chat/v1/mcpWP-CLI 経由の MCP (標準入出力)
wp mcp-adapter serve --server=zinn-chat --user=<login>REST: 能力の一覧を表示
/wp-json/wp-abilities/v1/abilities?category=zinn-chatREST: 能力を実行する
/wp-json/wp-abilities/v1/abilities/<name>/run認証と権限
HTTP リクエストは WordPress アプリケーション パスワード（HTTP Basic）で認証されます。MCP サーバーへの接続には、以下に示す権限が必要です。その後、各機能がオブジェクトごとに独自の権限をチェックします。読み取り専用の機能は 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 から生成されます。これは稼働中のサイトからそれ自体が生成されるもので、両者が一致しない場合、テストは失敗します。
| 権限 | 動作の仕組み | エディション | REST | 権限 | パラメータ |
|---|---|---|---|---|---|
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 | 複数のチケットを一括変更 (Pro) 最大100件のチケット（ID）のステータス、優先度、または担当者を変更します。各チケットは個別変更時と同様のチェックを通過し、結果にはそれぞれが一覧表示されます。 | プロ版 | 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 | チケットからヘルプ記事を作成 (Pro) 解決済みのチケットからナレッジベースの記事の下書きを作成します。手動で公開されるまで下書きの状態のままになります。 | プロ版 | 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) 選択された質問（ID）に回答するナレッジベースの下書き記事を作成します（ステータスは下書きのままとなります）。 | プロ版 | 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) 1つのチャットまたはチケットについて、プレースホルダーが置き換えられた保存済み返信のテキストを返します。 | プロ版 | 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 | チャットを読む 1件のチャットのメッセージと訪問者の詳細を返します（after: このIDより新しいメッセージのみ）。 | 無料版 | 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 | サポート統計の読み取り (Pro) 過去N日間（日数）のチャット数とチケット数、応答時間、評価を返します。 | プロ版 | GET …/abilities/zinn-chat/get-stats/run | the REST route's own per-item permission check | なし |
zinn-chat/get-ticketzinn-chat-get-ticket | チケットを読む チケット1件について、全やり取り、ステータス、優先度、担当者を返します。 | 無料版 | 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 | 保存済み返信の一覧表示 (Pro) エージェントが挿入できる保存済み返信と、そのショートカットの一覧を表示します。 | プロ版 | 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 | アシスタントが知っていることを一覧表示する アシスタントが回答の根拠とするコンテンツを、インデックスのステータスとともに1ページずつ一覧表示します。 | 無料版 | 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 | 未回答の質問を表示 (Pro) ナレッジベースが回答できなかった、訪問者からの質問の一覧を表示します。 | プロ版 | GET …/abilities/zinn-chat/list-kb-gaps/run | the REST route's own per-item permission check | なし |
zinn-chat/list-ticketszinn-chat-list-tickets | チケット一覧 サポートチケットの一覧を、ステータスや検索によるフィルターを適用して、1ページずつ表示します。 | 無料版 | GET …/abilities/zinn-chat/list-tickets/run | the REST route's own per-item permission check | なし |
zinn-chat/reembed-contentzinn-chat-reembed-content | アシスタントの検索インデックスを再構築する 1つのアイテム（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 | コンテンツをアシスタントに再度読み込ませる アシスタントのインデックスに、1つのアイテム（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 | 保存済み返信を保存（Pro） 保存済み返信を作成または変更します（タイトル、ショートカット、本文、部署；変更する場合はID）。 | プロ版 | 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 | ヘルプ記事を作成する（Pro） ナレッジベースの記事を作成するか、変更します (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 | ナレッジベースを検索 (Pro) 返信にリンクするためのヘルプ記事を検索します（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 | 未回答の質問にマークする (Pro) 未回答の質問を「未解決」「予定済み」「却下」のいずれかにマークします（ID、ステータス）。 | プロ版 | 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 | AIで返信を作成（Pro） サイトのコンテンツからチャットやチケットへの返信を下書きします（送信はされません）。 | プロ版 | 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 (必須) |