Kanadr hosted PBX

Kanadr API と MCP の例

このリポジトリには、Kanadr API の OpenAPI 仕様と、MCP サーバーを通じて AI アシスタントを Kanadr ポータルに接続するためのすぐに使える設定が含まれています。

Kanadr は、通信事業者向けのホワイトラベル型ホステッド PBX です。ポータルでのすべての操作はこの API を通じて行われます。対象には、顧客、番号、トランク、通話フロー、デバイス、通話ログ、通話料金、ウェブフック、診断が含まれます。この仕様には 200 を超えるパスが記載されており、英語とフランス語で説明されています。

内容

パス	内容
openapi/openapi.en.json	OpenAPI 仕様。英語の説明
openapi/openapi.json	同じ仕様。フランス語の説明
mcp/	MCP クライアントの設定：Claude Code、Codex、Mistral Vibe、OpenAI Responses API、汎用 JSON
examples/	curl を使ったプレーン HTTP リクエスト

閲覧可能なリファレンスは docs.kanadr.com/api/en にあります。すべての操作をまとめた一覧も利用できます。

認証

• API キー：ポータルの API、次に API keys から作成します。Authorization: Bearer cx_… として送信してください。キーには付与したロールとまったく同じ権限があるため、まずは読み取り専用ロールから始めてください。
• OAuth：claude.ai、ChatGPT、Le Chat などのウェブアシスタントでは、代わりに OAuth を使用します。キーを指定せずにサーバーアドレスを追加し、ポータルにサインインしてアクセスを承認します。

各 Kanadr ポータルには固有のアドレスがあります。例にある portal.example は、ご自身のポータルのアドレスに置き換えてください。

MCP サーバー

各ポータルは、https://portal.example/api/v1/mcp に MCP サーバーを公開しています（ストリーミング可能な HTTP）。各 API 操作は、たとえば listerClients や reglerRenvois のように、同じ名前のツールとして利用できます。ツールの説明を英語で取得するには、Accept-Language: en を送信してください。monCompte ツールは、接続中のアカウントとその組織を返します。変更を行う前に、アシスタントはユーザーに確認を求めます。すべての書き込み操作は、ユーザー名またはキー名で監査ログに記録されます。

Claude Code ですぐに使い始めるには：

claude mcp add --transport http phone https://portal.example/api/v1/mcp

次に、Claude Code で /mcp を実行し、Authenticate を選択してください。他のクライアントについては mcp/ をご覧ください。詳しいガイドは MCP ドキュメントにあります。

リクエストの例：

• 「障害が発生しているトランクはどれですか？ また、いつからですか？」
• 「販売代理店 Example の顧客と、それぞれの内線数を一覧表示してください。」
• 「顧客 Example の内線 100 が登録されないのはなぜですか？」

ライセンス

mcp/ と examples/ の設定ファイルおよび例は、MIT ライセンスの下で提供されています。OpenAPI 仕様は商用製品である Kanadr について記述したものです。この仕様は、これに基づいてインテグレーションを構築できるよう公開されています。

お問い合わせ

Kanadr は、フランスの Archel SAS のブランドです。デモ用インスタンスをご希望の場合は、kanadr.com/en/contact にアクセスしてください。[email protected] へのメールでもお問い合わせいただけます。