顧客チャットAPI連携
自社システムに顧客対応チャットを追加。Node.js・PHPからAPIで簡単連携。
顧客チャットAPI連携顧客チャットの独自開発には、多くの周辺実装が必要です
会話画面だけでは完成しない
認証、通知、添付、履歴、未読管理など、運用に必要な機能まで設計する必要があります。
保守とセキュリティが続く
リリース後も依存関係の更新、障害対応、アクセス制御の見直しが発生します。
既存業務との接続が難しい
受注や問い合わせの情報と、チャット上の案件を重複なく結び付ける仕組みが必要です。
ChatEaseで解決
既存システムは受付に集中し、やり取りはChatEaseへ
ChatEase APIは、顧客情報、任意の一意キー、初期ステータス、初回投稿を受け取り、案件ごとのチャットボードを生成します。
案件ごとのボードを生成
注文、見積依頼、サポート受付などのイベントから、顧客専用チャットを作成できます。
重複生成を防止
boardUniqueKeyへ注文IDなどを指定し、同じ案件の再送による重複作成を防げます。
初期状態まで設定
対応ステータス、期限、問い合わせ本文を含めた状態から担当者の運用を開始できます。
Node.js・PHPに対応
入力チェックを備えたnpmパッケージとComposerパッケージをサーバーサイドで利用できます。
システム連携の構成
APIトークンは自社システムのサーバー側で保持し、ブラウザから直接ChatEase APIを呼び出さない構成にします。
- STEP 1
業務イベントが発生
問い合わせ受付、注文登録、会員手続きなどを連携の起点にします。
- STEP 2
サーバーからAPIを実行
Node.jsまたはPHPのサーバーで認証情報とリクエストを組み立てます。
- STEP 3
チャットボードを生成
ChatEaseがhostURLとguestURLを返し、案件別のやり取りを開始できます。
- STEP 4
顧客へ案内
自社の通知処理でguestURLを案内するか、スタッフの投稿を起点にChatEaseから通知します。
既存の業務フローに合わせて組み込めます
Webエンジニア
型定義や実行時チェックを備えたクライアントから、ボード生成APIを利用できます。
制作・開発会社
顧客ごとに異なる受付システムを活かしながら、問い合わせ後のチャット運用を共通化できます。
サーバーサイド実装例
Node.js・PHPの公式クライアントから利用できます
APIトークンは環境変数などで管理し、ブラウザへ露出させないでください。
Node.jsでチャットボードを生成
npm install @bagooon/chatease-node-clientimport { ChatEaseClient } from '@bagooon/chatease-node-client'
const chatease = new ChatEaseClient({
apiToken: process.env.CHATEASE_API_TOKEN!,
workspaceSlug: 'your-workspace-slug',
})
const board = await chatease.createBoardWithStatusAndMessage({
title: 'お問い合わせ #1001',
guest: {
name: '田中太郎',
email: 'taro@example.com',
},
boardUniqueKey: 'contact-1001',
initialStatus: {
statusKey: 'scheduled_for_response',
timeLimit: '2026-11-01',
},
initialGuestComment: {
content: 'サービスについて相談したいです。',
},
})
console.log(board.guestURL)PHPでチャットボードを生成
composer require bagooon/chatease-php-client<?php
use Bagooon\ChatEase\ChatEaseClient;
require __DIR__ . '/vendor/autoload.php';
$client = new ChatEaseClient(
apiToken: getenv('CHATEASE_API_TOKEN'),
workspaceSlug: 'your-workspace-slug'
);
$board = $client->createBoardWithStatusAndMessage([
'title' => 'お問い合わせ #1001',
'guest' => [
'name' => '田中太郎',
'email' => 'taro@example.com',
],
'boardUniqueKey' => 'contact-1001',
'initialStatus' => [
'statusKey' => 'scheduled_for_response',
'timeLimit' => '2026-11-01',
],
'initialGuestComment' => [
'content' => 'サービスについて相談したいです。',
],
]);
echo $board['guestURL'];導入方法
導入の基本手順
ワークスペースの認証情報をサーバー環境へ設定し、業務イベントからクライアントを呼び出します。
- 1
ワークスペースを作成
ChatEaseへ登録し、連携先となるワークスペースを用意します。
- 2
API情報を確認
ワークスペース管理画面でスラッグとAPIトークンを確認します。
- 3
ライブラリを導入
Node.jsではnpm、PHPではComposerから公式クライアントを追加します。
- 4
サーバー側へ実装
APIトークンを環境変数などで安全に保持し、受付処理からボード生成メソッドを呼び出します。