はじめに

sem.chat API を使用すると、プログラムで会話を管理し、メッセージを送信し、分析にアクセスできます。すべての API リクエストには、API キーを使用した認証が必要です。

ベース URL

https://api.sem.chat/v1

認証

すべてのリクエストの Authorization ヘッダーに API キーを含めます。

Authorization: Bearer your_api_key_here

会話

会話のリスト化

GET /会話

アカウントのすべての会話のリストを取得します。

パラメータ タイプ 説明
限界 整数 返される結果の数 (最大 100)
オフセット 整数 スキップする結果の数
ステータス 文字列 ステータスによるフィルター: アクティブ、クローズ、保留中

会話を得る

GET /会話/{id}

すべてのメッセージを含む特定の会話の詳細を取得します。

会話を作成する

POST /会話

プログラムで新しい会話を開始します。

メッセージ

メッセージを送信する

POST /conversations/{id}/messages

既存の会話にメッセージを送信します。

// Example request body { "content": "Hello, how can I help you today?", "sender": "agent" }

Webhook

会話イベントに関するリアルタイム通知を受信するように Webhook を設定します。

利用可能なイベント

イベント 説明
会話が始まりました 新しい会話が開始されました
メッセージを受信しました 訪問者から新しいメッセージを受け取りました
会話.クローズ 会話が終了しました
リード、捕獲 連絡先情報を収集しました

レート制限

API リクエストは、公正な使用を保証するために制限されています。

計画 レート制限
トライアル 100 リクエスト/時間
プロ 1,000 リクエスト/時間
ビジネス 10,000 リクエスト/時間