8 AI 介面#
8.1 發送訊息並取得AI回覆#
PUT /ai/message/send
POST /ai/message/send
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| attachment | string | false | 附件：如果訊息類型為圖片/語音/視訊/檔案時需要設定此欄位。格式如:{"url":"https://xxx" ,"dName":"1658890327124.amr","fLen":1670,"duration":1}{"url":"https://xxx" ,"dName":"1646751218948","fLen":508728,"width":828.0,"height":828.0} | |
| config | string | false | SDK使用的擴展欄位 | |
| content | string | true | 訊息內容 | |
| content_type | int32 | true | 訊息類型 TEXT = 0; IMAGE = 1; AUDIO = 2; VIDEO = 3; FILE = 4; LOCATION = 5; COMMAND = 6; FORWARD = 7; READ_ACK = 9; RECALL = 10; APPEND = 11; REPLACE = 12; | |
| ext | string | false | 擴展欄位 | |
| from_user_id | int64 | false | 發送者的使用者ID | |
| online_only | boolean | false | 是否只發給線上使用者(預設為false)： true - 只發給線上使用者； false - 發給線上和離線使用者 | |
| related_mid | int64 | false | 訊息操作相關的訊息ID： 如何訊息類型為READ_ACK/RECALL時需要設定此欄位，表示已讀或撤回的訊息ID | |
| targets | array[int64] | true | 接收使用者ID或群ID | |
| transaction_id | int64 | false | 請求ID，用於訊息去重， 如果短時間內收到2個相同transaction_id的請求，第二次請求不會被執行。 如果不設定就不會被去重 | |
| type | int32 | true | 目標類型，1 - 普通使用者，2 - 群組 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ message_quota_usage | double | 消耗智慧訊息條數 |
| ⇥ messages | array[object] | 訊息列表 |
| ⇥⇥ attachment | string | 訊息附件: 訊息類型為圖片/語音/視訊/檔案時，此欄位會包括檔案地址 |
| ⇥⇥ config | string | SDK層使用的擴展欄位 |
| ⇥⇥ content | string | 訊息內容 |
| ⇥⇥ ctype | string | 訊息內容類型: TEXT - 文本, IMAGE - 圖片, AUDIO - 語音, VIDEO - 視訊, FILE - 檔案, LOCATION - 位置, COMMAND - 自定義， FORWARD 轉發訊息 |
| ⇥⇥ ext | string | 擴展欄位 |
| ⇥⇥ from_xid | object | 訊息發送者 |
| ⇥⇥⇥ device_sn | int32 | 設備序號 |
| ⇥⇥⇥ uid | int64 | 使用者ID |
| ⇥⇥ msg_id | int64 | 訊息ID |
| ⇥⇥ timestamp | int64 | 訊息發送時間戳（毫秒） |
| ⇥⇥ to_xid | object | 訊息接收者 |
| ⇥⇥⇥ device_sn | int32 | 設備序號 |
| ⇥⇥⇥ uid | int64 | 使用者ID |
| ⇥⇥ type | string | 訊息類型：CHAT- 單聊 ，GROUPCHAT - 群聊 |
| message | string | 錯誤信息，如果成功，該項為null |