## 使用说明
#### 使用流程
###### 注册申请图灵账号
登入网站 http://biz.beta.turingos.cn/login 注册账户
#### 编码方式
UTF-8（调用图灵API的各个环节的编码方式均为UTF-8）
#### 接口地址
http://120.26.164.173:9310/turingos/api/v2
#### 请求方式
HTTP POST
#### 请求参数
请求参数格式为 json
请求示例：
~~~
{
'data':'{
"content": [
{
"data": "我爱你1"
}
],
"userInfo": {
"apiKey": "apikey",
"uniqueId": "uniqueId"
},
"clientInfo":{
"appState":{
"code":1004,
"operateState":1000
}
}
}',
'key':'ed474dae623f4b619d667050faea1788',
'timestamp':'1505390837793'
}
~~~
>参数说明
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| data | - | Y | - | 请求参数 |
| key | - | Y | - | 用户apikey |
| timestamp | - | Y | - | 时间戳 |
**data**
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| content | - | Y | - | 输入信息 |
| userInfo | - | Y | - | 用户参数 |
| clientInfo | - | N | - | 客户端状态(内部可用) |
**content**
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| type | - | N | - | 输入类型:0-文本(默认)、1-图片、2-音频、4-主动交互 |
| data | - | Y | - | 输入类型图片、音频存url;文本类型存输入内容 |
| message | - | N| - | 富媒体信息 |
###### 注意：type=4(主动交互),传入参数data说明
| data | 说明 |
| --- | --- |
|greet|旧开启提示语|
|osgreet|开启提示语|
|active|旧主动交互|
|osactive|主动交互|
**userInfo**
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| apiKey | String | Y | 32位 | 机器人标识 |
| uniqueId | String | Y | 长度小于等于32位 | 用户唯一标识 |
| groupId | String | N| 长度小于等于64位 | 群聊唯一标识 |
| userName | String | N | 长度小于等于64位 | 用户昵称 |
**clientInfo-appState**
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| code | int | Y | - | 应用code |
| operateState | int | Y| - | 应用状态值 |
###### operateState状态意义
| code | 功能 |
| --- | --- |
|1000|结束状态|
|1100|启动|
|1200|暂停|
|1300|继续|
|1400|等待重启|
#### 输出参数
输出示例：
~~~
{
"intent": {
"code": 10002,
"operateState": 1100
},
"results": [
{
"groupType": 0,
"values": {
"text": "请告诉我您在哪个城市的哪个地方"
},
"resultType": "text"
}
]
}
~~~
>参数说明
| 参数 | 类型 | 是否必须 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| intent | - | Y | - | 请求意图 |
| results | - | N | - | 输出结果集 |
**intent**
| 参数 | 类型 | 是否包含 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| code | int | Y | - | 输出功能code |
| operateState | int | Y | - | 功能状态(功能单独定义) |
| intentName | String | N | - | 意图名称 |
| actionName | String | N | - | 意图动作名称 |
| parameters | String | N | - | 功能相关参数 |
**results**
| 参数 | 类型 | 是否包含 | 取值范围 | 说明 |
| --- | --- | --- | --- | --- |
| resultType | String | Y | 文本(text);连接(url);音频(voice);视频(video);图片(image);图文(news)| 输出类型 |
| values | - | Y | - | 输出值 |
| groupType | int | Y | - | ‘组’编号:0为独立输出，大于0时可能包含同组相关内容 (如：音频与文本为一组时说明内容一致)|
###### 功能code列表(补充中)
| code | 功能 |说明 |
| --- | --- |--- |
|10000|system.error|系统异常|
|10001|topic.chat|话题聊天|
|10002|platform.chat|工程聊天|
|10003|platform.weather|基础天气|
|10005|openapi_idiom|新版成语接龙|
|10007|platform.guess_game|猜谜语|
|10008|openapi_stillstand|一站到底|
|10009|platform.number_count|数字计算|
|10017|platform.poetry|诗词解析|
|10018|openapi_story|编故事|
|10019|platform.story|讲故事|
|10020|openapi_guessstar|猜明星|
|10021|platform.date|日期查询|
|10023|platform.music|音乐控制|
|10024|openapi_pkvision|拼眼力|
|100000|os.sys.chat|正常对话状态|
|100101|os.sys.chat|打招呼问好|
|100102|os.sys.englishChat|英文对话|
|100201|os.sys.activeInteraction|主动交互|
|100301|os.sys.faq|Faq|
|100401|os.sys.topicChat|新话题聊天|
|200101|os.sys.song|音乐/唱歌|
|200102|os.sys.englishSong|英文歌曲|
|200201|os.sys.story|故事|
|200202|os.sys.idiomd|成语/成语接龙|
|200203|os.sys.dictionary|字/词典/翻译|
|200205|os.sys.ask|十万个为什么|
|200206|os.sys.syllabus|课程表|
|200207|os.sys.tongueTwister|绕口令|
|200208|os.sys.xiehouyu|歇后语|
|200209|os.sys.wiki|百科|
|200211|os.sys.brainTwister|脑筋急转弯|
|200212|os.sys.doggerel|顺口溜|
|200301|os.sys.animalSounds|动物叫声|
|200302|os.sys.natureSounds|大自然的声音|
|200303|os.sys.musicInstrumentSound|乐器的声音|
|200401|os.sys.poem|诗词（MP3朗读）|
|200501|os.sys.camera|拍照/退出拍照|
|200502|os.sys.photograph|照片查看|
|200503|os.sys.video|录像|
|200504|os.sys.video|查看录像/退出录像|
|200505|os.sys.cartoon|动漫推荐|
|200506|os.sys.projection|投影|
|200601|os.sys.features|特征属性|
|200701|os.sys.dance|动作控制-跳舞|
|200702|os.sys.date|日历/日期/时间/节日|
|200710|os.sys.memo|备忘/闹钟|
|200801|os.sys.tenementContact|物业联系方式|
|200901|os.sys.environmentMonitor|环境监测|
|201001|os.sys.musicPlay|播放音乐-停止播放|
|201002|os.sys.musicPlay|播放音乐-暂停播放|
|201003|os.sys.musicPlay|播放音乐-继续播放|
|201101|os.sys.stockInquire|股票查询|
|201203|os.sys.nightLightPattern|夜灯模式-开灯/关灯|
|201204|os.sys.joke|笑话|
|201401|os.sys.weather|天气|
|201501|os.sys.calculate|计算|
|201502|os.sys.unitConversion|单位换算|
|201701|os.sys.oral.english|OS应用-练口语英语|
|201702|os.sys.mandarin|OS应用-练习普通话|
|201711|os.sys.translate|OS应用--英汉互译|
|201712|os.sys.topicChat|OS应用--话题聊天|
|201713|os.sys.sceneChat|OS应用--场景聊天|
|201714|os.sys.topicChat|应用推荐|
|201715|os.sys.recommendApp|app推荐|
|201716|os.sys.wish|APP许愿树|
|201801|os.sys.height_measure|测量身高|
|201802|os.sys.dress|穿衣搭配|
|201803|os.sys.selfsong|机器人自唱|
|201804|os.sys.autonomicBehavior|机器人自主行为|
|201805|os.sys.imitation|机器人表情模仿|
|201901|os.sys.tracing|爸妈在哪儿|
|202001|os.sys.robotChat|机器人对话|
|202101|os.sys.videoCall|视频对话|
|202111|os.sys.multimediaPush|客户推送多媒体内容|
|202202|os.sys.videoMessage|视频留言|
|202301|os.sys.seek|找东西|
|300101|os.sys.action|动作控制-腿部动作|
|300301|os.sys.headAction|头部动作-看|转头|
|300404|os.sys.action|动作控制-旋转|
|900101|osl.sys.exit|自身状态-休眠/退出|
|900102|os.sys.screenBright|自身状态-屏幕亮度|
|900110|os.sys.setting|os-设置|
|900201|os.sys.power|机器人电量数据处理|
|1000000|os.sys.intent|自定义意图|
