メインコンテンツへスキップ

リクエストパラメータ

メイン構造

パラメータ必須説明
clientstringはいビジネス識別子。MarsMind と確認してください
signaturestringはい署名。下記アルゴリズム参照
timestampintはいタイムスタンプ(Unix 秒)
message_infoobjectはいメッセージ詳細。以下フィールドを参照

message_info フィールド

フィールド必須説明
msg_idstringassist_dialog では必須メッセージ ID。assist_dialog の場合必須
group_idstringシナリオによるグループチャット ID。from_user_id と group_id が両方空の場合は 400 エラー
group_namestringいいえグループ名
from_user_idstringはい送信者 ID
from_user_nicknamestringいいえ送信者のニックネーム
to_user_idstringいいえ受信者 ID
to_user_nicknamestringいいえ受信者のニックネーム
at_liststring[]いいえ@ 対象ユーザー ID リスト(auto_dialog のみ対応)
contentstringcontent または files_info 必須メッセージ本文
message_typeintはい1 = 通常メッセージ、2 = 引用メッセージ
event_typestringはいauto_dialog | assist_dialog | website_dialog | cmd_dialog
from_user_typeintauto_dialog では必須1=特定アカウントに紐付く 2=顧客 3=カスタマーサポート 4=AI メッセージ
create_timestampintはいメッセージ作成時間(Unix タイムスタンプ)
files_infoFile[]content または files_info 必須添付ファイル一覧。下表参照
quoteobjectmessage_type=2 の場合必須引用メッセージオブジェクト。msg_id、message_type を含む必要あり

files_info 構造

フィールド必須説明
contentstring (URL/base64)はいファイル URL または base64 データ
file_type”image”/“document”/“voice”はいファイルタイプ

会話シナリオの種類

auto_dialog(自動対話)

  • event_type = auto_dialog
  • send_url を提供し、MarsMind が自動で送信ロジックを制御
  • テキスト・画像・ファイルをサポート(リクエストごとに 1 種類のみ)
from_user_type 設定ガイドライン:
  • 特定ユーザーに紐付く場合:AI 以外のメッセージはすべて 1
  • 特定ユーザーに紐付かない場合:外部顧客は 2、自社スタッフは 3

assist_dialog(補助対話)

  • event_type = assist_dialog
  • リアルタイムで結果を返却
  • auto_dialog と同一のパラメータであれば、既存のコンテキストを利用

website_dialog(Web 対話)

  • event_type = website_dialog
  • 即時に結果を返却し、会話履歴に追加
  • send_url は利用不可

cmd_dialog(コマンド制御)

  • event_type = cmd_dialog
  • content にコマンドを指定。現在サポートしているのは:
    • stop_auto_reply:自動返信を停止(auto_dialog シナリオのみ有効)

利用例

auto_dialog

curl -X POST http://127.0.0.1:7002/custom-im/chat-messages \
-H "Content-Type: application/json" \
-d '{
  "client": "test",
  "signature": "d97b383a532466b6c6c451e76a2ab57b",
  "timestamp": 1748584621,
  "message_info": {
    "content": "",
    "message_type": 1,
    "group_id": "98765@chatroom",
    "event_type": "auto_dialog",
    "from_user_id": "aa123",
    "from_user_type": 2,
    "msg_id": "9005",
    "create_timestamp": 1748584621,
    "files_info": [
      { "content": "https://example.com/img.png", "file_type": "image" }
    ]
  }
}'