项目聊天对话-接入api
描述:根据项目消息对话接入api
消息对话登录
请求Url:https://aics.vanke.com/aics/message/project/login
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "projectNo":String //项目编号 必填 "userId":String//用户ID 必填 "userName":String//用户名称 必填 "email":String//邮箱 "photoUrl":String//头像地址 "mobile":String//手机号码 }
返回结果格式
{ "data": { "projectNo":String //项目编号 "userId":String//用户ID "userName":String//用户名称 "email":String//邮箱 "photoUrl":String//头像地址 "mobile":String//手机号码 } , "success":boolean "errorCode":int "errorMsg":String }
消息对话登出
请求Url:https://aics.vanke.com/aics/message/project/logout
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
返回结果格式
{ "data":String , "success":boolean "errorCode":int "errorMsg":String }
提示信息
请求Url:https://aics.vanke.com/aics/message/project/promptWord
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
Params
参数 名称 类型 是否必填 说明 projectNo 项目编号 String 是
返回结果格式
{ "data": { "avatarUrl":String//头像地址 "name":String//名称 "userAvatarUrl":String//用户头像地址 "messageId":String//消息ID "messagePrompt":String//消息提示词 } , "success":boolean "errorCode":int "errorMsg":String }
发送消息
请求Url:https://aics.vanke.com/aics/message/project/sendMessage
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "pluginIds":List//插件ID列表 "messageId":String//会话ID "customParameters":String//自定义参数 "projectNo":String//项目编号 必填 "userId":String// 用户ID "content":String//消息内容 必填 }
返回结果格式
{ "data": { "id":Integer//消息记录ID "responseType":String//响应类型 "responseContent":Object//响应内容 "messageId":String//会话ID "questionSuggestions":List//问题建议 "knowledge":List//知识ID集合 } , "success":boolean "errorCode":int "errorMsg":String }{ "responseType": "text" , // 普通文本 "responseContent": "普通文本" }{ "responseType": "style_text", // 样式文本 "responseContent": { "content": "样式文本", "color": "black", "background": "", "iconUrl": "", "redirectUrl": "" } }{ "responseType": "image_text", // 图文样式 "responseContent": { "title": "您好，基于您的需求推荐以下商品和服务搜索结果", "articles": [{ "title": "点洁方形智能马桶盖 F6B", "description": "适配方形马桶,智能遥控款，语音控制，五星抗压强度", "picUrl": "https://img2.4009515151.com/2023/04/26/8n7f97rtfp96wlh.jpg", "action": "￥7400", "redirectUrl": "https://neighbor.4009515151.com/nova/product-detail/74640" }] } }{ "responseType": "template_card", // 卡片样式 "responseContent": { "title": "您好，基于您的位置信息提供以下周边搜索结果", "articles": [{ "title": { "iconUrl": "", "text": "乐宴.老北京铜火锅(香蜜湖1979店)", "desc": "462 米" }, "description": { "iconUrl": "", "text": "广东省 深圳市 福田区 香蜜湖街道香蜜社区北岸B303-0034号1979区1层E1/2", "desc": "" }, "action": { "iconUrl": "", "text": "餐饮服务;中餐厅;火锅店", "desc": "" }, "redirectUrl": "https://restapi.amap.com/v3/staticmap?location=114.031491,22.551679&zoom=13&size=750*300&markers=mid,,A:114.031491,22.551679|mid,0x0000FF,S:114.03264,22.5476608&key=5ef93e4da3dda7513d1e0a1ccc327da3" }] } }{ "responseType": "form_show", // 表单样式 "responseContent": { "name": "创建工单成功", "params": [{ "key": "matterId", "value": "7401035903663418", "name": "编号" }, { "key": "createTime", "value": "2024-01-03 16:23:56", "name": "创建时间" }, { "key": "matterType", "value": "开锁换锁", "name": "工单类型" }] } }
发送消息流式响应
请求Url:https://aics.vanke.com/aics/message/project/stream/subscribe
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "pluginIds":List//插件ID列表 "messageId":String//会话ID "customParameters":String//自定义参数 "projectNo":String//项目编号 必填 "userId":String// 用户ID "content":String//消息内容 必填 }
返回结果格式,响应类型 Content-Type: text/event-stream
{ "data": { "id":Integer//消息记录ID "responseType":String//响应类型 "responseContent":Object//响应内容 "messageId":String//会话ID "questionSuggestions":List//问题建议 "knowledge":List//知识ID集合 } , "success":boolean "errorCode":int "errorMsg":String }
历史会话记录列表
请求Url:https://aics.vanke.com/aics/message/project/listMessageGroup
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
Params
参数 名称 类型 是否必填 说明 projectNo 项目编号 String 是 userId 用户ID String 否
返回结果格式
{ "data":Object "success":boolean "errorCode":int "errorMsg":String }
历史会话分页记录列表
请求Url:https://aics.vanke.com/aics/message/project/listPageMessageGroup
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "projectNo":String//项目编号 必填 "userId":String//用户ID }
返回结果格式
{ "data":Object "success":boolean "errorCode":int "errorMsg":String }
历史消息记录列表
请求Url:https://aics.vanke.com/aics/message/project/listPageRecord
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "messageId":String//消息记录ID 必填 "userId":String //用户ID }
返回结果格式
{ "data":Object "success":boolean "errorCode":int "errorMsg":String }
插件列表
请求Url:https://aics.vanke.com/aics/message/project/listPlugin
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
返回结果格式
{ "data":Object "success":boolean "errorCode":int "errorMsg":String }
保存标记
请求Url:https://aics.vanke.com/aics/message/project/saveMark
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
Params
参数 名称 类型 是否必填 说明 id 消息记录ID Integer 是 mark 标记，SUPPORT:赞，OPPOSE:踩 String 是 state 状态，true:确认，false:取消 Boolean 是 userId 用户ID String 否
返回结果格式
{ "data": Boolean , "success":boolean "errorCode":int "errorMsg":String }
删除历史会话记录
请求Url:https://aics.vanke.com/aics/message/project/deleteMessageGroup
请求方法:get,请求内容类型 Content-Type:
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
Params
参数 名称 类型 是否必填 说明 id 消息记录ID Integer 是
返回结果格式
{ "data": { "avatarUrl":String//头像地址 "name":String//名称 "userAvatarUrl":String//用户头像地址 "messageId":String//消息ID "messagePrompt":String//消息提示词 } , "success":boolean "errorCode":int "errorMsg":String }
执行意图
请求Url:https://aics.vanke.com/aics/message/project/executeIntention
请求方法:post,请求内容类型 Content-Type: application/json
Headers
参数 名称 类型 是否必填 说明 token Authorization String 是 认证密钥;
body参数
{ "id":Integer//意图ID 、不能为空 "params":List//参数列表 }
返回结果格式
{ "data": { "responseType":String//响应类型 "id":Integer//消息记录ID "responseContent":Object//响应内容 } , "success":boolean "errorCode":int "errorMsg":String }