## 使用說明
#### 使用流程
###### 注冊申請圖靈賬號
登入網站 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|自定義意圖|
