チャットボード新規追加 API

チャットボードの生成を、外部サービスや社内システムから自動で行うためのAPIです。
※無料でご利用いただけます。

チャットボード新規追加 APIで実現できること

  • 外部サービスや社内システムからチャットボードを自動生成できます。

  • チャットボード生成時に進行ステータスを指定できます。
    例）注文時に連携：注文後に校正を提示する場合などに、あらかじめ校正予定日をセットしたチャットボードを用意できる。TODO管理も兼ねられる。

  • チャットボード生成時にお客様のコメントを登録できます。
    例）問合せフォームと連携：お客様からの問合せ内容が書き込まれた状態からチャットボードを使い始められる。

開発用キット

new! - node.js用のパッケージ（npm）を公開しました。
@bagooon/chatease-node-client

npm versionCILicense: MIT

new! - PHP用のパッケージ（Composer）を公開しました。
bagooon/chatease-php-client

CILatest VersionPHP Version

エンドポイント

POST https://chatease.jp/api/v1/board

認証

リクエストには、APIトークンをヘッダーに含める必要があります。

  • APIトークンはワークスペース毎に設定されています。

  • APIトークンはワークスペースの管理画面で確認できます。

// 認証ヘッダー X-Chatease-API-Token: {{ YOUR_API_TOKEN }}

よくある質問

Q: boardUniqueKey を付ける理由は？
A: 既に同一案件でボードが作成されている場合、重複作成を防ぐために一意なキーを指定します。

Q: APIの利用に料金はかかりますか？
A: 無料でご利用いただけます。

Q: チャットボードを追加すると同時に顧客に通知されますか？
A: いいえ。コメントを書き込むまで通知されません。

リクエストボディ（JSON形式）

以下の項目をJSONで送信してください。新しいチャットボードが生成されます。

各項目の説明（A）

フィールド名

必須

説明

workspaceSlug

○

チャットボードを作成する対象のワークスペーススラッグ

title

○

ボードの名称（案件名、テーマなど）

guest.name

○

顧客の氏名

guest.email

○

顧客のメールアドレス

memo

--

メモ（任意のテキスト）

boardUniqueKey

○

案件毎に一意な識別子を指定。再送時の重複防止に使用。
注文ID等、注文に紐づいたユニークな値を指定。

- 英数字を推奨（大文字・小文字は区別されます）
- スペースは使用不可
- データベースの 128 文字長制限を超えない値

inReplyTo

--

返信対象のメールメッセージID（省略可）

guestPassphrase

--

合言葉（省略可）
全角換算10文字以内

{ "workspaceSlug": "YOUR_WORKSPACE_SLUG", "title": "案件名や目的などのボード名", "guest": { "name": "顧客名", "email": "guest@example.com" }, "memo": "メモ情報", "boardUniqueKey": "ORDER_UNIQUE_KEY", "inReplyTo": "optional-message-id", "guestPassphrase": "合言葉" }

レスポンス例

成功すると、以下のようなボード情報が返却されます。

注意事項

  • 重複した boardUniqueKey でリクエストした場合、既存のチャットボード情報が返却されます（新たに作成はされません）。

  • guestURL は顧客用チャットページのリンクです。

  • hostURL は社内担当者用のリンクです。（要ログイン）

{ "slug": "45m7hwtr4p8qdthdrput5jem", "hostURL": "https://chatease.jp/boards/45m7hwtr4p8qdthdrput5jem/host", "guestURL": "https://chatease.jp/boards/45m7hwtr4p8qdthdrput5jem" }

利用例（cURL）

curl -X POST https://chatease.jp/api/v1/board \ -H "Content-Type: application/json" \ -H "X-Chatease-API-Token: YOUR_API_TOKEN" \ -d '{ "workspaceSlug": "your_workspace_slug", "title": "新規ロゴ提案", "guest": { "name": "田中太郎", "email": "taro.tanaka@example.com" }, "boardUniqueKey": "client-20250613-logo" }'

● 指定した進行ステータスでチャットボードを生成する場合

Aの項目に以下の項目を加えて送信してください。進行ステータスを指定できます。

各項目の説明（B）

フィールド名

必須

説明

initialStatus.statusKey

〇

進行ステータスのキー(※）

initialStatus.timeLimit

-

期限日（ex. 2026-01-01）
（ステータスに応じて必要）

※進行ステータスのキーは以下から選択

  • scheduled_for_proof - 校正予定（要期限日）

  • scheduled_for_response - 返答予定（要期限日）

  • scheduled_for_completion - 完了予定（要期限日）

  • waiting_for_reply - 返答待ち

利用例（cURL）

curl -X POST https://chatease.jp/api/v1/board \ -H "Content-Type: application/json" \ -H "X-Chatease-API-Token: YOUR_API_TOKEN" \ -d '{ "workspaceSlug": "your_workspace_slug", "title": "お問合せ(2026-10-10 01:01:01)", "guest": { "name": "田中太郎", "email": "taro.tanaka@example.com" }, "boardUniqueKey": "20261010010101-000", "initialStatus": { "statusKey": "scheduled_for_response", "timeLimit": "2026-10-11" } }' レスポンスはAと同様です。

● お客様（ゲスト）のコメントも登録する場合

AとBに以下の項目を加えて送信してください。お客様のコメントが書き込まれた状態でチャットボードが生成されます。問合せフォームなどと連携すると、最初にお客様からの質問が書き込まれた状態からチャットボードを使い始めることができます。

各項目の説明（C）

フィールド名

必須

説明

initialGuestComment.content

〇

コメント本文

利用例（cURL）

curl -X POST https://chatease.jp/api/v1/board \ -H "Content-Type: application/json" \ -H "X-Chatease-API-Token: YOUR_API_TOKEN" \ -d '{ "workspaceSlug": "your_workspace_slug", "title": "お問合せ(2026-10-10 01:01:01)", "guest": { "name": "田中太郎", "email": "taro.tanaka@example.com" }, "boardUniqueKey": "20261010010101-000", "initialStatus": { "statusKey": "scheduled_for_response", "timeLimit": "2026-10-11" }, "initialGuestComment": { "content": "〇〇の点について質問があります...." } }' レスポンスはAと同様です。