開発者向け
チャットサポートAPI
AIチャットやFAQ応答をEC・店舗アプリに統合し、顧客体験を向上させます。セッション管理、メッセージ送受信、履歴取得に対応しています。
api/v1/store/chat
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/store/chat/sessions/{id}
|
チャットセッション詳細を取得
参加者や最終メッセージを含むセッション情報を取得します。
|
200 404 |
| GET |
/api/v1/store/chat/sessions/search
|
チャットセッションを検索
顧客、ステータス、チャネルで既存セッションを検索します。
|
200 |
| POST |
/api/v1/store/chat/sessions
|
新しいチャットセッションを作成
顧客とサポート担当者の間で新しいチャットセッションを開始します。
|
200 |
| POST |
/api/v1/store/chat/sessions/{id}/message
|
メッセージを送信
顧客、エージェント、またはAIアシスタントからのメッセージを送信します。
|
200 |
| GET |
/api/v1/store/chat/sessions/{id}/messages
|
チャット履歴を取得
セッション内のすべてのメッセージを時系列で取得します。
|
200 |
| POST |
/api/v1/store/chat/sessions/{id}/close
|
チャットセッションを終了
セッションを終了し、メッセージをアーカイブします。
|
200 404 |
エンドポイント詳細
参加者や最終メッセージを含むセッション情報を取得します。
完全パス：
GET /api/v1/store/chat/sessions/{id}
レスポンスコード：
200
404
顧客、ステータス、チャネルで既存セッションを検索します。
完全パス：
GET /api/v1/store/chat/sessions/search
レスポンスコード：
200
顧客とサポート担当者の間で新しいチャットセッションを開始します。
完全パス：
POST /api/v1/store/chat/sessions
レスポンスコード：
200
顧客、エージェント、またはAIアシスタントからのメッセージを送信します。
完全パス：
POST /api/v1/store/chat/sessions/{id}/message
レスポンスコード：
200
セッション内のすべてのメッセージを時系列で取得します。
完全パス：
GET /api/v1/store/chat/sessions/{id}/messages
レスポンスコード：
200
セッションを終了し、メッセージをアーカイブします。
完全パス：
POST /api/v1/store/chat/sessions/{id}/close
レスポンスコード：
200
404
リクエスト例
リクエスト
POST /api/v1/store/chat/sessions/{id}/message
Authorization: Bearer {access_token}
{
"sender": "customer",
"text": "注文の配送状況を教えてください"
}
レスポンス
{
"messageId": "msg-456",
"sessionId": "sess-123",
"sender": "ai",
"text": "注文 #ORD-001 は現在配送中です。明日到着予定です。",
"timestamp": "2025-03-20T15:30:00Z"
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。