chaport

Chaport

Chaport は、企業がウェブサイトの訪問者や顧客とリアルタイムでやり取りするための、ライブチャットおよびチャットボットのプラットフォームです。営業チームやサポートチームが、ウェブサイト上で直接質問に回答し、サポートを提供し、見込み客を選別するために利用しています。

公式ドキュメント：https://www.chaport.com/api/

Chaport の概要

• チャット
  • メッセージ
• オペレーター
• 訪問者
• チケット
• レポート

Chaport の操作

このスキルでは、Membrane CLI を使用して Chaport を操作します。Membrane は認証と認証情報の更新を自動的に処理するため、認証周りの処理ではなく、統合ロジックに集中できます。

CLI のインストール

ターミナルから membrane を実行できるように、Membrane CLI をインストールします。

npm install -g @membranehq/cli@latest

認証

membrane login --tenant --clientName=<agentType>

インタラクティブモードを利用できるかどうかに応じて、ブラウザーが開くか、認証 URL がコンソールに表示されます。

ヘッドレス環境： コマンドは認証 URL を表示します。ユーザーにブラウザーで開いてもらいます。ログイン完了後にコードが表示されたら、次のコマンドで完了します。

membrane login complete <code>

任意のコマンドに --json を追加すると、機械可読な JSON 形式で出力されます。

エージェントの種類：claude、openclaw、codex、warp、windsurf など。これらは、使用するツールをハーネスに最適化するために使用されます。

Chaport への接続

membrane connection ensure を使用して、アプリの URL またはドメインから接続を検索するか、新規作成します。

membrane connection ensure "https://www.chaport.com/" --json

ユーザーがブラウザーで認証を完了します。出力には、新しい接続 ID が含まれます。

これが、接続を取得する最も手早い方法です。URL はドメインに正規化され、既知のアプリと照合されます。アプリが見つからない場合は、新しいアプリが作成され、コネクターが自動的に構築されます。

返された接続の state: "READY" の場合は、ステップ 2 に進みます。

1b. 接続の準備が整うまで待機する

接続が BUILDING 状態の場合は、準備が整うまでポーリングします。

npx @membranehq/cli connection get <id> --wait --json

--wait フラグを指定するとロングポーリングを行い、状態が変わるまで待機します（最大待機時間は --timeout 秒、デフォルトは 30 秒です）。state が BUILDING 以外になるまでポーリングを続けます。

次の状態に応じて、次の操作が決まります。

• READY — 接続のセットアップが完了しています。ステップ 2 に進みます。

• CLIENT_ACTION_REQUIRED — ユーザーまたはエージェントによる操作が必要です。必要な操作については、clientAction オブジェクトに記載されています。

  • clientAction.type — 必要な操作の種類です。
    • "connect" — ユーザーによる認証が必要です（OAuth、API キーなど）。これには、初回の認証と、接続が切断された場合の再認証が含まれます。
    • "provide-input" — 追加情報（接続するアプリなど）が必要です。
  • clientAction.description — 必要な操作についての、人が読める説明です。
  • clientAction.uiUrl（省略可）— ユーザーが操作を完了できる、事前構築済み UI の URL です。存在する場合はユーザーに提示します。
  • clientAction.agentInstructions（省略可）— AI エージェントがプログラムで処理を進めるための指示です。

  ユーザーが操作（ブラウザーでの認証など）を完了したら、membrane connection get <id> --json で再度ポーリングし、状態が READY に変わったか確認します。

• CONFIGURATION_ERROR または SETUP_FAILED — 問題が発生しています。詳細は error フィールドを確認してください。

アクションの検索

実行したい操作を自然言語で説明して検索します。

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

アクションは常に、特定の接続のコンテキストで検索してください。

各結果には、id、name、description、inputSchema（アクションが受け取るパラメーター）、outputSchema（アクションが返す内容）が含まれます。

よく使われるアクション

名前	キー	説明
訪問者の一覧表示	list-visitors	最も最近のチャットの時刻が新しい順に、訪問者を取得します。
オペレーターの一覧表示	list-operators	Chaport アカウントに登録されているすべてのオペレーター（チームメンバー）を取得します。
Webhook の一覧表示	list-webhooks	Webhook サブスクリプションの一覧を取得します。
チャットイベントの一覧表示	list-chat-events	指定したチャットのすべてのチャットイベントを取得します。
訪問者の取得	get-visitor	ID で訪問者を取得します。
オペレーターの取得	get-operator	ID で単一のオペレーターを取得します。
Webhook の取得	get-webhook	ID で Webhook を取得します。
チャットの取得	get-chat	訪問者 ID とチャット ID でチャットを取得します。
訪問者の最新チャットの取得	get-visitor-last-chat	訪問者の現在のチャット、または直近のチャットを取得します。
オペレーターの作成	create-operator	新しいオペレーターを作成します。
Webhook の作成	create-webhook	新しい Webhook サブスクリプションを作成します。
訪問者の更新	update-visitor	ID で訪問者を更新します。
オペレーターの更新	update-operator	ID でオペレーターを更新します。
Webhook の更新	update-webhook	ID で Webhook を更新します。
メッセージの更新	update-message	メッセージイベントを更新します。
オペレーターのステータスの更新	update-operator-status	オペレーターのステータスを設定します。
訪問者の最新チャットの更新	update-visitor-last-chat	訪問者の現在のチャット、または直近のチャットを更新します。
メッセージの送信	send-message	メッセージイベントを作成します。
訪問者の削除	delete-visitor	ID で訪問者を削除します。
オペレーターの削除	delete-operator	ID でオペレーターを削除します。

アクションの実行

membrane action run <actionId> --connectionId=CONNECTION_ID --json

JSON パラメーターを渡すには：

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

結果はレスポンスの output フィールドに含まれます。

プロキシリクエスト

利用可能なアクションでユースケースに対応できない場合は、Membrane のプロキシを通じて Chaport API に直接リクエストを送信できます。Membrane は指定したパスにベース URL を自動的に追加し、有効期限が切れた際の透過的な認証情報の更新を含め、適切な認証ヘッダーを挿入します。

membrane request CONNECTION_ID /path/to/endpoint

よく使われるオプション：

フラグ	説明
-X, --method	HTTP メソッド（GET、POST、PUT、PATCH、DELETE）。デフォルトは GET です
-H, --header	リクエストヘッダーを追加します（繰り返し指定可能）。例：-H "Accept: application/json"
-d, --data	リクエストボディ（文字列）
--json	JSON ボディを送信し、Content-Type: application/json を設定する簡易指定です
--rawData	処理を行わず、ボディをそのまま送信します
--query	クエリ文字列パラメーター（繰り返し指定可能）。例：--query "limit=10"
--pathParam	パスパラメーター（繰り返し指定可能）。例：--pathParam "id=123"

ベストプラクティス

• 外部アプリとの通信には常に Membrane を使用してください — Membrane は認証、ページネーション、エラー処理を組み込んだ事前構築済みのアクションを提供します。トークンの消費を抑え、より安全に通信できます
• 実装する前に見つけてください — カスタム API 呼び出しを記述する前に、membrane action list --intent=QUERY を実行し（QUERY は実現したい内容に置き換えます）、既存のアクションを確認してください。事前構築済みのアクションは、生の API 呼び出しでは対応できないページネーション、フィールドマッピング、特殊なケースを処理します。
• 認証情報の管理は Membrane に任せてください — API キーやトークンをユーザーに求めないでください。代わりに接続を作成してください。Membrane がローカルにシークレットを保持することなく、サーバー側で認証ライフサイクル全体を管理します。