开发文档
总目录
接入常见问题
开发者平台使用帮助
HTTP API接口文档
Chatbot接口指令说明文档
Android SDK用户接入指南
微信公众号客服机器人接入教程
灵聚智能助理app开源说明文档
直播数字人系统用户评论回复接口开发文档
灵聚自定义对话训练API接口说明文档
本站点使用 MrDoc 构建
-
+
HTTP API接口文档
# HTTP API接口文档 ## 1\.前言 本文档是灵聚智能引擎API接口的说明及接入指引 开发者在我司开发者平台open\.lingju\.ai创建应用后,将会得到appkey及authcode用于接入服务: 1. appkey,该appkey对应于开发者在我司开发者平台创建的应用,主要用于accessToken的获取及重置,请开发者妥善保管。 2. authcode,授权码,当开发者将本接口用于量产时,需通过appkey及authcode来获取accessToken。 ## 2\.接口说明 ### 概述 我司目前共开放4个接口,分别是:授权认证接口、聊天应答接口、提醒查询接口、闹钟查询接口。接口调用的一个原则是:授权接口获取accessToken,然后凭此值调用其余接口工作。随着场景的拓展,往后将开放更多的接口,敬请关注开发者平台的公告。 ### 2\.1接口调用说明 接口调用流程见图1:  针对开发者用户唯一性授权的要求,开发者需自行标识自身的用户,为每一个用户配备一个唯一的userid,重复的ID在我司的服务接口中将会引起应答混乱,这一点请开发者牢记。 **请注意:Auth授权的流程建议放在开发者服务端来完成,如上图所示,开发者服务端将获得的accessToken返回到用户端进行机器人对话。此流程不是强制性要求,开发者也可在用户端(app端)进行auth授权获取accessToken,但需注意此做法容易泄漏appkey及授权码,若引发损失请开发者自行负责**。 ### 2\.2授权认证接口 #### 接口路径:https://dev\.lingju\.ai/httpapi/authorize\.do |名称|授权认证接口| |---|---| |接口路径|https://dev\.lingju\.ai/httpapi/authorize\.do| |请求方式|get| #### http get请求示例: ``` https://dev.lingju.ai/httpapi/authorize.do?appkey=xxxxx&userid=xxxx&authcode=xxxxx ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| |userid|String|必填|终端用户的唯一标识,移动设备建议使用mac地址,入网许可号等,注意取值必须为:\[A\-Za\-z0\-9\]。请开发者务必注意区分userid,智能云根据userid标识终端id并实现授权限制及个性化的上下文应答。| |authcode|String|必填|给开发者分配的授权码,由开发者自行管理| #### 接口返回JSON示例: ``` { "description":"success", "data":{ "accessToken":"9dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expires":87, "update":147xxxxxxxxxxxxx, }, "status":0 } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| | |---|---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| | |description|String|通常为空,出错时会有错误信息| | |data|JSON|accessToken|访问码,string| | | |expires|有效期,int,天数| | | |updated|时间戳,long| **请注意:每台设备每个月可调用该接口10次获取“accessToken”,该授权接口获取到的accessToken有效期是30天,开发者只需要定时每30天获取一次“accessToken”保存下来提供给聊天接口调用即可。该接口的流程建议放在开发者服务端来完成,开发者服务端将获得的“accessToken”返回到用户端进行机器人对话。该流程不是强制性要求,开发者也可在用户端(app端)进行auth授权获取“accessToken”,但需注意此做法容易泄漏appkey及授权码,若引发损失请开发者自行负责**。 ### 2\.3聊天接口 #### 接口路径:https://dev\.lingju\.ai/httpapi/ljchat\.do |名称|聊天接口| |---|---| |接口路径|https://dev\.lingju\.ai/httpapi/ljchat\.do| |请求方式|post| #### http post请求示例: ``` post https://dev.lingju.ai/httpapi/ljchat.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "accessToken":"xxxxxxxxxxxxxxxxxxxxxx", "input":"今天天气怎么样", "lat":"23.12635", "lng":"113.38776", "city":"广州", "position":"广东广州" } ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |accessToken|String|必填|分配给开发者的专属appkey,请妥善保管| |input|String|必填|文本输入,长度:\[1,300\],取值:普通标点符号及中英文数字| |city|String| |城市(该字段如果有参数,必须跟“lat”以及“lng”一起传才有效)| |lat|double| |纬度| |lng|double| |经度| |position|String| |具体位置| #### 接口返回JSON示例: ``` 普通回复: { "answer":"广州今天天气预报说“大雨”,出门最好带上伞。", "status":0 } 带指令的回复: { "answer":"{\"rtext\":\"好的\",\"outc\":0, \"actions\":[{\"action\":\"QUERY\", \"target\":{\"recyle\":0,\"id\":100,\"singer\":[\"周杰伦\"],\"release\":0,\"type\":\"歌曲\"}, \"hints\":{ \"success\":{\"text\":\"好的,为您播放周杰伦的歌\"}, \"failure\":{\"text\":\"抱歉,我找不到周杰伦的歌\"}, \"notsupport\":{\"text\":\"抱歉,我没办法播放歌曲\"} } }, {\"action\":\"SET\", \"target\":{\"id\":300,\"origin\":\"QUERY\",\"control\":\"PLAY\",\"type\":\"AUDIO\"}}]}", "status":0 } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| |---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| |description|String|通常为空,出错时会有错误信息| |answer|String|取值为字符串,有可能是纯文本内容,也有可能是json格式的字符串。如果是json格式字符串,需自行转换为json对象解析(json对象数据结构请参考[Chatbot接口指令说明文档](/project-2/doc-8/#h1-Chatbot接口指令说明文档))。| ### 2\.4提醒事项查询 #### 接口路径:https://dev\.lingju\.ai/httpapi/future\_todo\.do |名称|提醒记录查询接口| |---|---| |接口路径|https://dev\.lingju\.ai/httpapi/future\_todo\.do| |请求方式|get/post| #### http get请求示例: ``` https://dev.lingju.ai/httpapi/future_todo.do?accesstoken=xxxxxxxxxx ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |accesstoken|String|必填|授权接口获取的accessToken| #### 接口返回JSON示例: ``` { "content":[ { "sid":"594348ad641df31ab40f051f", "recyle":0, "created":1497581741624, "content":"XXXXXX", "remindTime":1497657600584, "frequency":0, "valid":1, "scheduler":[ { "when":1497657600584, "interval":0 } ], "timestamp":1497581741624 } ], "status":0 } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| | | | |---|---|---|---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| | | | |description|String|通常不存在,出错时会返回错误信息| | | | |content|JSON数组|content|提醒内容,string| | | | | |sid|提醒记录的服务端ID| | | | | |created|创建时间| | | | | |recyle|是否已被回收,1=已删除,0=可用| | | | | |remindTime|已废弃,提醒时间| | | | | |frequency|已废弃,频率| | | | | |valid|开关,是否有效,1=开| | | | | |scheduler|JSON数组,定时方案集合,|when|触发时间,long| | | | | |interval|间隔时间| | | | | |unit|时间时间的单位:MS:毫秒,S:秒,MI:分钟,H:小时,D:日,M:月,Y:年| ### 2\.5闹钟记录查询 #### 接口路径:https://dev\.lingju\.ai/httpapi/future\_clock\.do |名称|闹钟记录查询接口| |---|---| |接口路径|https://dev\.lingju\.ai/httpapi/future\_clock\.do| |请求方式|get/post| #### http get请求示例: ``` https://dev.lingju.ai/httpapi/future_clock.do?accesstoken=xxxxxxxxxx ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |accesstoken|String|必填|授权接口获取的accessToken| #### 接口返回JSON示例: ``` { "content":[ { "sid":"59448c21b2765b5e72a42638", "recyle":0,"created":1497664545383, "remindTime":1497657645368, "frequency":8, "valid":1, "item":"闹钟", "scheduler":[ { "when":1497657645368, "interval":1, "unit":"D" } ], "timestamp":1497664545383 } ], "status":0 } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| | | | |---|---|---|---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| | | | |description|String|通常不存在,出错时会返回错误信息| | | | |content|JSON数组|item|闹钟类型:闹钟、工作日、周末;string| | | | | |sid|提醒记录的服务端ID,16进制字符| | | | | |timestamp|创建时间,long| | | | | |recyle|是否已被回收,1=已删除,0=可用| | | | | |remindTime|已废弃,提醒时间| | | | | |frequency|已废弃,频率| | | | | |valid|开关,是否有效,1=开| | | | | |scheduler|JSON数组,定时方案集合,|when|触发时间,long| | | | | |interval|间隔时间| | | | | |unit|时间时间的单位:MS:毫秒,S:秒,MI:分钟,H:小时,D:日,M:月,Y:年| ### 2\.6获取音频播放链接 #### 接口路径:https://dev\.lingju\.ai/httpapi/audioUrl\.do |名称|获取音频播放链接| |---|---| |接口路径|https://dev\.lingju\.ai/httpapi/audioUrl\.do| |请求方式|post| #### http post请求示例: ``` post https://dev.lingju.ai/httpapi/audioUrl.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "accessToken":"xxxxxxxxxxxxxxxxxxxxxx", "type":"xxxxxx", "id":“xxxxxx" } ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |accessToken|String|必填|分配给开发者的专属appkey,请妥善保管| |type|String|必填|音频类型:(取值参考下面音频类型表)| |id|String|必填|音频id| |音频类型|取值| |---|---| |新闻|NEWS| |音乐|MUSIC| |……|……| #### 接口返回JSON示例: ``` { "status":"0", "url":"xxxxxxxxxxxx" } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| |---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| |description|String|通常为空,出错时会有错误信息| |url|String|音频链接| ### 2\.7设备信息同步接口 #### 接口路径:https://dev\.lingju\.ai/httpAuthApi/uploadEquipments\.do |名称|设备信息同步接口| |---|---| |接口路径|https://dev\.lingju\.ai/httpAuthApi/uploadEquipments\.do| |请求方式|post| #### http post请求示例: ``` post https://dev.lingju.ai/httpAuthApi/uploadEquipments.do json格式串行化post上传,注意请求的header需添加 'Content-Type':'application/json;charset=UTF-8' { "appkey":"xxxxxxxxxxxxxxxxxxxxxx", "userid":"XXXXXXXXXXXXXXXXXXXXXX", "authcode":"XXXXXXXXXXXXXXXXXXXX", "data":[{ "equip_id":"d1", "name":"灯1", "alias":"厨房灯", "id":301, "equip_location":"厨房", "equip_type":1000, "status":"OPEN", "brightness":{"type":0,"progress":"80"}, "color":"RED", "colortemp_value":2700, "model_id":"345678", "model_name":"睡眠模式", "contextual_model":[ {"model_id":"123456","model_name":"阅读模式"}, {"model_id":"345678","model_name":"睡眠模式"} ] }, { "equip_id":"d2", "name":"灯2", "alias":"厕所灯", "id":301, "equip_location":"厕所", "equip_type":1000, "status":"OPEN", "brightness":{"type":0,"progress":"30"}, "color":"BLUE", "colortemp_value":2300, "model_id":"789456", "model_name":"变幻模式", "contextual_model":[ {"model_id":"987456","model_name":"温馨模式"}, {"model_id":"789456","model_name":"变幻模式"} ] }, { "equip_id":"k1", "name":"空调", "alias":"卧室空调", "id":301, "equip_location":"卧室", "equip_type":1001, "status":"OPEN", "mode":"ZHILENG", "temperature":{"type":0,"progress":"18"} } ] } ``` #### 请求参数说明: |参数|数据类型|可需|描述| |---|---|---|---| |appkey|String|必填|分配给开发者的专属appkey,请妥善保管| |userid|String|必填|终端用户的唯一标识,移动设备建议使用mac地址,入网许可号等,注意取值必须为:\[A\-Za\-z0\-9\]。请开发者务必注意区分userid,智能云根据userid标识终端id并实现授权限制及个性化的上下文应答。| |authcode|String|必填|给开发者分配的授权码,由开发者自行管理| |data|List|必填|IoT对象集合,IoT对象数据结构请参照下方IoT对象字段说明| | | | | | | | | | | #### 接口返回JSON示例: ``` { "status":0 } ``` #### 接口返回说明: ``` Content-Type:application/json;charset=UTF-8 ``` |属性名|数据类型|描述| |---|---|---| |status|int|状态码,0=成功,其它值则为错误码,请参考错误码表| |description|String|通常为空,出错时会有错误信息| #### IoT对象字段说明: |字段|数据类型|释义|取值|取值释义| |---|---|---|---|---| |id|int|目标对象ID|301| | |equip\_type|int|设备类别|1000|灯| | | | |1001|空调| | | | |1002|风扇| | | | |1003|电热器/电暖器| | | | |1004|洗衣机| | | | |1005|浴霸/风暖| | | | |1006|热水器| | | | |1007|排风扇| | | | |1008|电吹风| | | | |1009|冰箱| | | | |1010|电压力锅/电饭煲| | | | |1011|微波炉| | | | |1012|咖啡机| | | | |1013|油烟机| | | | |1014|净水器| | | | |1015|面包机| | | | |1016|消毒柜| | | | |1017|榨汁机/料理机| | | | |1018|电磁炉| | | | |1019|烤箱/电烤箱| | | | |1020|电饼铛| | | | |1021|豆浆机| | | | |1022|酸奶机| | | | |1023|电水壶| | | | |1024|电视机| | | | |1025|按摩器| | | | |1026|音箱/音响| | | | |1027|按摩椅| | | | |1028|收音机| | | | |1029|录音机| | | | |1030|影碟机| | | | |1031|录像机| | | | |1032|投影机| | | | |1033|净化器| | | | |1034|吸尘器| | | | |1035|加湿器| | | | |1036|扫地机器人| | | | |1037|熨斗| | | | |1038|除湿机/抽湿机| | | | |1039|计算机/电脑/笔记本| | | | |1040|平板| | | | |1041|手机| | | | |1042|身高仪| | | | |1043|体重秤| | | | |1044|温度计| | | | |1045|湿度计| | | | |1046|空气质量仪| | | | |1047|门| | | | |1048|窗| | | | |1049|窗帘| | | | |1050|新风系统| | | | |1051|饮水机| | | | |1052|电话机| | | | |1053|机顶盒| | | | |1054|打印机| | | | |1055|插座| | | | |1056|电动锁| | | | |1057|煤气罐| | | | |1058|门磁开关| | | | |1059|幕帘| | | | |1060|门铃| | | | |1061|水表| | | | |1062|智能终端| | | | |1063|开关| | | | |1064|电表| | | | |1065|面板| | | | |1066|探测器| | | | |1067|门磁传感器| | | | |1068|排烟罩| | | | |1069|燃气灶| | | | |1070|门锁| | | | |1071|摄像头| | | | |1072|破壁机| | | | |1073|网关| | | | |1074|断路器| | | | |1075|制冰机| | | | |1076|报警器| | | | |1077|电热毯| | | | |1078|液位传感器| | | | |1079|温湿度采集单元| | | | |1080|跑步机| | | | |1081|浴缸| | | | |1082|按钮| | | | |1083|空气盒子| | | | |1084|地暖器| | | | |1085|机器人| | | | |1086|推窗器| | | | |1087|马桶| | | | |1088|中控屏| | | | |1089|遥控器| | | | |1090|鱼缸| | | | |1091|控制器| | | | |1092|网络存储| | | | |……|(往后将支持更多设备)| |equip\_id|String|设备id| | | |name|String|设备名称| | | |alias|String|设备别名| | | |equip\_location|String|设备所属地点|客厅|客厅| | | | |卧室|卧室(主卧)| | | | |次卧|次卧| | | | |客房|客房| | | | |书房|书房| | | | |儿童房|儿童房| | | | |餐厅|餐厅| | | | |阳台|阳台/客厅阳台| | | | |生活阳台|生活阳台| | | | |门厅|门厅(厅)| | | | |厨房|厨房| | | | |卫生间|公共卫生间| | | | |主卧卫生间|主卧卫生间| | | | |储藏室|储藏室(储藏间)| | | | |仓库|仓库| | | | |走廊|走廊 (过道)| | | | |保姆房|保姆房| | | | |玄关|玄关| | | | |门口|门口| | | | |……|(往后将支持更多地点)| |brightness|Object|亮度| |progress对象| |volume|Object|音量| |progress对象| |electricity|Object|电量| |progress对象| |range|Object|打开幅度| |progress对象| |wakeup|String|唤醒|ON|开启唤醒| | | | |OFF|关闭唤醒| |facerecognition|String|人脸识别|ON|开启人脸识别| | | | |OFF|关闭人脸识别| |temperature|Object|温度| |progress对象| |humidity|Object|湿度| |progress对象| |weight|double|重量| | | |height|double|高度| | | |level|int|档位| | | |winddirection|String|风向|LEFTRIGHT|左右风向| | | | |UPDOWN|上下风向| | | | |UP|向上| | | | |DOWN|向下| | | | |LEFT|向左| | | | |RIGHT|向右| |windtype|String|风种|CONCENTRATE|集中| | | | |SPREAD|扩散| |windswept|String|扫风|ON|开启扫风| | | | |OFF|关闭扫风| |lighting|String|照明|ON|开启照明| | | | |OFF|关闭照明| |shuxian|String|数显|ON|开启数显| | | | |OFF|关闭数显| |childlock|String|童锁|ON|开启童锁| | | | |OFF|关闭童锁| |water|Object|水量| |progress对象| |quality|String|质量| | | |kougan|String|口感|QINGXIANG|清香| | | | |BIAOZHUN|标准| | | | |NONGYU|浓郁| |rotatecycle|int|旋转周期| | | |baoya|String|保压|ON|开启保压| | | | |OFF|关闭保压| |rotate|String|旋转|ON|开启旋转| | | | |OFF|关闭旋转| |shangxiapan|String|上下盘|UP|上盘| | | | |DOWN|下盘| |view3d\_2d|String|3D/2D| | | |power|double|功率| | | |turnover|String|翻面|ON|开启翻面| | | | |OFF|关闭翻面| |grainsize|String|颗粒大小|SMALL|小| | | | |MEDIUM|中等| | | | |BIG|大| |concentration|Object|浓度| |progress对象| |quantity|double|份量| | | |cups|double|杯数| | | |storages|String|存储内容|AUDIO|音频| | | | |VIDEO|视频| | | | |IMAGE|图片| |autofeeding|String|自动投料|ON|开启自动投料| | | | |OFF|关闭自动投料| |inputtext|String|文字输入|ON|开启文字输入| | | | |OFF|关闭文字输入| |photograph|String|拍照|ON|开启拍照| | | | |OFF|关闭拍照| |videotape|String|录像|ON|开启录像| | | | |OFF|关闭录像| |bluetooth|String|蓝牙|ON|开启蓝牙| | | | |OFF|关闭蓝牙| |wifi|String|Wifi|ON|开启Wifi| | | | |OFF|关闭WiFi| |location|String|定位|ON|开启定位| | | | |OFF|关闭定位| |status|String|状态|OPEN|打开状态| | | | |CLOSE|关闭状态| | | | |BEGIN|开始状态| | | | |FINISH|结束状态| | | | |PAUSE|暂停状态| | | | |CONTINUE|继续状态| |channel|int|频道| | | |menu|String|菜单|ON|开启菜单| | | | |OFF|关闭菜单| |grade|int|等级/强度| | | |screen|String|屏幕|ON|开启屏幕| | | | |OFF|关闭屏幕| |color|String|颜色| | | |colortemp|String|色温|WARM|暖色| | | | |COOL|冷色| |repeat|int|重复次数| | | |soundtrack|String|声道| | | |model\_name|String|当前模式名称| | | |model\_id|String|当前模式 ID| | | |contextual\_model|List|情景模式| |contextual\_model对象| |mode|String|设备运行模式|DEFAULT|常规模式| | | | |MUTE|静音模式| | | | |VIBRATOR|震动模式| | | | |FLIGHT|飞行模式| | | | |INLAY|内置模式| | | | |OUTLAY|外置模式| | | | |ZHILENG|制冷模式| | | | |ZHIRE|制热模式| | | | |CHOUSHI|抽湿模式| | | | |LENGDONG|冷冻模式| | | | |RUANLENGDONG|软冷冻模式| | | | |PIAOXI|漂洗模式| | | | |TUOSHUI|脱水模式| | | | |CHUJUN|除菌模式| | | | |HUANQI|换气模式| | | | |GANZAO|干燥模式| | | | |BAOWEN|保温模式| | | | |LENGCANG|冷藏模式| | | | |SONGFENG|送风模式| | | | |JIASHI|加湿模式| | | | |SHUIMIAN|睡眠模式| | | | |JIENENG|节能模式| | | | |QINGJIE|清洁模式| | | | |ZUIKUAI|最快模式| | | | |ZUIJING|最净模式| | | | |XICUNSHAN|洗寸衫模式| | | | |XIYANGMAO|洗羊毛模式| | | | |XICHUANGDAN|洗床单模式| | | | |XINIUZAI|洗牛仔模式| | | | |XIMIANMA|洗棉麻模式| | | | |XIYURONG|洗羽绒模式| | | | |XISICHOU|洗丝绸模式| | | | |HUNHE|混合模式| | | | |YEJIANXI|夜间洗模式| | | | |YEWAN|夜晚模式| | | | |ZHAOMING|照明模式| | | | |CHUIFENG|吹风模式| | | | |KUAISUFENGGAN|快速风干模式| | | | |QUJINGDIAN|去静电模式| | | | |BAOSHI|保湿模式| | | | |CHUILIAN|吹脸模式| | | | |PENGSONG|蓬松模式| | | | |HENGWEN|恒温模式| | | | |KUAISUZHU|快速煮模式| | | | |ZHUZHOU|煮粥模式| | | | |ZHENGCAI|蒸菜模式| | | | |ZHUFAN|煮饭模式| | | | |BAOTANG|煲汤模式| | | | |DOULEITIJIN|豆类蹄筋| | | | |ROULEI|肉类模式| | | | |DANGAO|蛋糕模式| | | | |YULEI|鱼类模式| | | | |ZAIJIARE|再加热模式| | | | |ZALIANGZHOU|杂粮粥模式| | | | |RECAI|热菜模式| | | | |SHAOKAO|烧烤模式| | | | |YETI|液体模式| | | | |JIEDONG|解冻模式| | | | |MIFAN|米饭模式| | | | |APP|手机APP模式| | | | |SHENGKONG|声控模式| | | | |ROUSONG|翻炒干货模式| | | | |MIANBAO|面包模式| | | | |SHENGDIAN|省电模式| | | | |NAIPAO|奶泡制作模式| | | | |YISHIKAFEI|意式咖啡模式| | | | |CHA|茶模式| | | | |NATIE|拿铁模式| | | | |MAQIDUO|玛奇朵模式| | | | |KABUQINUO|卡布奇诺模式| | | | |SUANXING|酸性模式| | | | |RUOSUANXING|弱酸性模式| | | | |JIANXING|碱性模式| | | | |RUOJIANXING|弱碱性模式| | | | |KUAISU|快速模式| | | | |TUSI|土司模式| | | | |FASHIMIANBAO|法式面包模式| | | | |QUANMAIMIANBAO|全麦面包模式| | | | |HEIMAIMIANBAO|黑麦面包模式| | | | |DANMAIMIANBAO|丹麦面包模式| | | | |HUASHIMIANBAO|花式面包模式| | | | |SHUANGFENGMIANBAO|双峰面包模式| | | | |OUSHIMIANBAO|欧式面包模式| | | | |HEFENGMIANBAO|和风面包模式| | | | |WUJINMIANBAO|无筋面包模式| | | | |WUTANGMIANBAO|无糖面包模式| | | | |PISAMIANTUAN|披萨面团模式| | | | |JIAOMUMIANBAO|酵母面包模式| | | | |YINGSHISIKANG|英式茶饼思康饼模式| | | | |SHUSHIDANGAO|蔬食蛋糕模式| | | | |GUOJIANG|果酱模式| | | | |DOUSHAXIAN|豆沙馅模式| | | | |MASHU|麻薯模式| | | | |WUDONGMIAN|乌冬面模式| | | | |YIDALIMIAN|意大利面模式| | | | |NIANGAO|年糕模式| | | | |XIAODU|消毒模式| | | | |HONGGAN|烘干模式| | | | |DOUJIANG|豆浆模式| | | | |GUOSHU|果蔬模式| | | | |NONGTANG|浓汤模式| | | | |MIHU|米糊模式| | | | |YUMIZHI|玉米汁模式| | | | |AOZHOU|熬粥模式| | | | |SHOUDONG|手动模式| | | | |YAOKONG|遥控模式| | | | |BINGSHA|冰沙模式| | | | |NAIXI|奶昔模式| | | | |WUGU|五谷模式| | | | |HUOGUO|火锅模式| | | | |CHAOCAI|炒菜模式| | | | |SHAOSHUI|烧水模式| | | | |TIEBANSHAO|铁板烧模式| | | | |FAJIAO|发酵模式| | | | |XUANZHUAN|旋转模式| | | | |CUIPIHONGBEI|脆皮烘焙模式| | | | |CHUANTONGHONGBEI|传统烘焙模式| | | | |ZHENGQIXIAODU|蒸汽消毒模式| | | | |KAOYU|烤鱼模式| | | | |GUOTIE|锅贴模式| | | | |JIANDAN|煎蛋模式| | | | |ROUBING|肉饼模式| | | | |PISA|披萨模式| | | | |BINGGAN|饼干模式| | | | |CONGHUABING|葱花饼模式| | | | |XIANBING|馅饼模式| | | | |GANDOUDOUJIANG|干豆豆浆模式| | | | |SHIDOUDOUJIANG|湿豆豆浆模式| | | | |WUGUDOUJIANG|五谷豆浆模式| | | | |LVDOUDOUJIANG|绿豆豆浆模式| | | | |GUOCU|果醋模式| | | | |MIJIU|米酒模式| | | | |NADOU|纳豆模式| | | | |ROUNIE|揉捏模式| | | | |JIARE|加热模式| | | | |ZHENYA|针压模式| | | | |JINGJI|经济模式| | | | |SUANNAI|酸奶模式| | | | |PAOCAI|泡菜模式| | | | |FANCHAO|翻炒干货模式| | | | |ROUSONG|肉松模式| | | | |APP|手机APP模式| | | | |SHENGKONG|声控模式| | | | |SHOUDONG|手动模式| | | | |YAOKONG|遥控模式| | | | |……|(按需扩展)| PS:以上为所有设备的字段属性说明,单个设备的字段说明参考附录中的IoT对象各设备属性说明(一)和(二) progress对象数据结构: |属性|类型|释义|取值|属性取值释义| |---|---|---|---|---| |type|int|进度控制类型|0|设置进度值为progress的值,百分比值| |progress|String|进度值|0\-100| | contextual\_model对象数据结构: |属性|类型|释义|取值|属性取值释义| |---|---|---|---|---| |model\_name|String|模式名称| | | |model\_id|String|模式 ID| | | ## 3\.音频指令示例 详细的指令说明请参照[《Chatbot接口指令说明文档》](/project-2/doc-8/#h1-Chatbot接口指令说明文档) 关于获取歌曲播放链接的说明:当聊天应答接口输入为播放歌曲的意图时,灵聚AI会返回查询歌曲的指令及播放所查询歌曲的指令,同时会附带灵聚提供的音频资源,如: 播放歌曲返回的JSON示例: ``` 输入:播放张学友的听海 输出:{"status":0,answer:**** "{"rtext":"好的", "synthetise":"", "ttext":"","outc":0,"motions":\[\] "actions":\[ {"action":"QUERY", "target":{ "id":100, "name":"听海", "singer":\["张学友"\], "type":"歌曲"}}, {"action":"SET", "target":{ "id":300, "origin":"AUTO", "type":"AUDIO", "object":\[{ "id":"100", "name":"听海", "singer":\["张学友"\], "composer":"涂惠源", "musicId":"xxx", "album":"活出生命Live演唱会", "lyricist":"林秋离"}\], "control":"PLAY" } }\]}"} ``` 语义解释: 音频播放包括音频资源的查询,播放器播放音频的步骤,因此音频播放的动作目标对象包括音频对象和播放器对象,示例以两者的组合形式给出,指令描述如下: 1\\\.查询(QUERY)音频对象(id=100):歌名=听海,歌手=张学友, 2\\\.设置播放器(SET) 播放器对象(id=300),播放来源AUTO,即AI给出的音频实体\(object\),播放状态为PLAY。(播放器对象详见5\.3节) 上例中的音频实体object 附带了musicId,开发者可根据musicId的值去酷我的网站获取对应的播放链接,获取方法: HTTP get请求: [http://antiserver\.kuwo\.cn/anti\.s?response=url\&format=aac%7Cmp3\&type=convert\\\_url\&rid=musicId\&qq\-pf\-to=pcqq\.c2c](http://antiserver.kuwo.cn/anti.s?response=url&format=aac|mp3&type=convert_url&rid=musicId&qq-pf-to=pcqq.c2c) 请注意将以上链接的musicId替换成指令中提供的musicId。此外还需要判断返回的链接是否有效(若无效可重试若干次),不保证所有musicId均能取得有效的链接。 **声明:本公司仅提供音频链接的获取方法用于播放演示,不提供任何音频作品的版权许可,请勿将该播放方式用于任何商业用途,如引起任何版权纠纷一概与我司无关。** ## 4\.错误码表 |错误码|描述| |---|---| |0|成功| |\-1|系统异常| |1|其它错误| |4|开发者帐号错误,账户未完成认证或已被禁用| |6|APPKEY无效| |7|model错误| |8|参数错误| |9|已经是最新版本| |10|重复操作| |11|授权码无效| |12|激活码重置过于频繁| |13|体验版授权码已过期| |14|激活失败,请重试| |15|连接中禁止切换用户| |16|终端未激活| |17|激活码已过期,请重置| |18|激活码无效| |19|会话过期| |20\-29|数据格式校验错误| |40|并发过高导致请求失败| |41|每次调用次数已达上限| |42|目标对象未同步,请先通过update接口更新后重试| |43|应用无效,已被限制使用| |44|应用无效,已废弃| |45|目标对象数量已达上限| |97|校验失败| |98|重复登录| |99|未登录| |111|参数错误| |114|帐号未认证| |120|账号已被禁用| |121|授权限额已满| |122|accessToken已过期| |123|没有调用http接口的权限| |124|系统应答超时| |129|应用已被限制| |989|该用户APPKEY非法| |990|总调用次数已达上限,请联系技术人员处理| |991|该终端用户不存在| |992|accessToken无效| |993|对话量异常,机器人需要休息一会,稍后再试。| |996|对话太频繁了,暂时被禁用,稍后再试。| ## 5\.示例 以下给出java版本的示例\(修改APPKEY后可以直接运行体验\): ``` import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.HttpURLConnection; import java.net.MalformedURLException; import java.net.URL; import java.util.Random; import java.util.Scanner; import java.util.regex.Matcher; import java.util.regex.Pattern; public class ChatApi { private static final String AUTH_URL = "https://dev.lingju.ai/httpapi/authorize.do?appkey=%s&userid=%s&authcode=%s"; private static final String CHAT_URL = "https://dev.lingju.ai/httpapi/ljchat.do"; private static String token = "";//获取一次,有效期为30天// private static final String APIKEY = "62dd9f0c0e606115aede6e28d8684904";//"a776d26cfc67698b319487b78583dbf7"; private static String AUTH_CODE="1b21bb8f726bd93b90da46633a8ad4e1"; public static void getAccessToken(String userid){ try { String jsonstring=get(String.format(AUTH_URL, APIKEY,userid,AUTH_CODE)); System.out.println("accessToken_json>>"+jsonstring); //请开发者使用自己熟悉的json框架解析,如java的:gson,jackson,json-org等。其它平台类似。此处为了不引入第三方jar包,直接用正则提取accessToken Pattern pt=Pattern.compile("\"accessToken\"\\:\"(\\w+)\""); Matcher mt=pt.matcher(jsonstring); if(mt.find()){ token=mt.group(1); System.out.println("token="+token); } } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } private static String get(String url) throws IOException{ System.out.println("get>>"+url); URL u=new URL(url); HttpURLConnection conn=(HttpURLConnection) u.openConnection(); conn.setConnectTimeout(10*1000); conn.setRequestMethod("GET"); try{ InputStream in = conn.getInputStream(); if(conn.getResponseCode()==200){ int l=conn.getContentLength(); byte bytes[]=new byte[l]; in.read(bytes, 0, l); in.close(); return new String(bytes,"UTF-8"); } else in.close(); } catch(Exception e){ e.printStackTrace(); }finally{ conn.disconnect(); } return null; } static String chatJson="{"+ "\"accessToken\":\"%s\","+//必填 "\"input\":\"%s\","+//必填 "\"lat\":\"23.12635\","+//非必填 "\"lng\":\"113.38776\","+//非必填 "\"city\":\"广州\","+//非必填 "\"position\":\"广东广州(非必填)\""+ "}"; public static String getAnswer(String text) throws IOException{ URL u=new URL(CHAT_URL); HttpURLConnection conn=(HttpURLConnection) u.openConnection(); conn.setConnectTimeout(10*1000); conn.setDoOutput(true); conn.setRequestMethod("POST"); conn.setRequestProperty("Connection", "Keep-Alive"); conn.setRequestProperty("Content-Type", "application/json;charset=UTF-8"); OutputStream out= conn.getOutputStream(); try{ String json=String.format(chatJson, token,text); out.write(json.getBytes("UTF-8")); out.close(); out=null; InputStream in = conn.getInputStream(); if(conn.getResponseCode()==200){ int l=conn.getContentLength(); byte bytes[]=new byte[l]; in.read(bytes, 0, l); in.close(); conn.disconnect(); return new String(bytes,"UTF-8"); } else in.close(); }catch(Exception e){ e.printStackTrace(); } finally{ if(out!=null){ out.close(); } conn.disconnect(); } return null; } //获取酷我音乐歌曲播放链接的模版 static String KUWO_FETCHED_URL_TEMPLATE= "http://antiserver.kuwo.cn/anti.s?response=url&format=aac%smp3&type=convert_url&rid=%s&qq-pf-to=pcqq.c2c"; public static String getMusicUrlBy(String musicId) throws IOException{ String result=null; URL urls = new URL(String.format(KUWO_FETCHED_URL_TEMPLATE,"%7C",musicId)); HttpURLConnection conn = (HttpURLConnection) urls.openConnection(); try { conn.setRequestMethod("GET"); conn.setRequestProperty("Accept", "*/*"); conn.setRequestProperty("Accept-Language", "zh-CN"); conn.setRequestProperty("Charset", "UTF-8"); conn.setRequestProperty("User-Agent", "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.2; Trident/4.0; .NET CLR 1.1.4322; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)"); conn.setRequestProperty("Connection", "Keep-Alive"); conn.setConnectTimeout(10000); conn.connect(); if(conn.getResponseCode()==200){ InputStream in = conn.getInputStream(); // 通过输入流获取html二进制数据 int l=conn.getContentLength(); byte bytes[]=new byte[l]; in.read(bytes, 0, l); in.close(); result=new String(bytes,"UTF-8"); } conn.disconnect(); if(result!=null&&result.trim().startsWith("http")){ if(result.indexOf("?")>-1){ result=result.substring(0,result.lastIndexOf("?")); } } } catch (Exception e) { // TODO Auto-generated catch block e.printStackTrace(); result=null; } return result; } public static void main(String[] args) throws Exception { getAccessToken("11111111"); Scanner sc=new Scanner(System.in); String input; System.out.print("input>>"); while(sc.hasNext()){ input=sc.nextLine(); if("exit".equals(input)){ break; } if("test".equals(input)){ for(int i=0;i<20;i++){ new Thread(new Runnable() { @Override public void run() { try { System.out.println(getAnswer(new Random().nextInt(100)+"testtesttest")); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }).start(); } } else{ System.out.println(getAnswer(input)); } System.out.print("input>>"); } sc.close(); //System.out.println(getMusicUrlBy("MUSIC_157093")); } }
lingju.ai
2026年10月20日 17:19
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码