開発者
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 | question: string (必須), language: string |
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 | email: string (必須), subject: string (必須), body: string (必須), name: string |
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) | ticket: integer (必須) |
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) | ids: array (必須) |
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 | days: integer |
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 | view: active|bot|closed|all |
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 | search: string, status: indexed|pending|error, page: integer |
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 | status: open|drafted|answered|ignored|all, page: integer |
zinn-chat/list-ticketszinn-chat-list-tickets | チケット一覧 ステータスまたは検索キーワードでフィルタリングされたサポートチケットを、1ページずつ一覧表示します。 | 無料版 | GET …/abilities/zinn-chat/list-tickets/run | the REST route's own per-item permission check | status: active|open|pending|solved|closed|all, search: string, page: integer |
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 | all: boolean, item_id: integer |
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 | all: boolean, item_id: integer |
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 | id: integer, title: string (必須), body: string (必須), shortcut: string, department: string |
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 | q: string (必須) |
zinn-chat/set-conversation-detailszinn-chat-set-conversation-details | 会話の部署とタグを設定する (Pro) チャットまたはチケットの部門とタグを設定します (種類: chat または ticket、id)。 | プロ版 | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (必須), department: string, tags: array |
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 | ids: array (必須), status: open|drafted|answered|ignored (必須) |
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 | away: boolean |
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 | kind: ticket|chat, id: integer (必須) |
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 | kind: ticket|chat, id: integer (必須) |
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 (必須) |
操作とフィルター
プラグインが提供するすべてのフックと、そのソースコードからの説明。フィルターは値を変更し、アクションは特定のタイミングでコードを実行させます。エントリーポイントは、プラグインに何らかの処理を実行させるために発火させるアクションです。
| フック | 種類 | 機能 | パラメーター | エディション |
|---|---|---|---|---|
zinn_chat_admin_pages | フィルター | Zinn® Chatの管理画面をフィルターします(Pro版は独自の画面を追加します)。 | なし | 無料版 |
zinn_chat_agent_chat | フィルター | エージェントコンソール用のチャットペイロードをフィルターします(Pro版では訪問者詳細、メモ、KBの提案が追加されます)。 | なし | 無料版 |
zinn_chat_agent_pages | フィルター | サポートエージェントアカウントが開きうるZinn® Chat画面をフィルターします。 | なし | プロ版 |
zinn_chat_agent_script_src | フィルター | 独立型のAIチャットエージェントが読み込まれるURLをフィルターします。 | string $src | 無料版 |
zinn_chat_agent_ticket | フィルター | wp-admin のチケットペイロードをフィルターします(Pro 版では定型返信、SLA、KB の提案が追加されます)。 | なし | 無料版 |
zinn_chat_answer | フィルター | アシスタントの回答が表示される前にフィルターを適用します(Pro版では追加機能がここに表示されます)。 | string $question | 無料版 |
zinn_chat_assistant_answered | 操作 | アシスタントが訪問者に応答しました。 | int $id, string $text | 無料版 |
zinn_chat_challenge | フィルター | 訪問者に表示されるヒューマンチェック(スクリプトURL、サイトキー、およびスクリプトが `render( element, { sitekey, callback } )` メソッドで定義するグローバルオブジェクト)をフィルタリングします。 | なし | 無料版 |
zinn_chat_challenge_ok | フィルター | 訪問者が人間確認を通過したかどうかをフィルターします。検証できない確認は「false(不合格)」を返す必要があります(fail closed)。サービスに接続できない場合にすべてを通過させるフォームは、ボットがタイミングによって突破できるフォームです。 | bool $ok, string $ip, string $where | 無料版 |
zinn_chat_client_ip | フィルター | レート制限およびレコードに使用される訪問者のIPアドレスをフィルターします。 | string $ip | 無料版 |
zinn_chat_console_config | フィルター | オペレーターコンソールのスクリプトに渡される追加の設定をフィルター処理します。Zinn® Chat Pro はここに機能を追加します。 | なし | 無料版 |
zinn_chat_conversation_started | 操作 | 訪問者がチャットを開始しました。 | int $id | 無料版 |
zinn_chat_conversation_status | 操作 | 会話のステータスが変更されました。 | int $id, string $status, string $old | 無料版 |
zinn_chat_customer_ticket_url | フィルター | 顧客に送信されるチケットのリンクをフィルタリングします。 | string $url | 無料版 |
zinn_chat_elements | フィルター | ブロックおよびビルダーモジュールとして提供されるフロントエンド要素をフィルター処理します。 | なし | 無料版 |
zinn_chat_email | フィルター | 送信前にメールをフィルター処理します。停止するには、`to` に空の値を返します。 | なし | 無料版 |
zinn_chat_fs_loaded | 操作 | ライセンシングSDKの読み込みが完了したとき(メインファイル内、Zinn® Chatコードの実行前)に発生します。`zinn_chat_fs()`と通信するには、ここにフックします。 | なし | 無料版 |
zinn_chat_index_extract | フィルター | 抽出されたオブジェクトをフィルタリングします(またはカスタムオブジェクトタイプのオブジェクトを提供します)。 | string $type, int $id | 無料版 |
zinn_chat_index_language | フィルター | インデックスされた投稿の言語(ロケール)を絞り込みます。 | string $language, \WP_Post $post | 無料版 |
zinn_chat_index_object | エントリーポイント (実行元) | フック | なし | 無料版 |
zinn_chat_index_post_types | フィルター | アシスタントが読み込む投稿タイプを絞り込みます。 | なし | 無料版 |
zinn_chat_indexable | フィルター | 投稿がインデックスされるかどうかをフィルターします。 | bool $indexable, \WP_Post $post | 無料版 |
zinn_chat_indexed | 操作 | オブジェクトがインデックス登録されました(再インデックスを含む)。 | string $type, int $id | 無料版 |
zinn_chat_is_pro | フィルター | FreemiusのPro機能(購入済みライセンスまたはトライアル)を実行するかどうかをフィルターします。Proコードはプレミアムパッケージにのみ含まれているため、これで無料版に不足している機能を追加することはできません。 | bool $pro | 無料版 |
zinn_chat_loaded | 操作 | Zinn® Chat が読み込まれました (アドオン用の拡張ポイント)。 | なし | 無料版 |
zinn_chat_message_added | 操作 | 会話にメッセージが追加されました。 | int $id, int $conversation_id, string $role | 無料版 |
zinn_chat_order_tracking | フィルター | 注文についてアシスタントに提供される追跡情報をフィルタリングします。 | \WC_Order $order | 無料版 |
zinn_chat_pro_alert | 操作 | 注意すべきイベントが発生しました(プッシュ通知の受信はこちら)。 | string $alert, int $id, string $text, string $link | プロ版 |
zinn_chat_pro_assigned | 操作 | チケットが担当者に自動的に割り当てられました。 | int $id, int $agent | プロ版 |
zinn_chat_pro_loaded | 操作 | Pro レイヤーが読み込まれました。 | なし | プロ版 |
zinn_chat_pro_priority_changed | 操作 | チケットの優先度が変更されました(SLA目標もそれに従います)。 | int $id | プロ版 |
zinn_chat_pro_sla_breach | 操作 | SLAの目標が達成されませんでした。 | int $ticket_id, string $which | プロ版 |
zinn_chat_pro_ticket_rated | 操作 | 顧客が解決済みのチケットを評価しました(1〜5)。 | int $id, int $score | プロ版 |
zinn_chat_rated | 操作 | 訪問者が会話を評価した後に発火します。会話IDと評価(役立った場合は1、役立たなかった場合は-1)が含まれます。 | int $conversation_id, int $rating | 無料版 |
zinn_chat_role_capabilities | フィルター | どのロールがどの Zinn® Chat の機能を利用できるかをフィルタリングします。 | なし | 無料版 |
zinn_chat_save_settings | フィルター | フィルターが保存される前に設定をフィルタリングします(Pro版では独自のキーがここに追加されます)。 | なし | 無料版 |
zinn_chat_script_src | フィルター | ホストされているチャットウィジェットの読み込み元 URL をフィルターします(接続モード)。 | string $src | 無料版 |
zinn_chat_settings_before | 操作 | 設定タブのフォームの上に出力します。 | string $tab | 無料版 |
zinn_chat_settings_fields | フィルター | 設定タブのフィールドをフィルタリングします(Pro版は独自のフィールドを追加します)。 | string $tab | 無料版 |
zinn_chat_settings_tabs | フィルター | 設定タブを絞り込みます。 | なし | 無料版 |
zinn_chat_setup_after | 操作 | セットアップチェックリストの下に出力されます(無料版ではここにProカードが表示されます)。 | なし | 無料版 |
zinn_chat_should_render | フィルター | このリクエストでチャットを表示するかどうかをフィルタリングします(Proのページターゲティングがここにフックします)。 | bool $render | 無料版 |
zinn_chat_site_facts | フィルター | 質問ごとにアシスタントへ提供されるサイトに関する情報をフィルター処理します。各項目は `title`、`url`(このサイト内)、`text`(プレーンテキスト、最大3,000文字)で構成され、最大4件が使用されます。 | string $language | 無料版 |
zinn_chat_site_strings | フィルター | 翻訳対象として提示されたオーナーテキストを絞り込みます(Proではプロアクティブメッセージが追加されます)。 | なし | 無料版 |
zinn_chat_system_prompt | フィルター | アシスタントのシステムプロンプトをフィルター処理します(Pro:ペルソナおよび引き継ぎルール)。 | string $rules | 無料版 |
zinn_chat_team_online | フィルター | 人物が今回答できるかどうかをフィルターします(Proではここで営業時間の設定を追加できます)。 | bool $online | 無料版 |
zinn_chat_ticket_assigned | 操作 | An agent assigned a ticket to an agent (2.14.0: the notification centre tells them). | int $id, int $assignee, int $by | 無料版 |
zinn_chat_ticket_created | 操作 | チケットが作成されました。ここから、メーラーが確認メールとチームへのアラートを送信します。 | int $id, string $token | 無料版 |
zinn_chat_ticket_form_extra | フィルター | ゲストチケットフォームの末尾にある不要なマークアップをフィルターします(Proの人間確認はここに配置されます)。 | string $html | 無料版 |
zinn_chat_ticket_form_fields | フィルター | すべてのチケットフォームでメッセージの上に表示される追加フィールドをフィルターします(Pro:部門の選択)。`zinn_chat_extra[<key>]`という名前を付けます。これらは検証のために追加したユーザーによって未サニタイズのまま`$fields['extra']`として`zinn_chat_ticket_created`に渡されます。 | string $html | 無料版 |
zinn_chat_ticket_reply | 操作 | チケットに返信が追加されました。メーラーはここから相手側にメールを送信します。 | int $id, int $ticket_id, string $author | 無料版 |
zinn_chat_ticket_status | 操作 | チケットのステータスが変更されました。 | int $id, string $status, string $old | 無料版 |
zinn_chat_uninstall | 操作 | Zinn® Chat のアンインストールを実行しています (Pro では独自のデータがここで削除されます)。 | なし | 無料版 |
zinn_chat_widget_config | フィルター | ページに出力されるランチャー設定をフィルタリングします。 | なし | 無料版 |
zinn_chat_widget_status | フィルター | 開いているチャットが受信する内容をフィルターします(Pro版では独自のスイッチやキーワードを追加できます)。 | なし | 無料版 |