POST https://qw-openapi-tx.dustess.com/ai/v1/agent/msg/sendMsg?accessToken=
Content-Type: application/json| 请求参数名 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| chatID | int64 | 会话ID | true |
| userID | int64 | 托管员工ID | true |
| msgs | []object | 消息内容 | true |
| msgs.msgType | int32 | 消息类型。0=文本,1=图片,2=语音,3=文件,4=视频,6=地理位置,8=撤回消息,9=链接消息,10=小程序消息 | true |
| msgs.contents | []string | 消息内容 | true |
| msgs.fileURL | string | 资源地址。图片、语音、文件、视频等类型消息需要 | false |
| msgs.replyMsgID | []int64 | 被回复的消息ID数组 | false |
特殊的消息格式,在contents中传递
@操作,格式如下:
1.@0代表@所有人,其他为@具体的人
2. 如果@的ID不存在,则会直接文本输出
3. @ 这一行不可以插入换行符,其他行可以在任意位置插入
[
"@0",
"\n门前大桥下",
"游过一群鸭\n",
"@7881303606911525",
"\n快来快来数一数\n24678"
]引用另一条消息,只能是文本类型的消息,格式如下:1. 只能引用一条消息 2. #行不可以插入换行符,其他行可以在任意位置插入 3. 如果引用的消息不存在,则会直接文本输出
[
"#7881303606911525",
"\n门前大桥下",
"\n游过一群鸭"
]位置消息,将序列化的json字符串放在contents中,只取第一个值
[
"{\"address\":\"福建省厦门市集美区侨英街道龙荷二里万科云城15-38号\",\"latitude\":24.604396,\"longitude\":118.078909,\"name\":\"微风乐集·听风的歌(万科云城店)\",\"precision\":0.0}"
]链接消息,将序列化的json字符串放在contents中,只取第一个值
[
"{\"desc\":\"百度\",\"thumbUrl\":\"https://picx.zhimg.com/v2-d6f44389971daab7e688e5b37046e4e4_720w.jpg?source=172ae18b\",\"title\":\"百度首页\",\"url\":\"https://www.baidu.com\"}"
]小程序消息,将序列化的json字符串放在contents中,只取第一个值
[
"{\"appName\":\"成都地铁乘车码\",\"appid\":\"wx1b5e2763b9c1e06e\",\"desc\":\"成都地铁乘车码\",\"pagePath\":\"pages/index/index.html\",\"thumbUrl\":\"https://xxx.jpg\",\"thumbWidth\":720,\"title\":\"成都地铁乘车码\",\"type\":2,\"username\":\"gh_27bdf69a27bb@app\",\"weappIconUrl\":\"http://mmbiz.qpic.cn/mmbiz_png/vOGI97uF6r4Oz6aeWdPLgP7D34XiaNaHz7iadb8dc4YE69BqmUsmUIovF8vdAibMnhvpg7Yk1S4yqRzhzYAsjuwiaA/640?wx_fmt=png\\u0026wxfrom=200\"}"
]json - Request-Example: {
"chatID": 456835883123867648,
"userID": 425332961907318784,
"msgs": [
{
"msgType": 0,
"contents": ["你好"],
"fileURL": "",
"replyMsgID": []
}
]
}
| 响应参数名 | 类型 | 说明 |
|---|---|---|
| code | int64 | 响应码,0=成功 |
| msg | string | 消息提示 |
| success | string | 是否成功请求 |
| traceId | string | 请求链路id |
| data.msg | []object | 消息 |
| data.msg.id | int64 | 消息ID |
| data.msg.chatID | int64 | 会话ID |
| data.msg.talkerID | int64 | 消息发送人ID |
| data.msg.talkerName | string | 消息发送人名称 |
| data.msg.talkerType | int64 | 消息发送人类型,0 员工,1 客户,2 AI,3 员工回复,4 专家组回复 |
| data.msg.talkerAvatar | string | 消息发送人头像 |
| data.msg.userID | int64 | 托管账号员工ID |
| data.body.msg.content | string | 消息内容 |
| data.body.msg.file_url | string | 资源文件 地址 (文件链接有效期15分钟,需下载储存 ) |
| data.body.msg.msg_type | int32 | 消息类型。0=文本,1=图片,2=语音,3=文件,4=视频,6=地理位置,8=撤回消息,9=链接消息,10=小程序消息 |
| data.body.msg.msg_status | int32 | 消息状态。0 未知,1 正常,2 删除,3 撤回 |
| data.body.msg.create_ts | int64 | 消息时间(毫秒时间戳) |
{
"code": 0,
"msg": "OK",
"success": true,
"data": {
"msg": [
{
"id": 456836342970580992,
"chatID": 456835883123867648,
"talkerID": 456835883115479040,
"talkerName": "寒江钓雪的马甲",
"talkerAvatar":"",
"talkerType": 2,
"userID": 4568363429706765445
"content": "你好",
"fileURL":"",
"msgType":0,
"msgStatus": 1,
"createTs": 1757574266324,
"senderType": 1
}
]
},
"traceId": "1601ca8f-1ee0-9725-81ba-d49016bc1a34"
}{
"code": 20170303,
"msg": "会话不存在",
"success": false,
"data": {},
"traceId": "88146ad5-ac5f-9758-9ebb-0f13eb8ae973"
}