# 圖靈機器人智能對話服務接入文檔
| 文檔狀態 | beta |
| ---- | ----------- |
| 文檔表述 | 測試版本，僅供測試使用 |
| 文檔版本 | v1.0.0 |
| 作者 | 匡亞明 |
| 校對 | 李佳萍 |
| 完成日期 | 2018年1月30日 |
[TOC]
## 使用說明
#### 使用流程
- 注冊申請圖靈賬號
登入網站 http://biz.turingos.cn/login 注冊賬戶
#### 編碼方式
> UTF-8（調用圖靈API的各個環節的編碼方式均為UTF-8）
#### 接口地址
http://api.turingos.cn/turingos/api/v2
## 接入說明
#### 請求方式
> HTTP POST
#### 請求參數
請求參數格式為 json
請求示例：
~~~
{
'data':'{
"content": [
{
"data": "你好"
}
],
"userInfo": {
"uniqueId": "uniqueId"
}
}',
'key':'ed474dae62*********67050faea1788',
'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 | 說明 |
| -------- | ----- |
| osgreet | 開機提示語 |
| osactive | 主動交互 |
| osinquiry | 兒童電臺初始化 |
**userInfo**
| 參數 | 類型 | 是否必須 | 取值范圍 | 說明 |
| -------- | ------ | ---- | --------- | ------ |
| uniqueId | String | Y | 長度小于等于32位 | 用戶唯一標識 |
**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);主動交互(function);視頻(video);圖片(image);圖文(news) | 輸出類型 |
| values | Map | Y | - | 輸出內容(一定包含key為resultType的鍵值對) |
| groupType | int | Y | - | 組編號:0為獨立輸出，大于0時可能包含同組相關內容 |
**功能code列表**
| code | 說明 |
| ------ | ------- |
| 10000 | 系統異常 |
| 10001 | 主題對話 |
| 10002 | 聊天 |
| 10005 | 成語接龍 |
| 10007 | 猜謎語 |
| 10008 | 一站到底 |
| 10018 | 編故事 |
| 10019 | 講故事 |
| 10020 | 猜明星 |
| 10024 | 拼眼力 |
| 100000 | 兒童聊天 |
| 100102 | 英文對話 |
| 200101 | 音樂/唱歌 |
| 200201 | 故事 |
| 200205 | 十萬個為什么 |
| 200207 | 繞口令 |
| 200208 | 歇后語 |
| 200209 | 問答百科 |
| 200211 | 腦筋急轉彎 |
| 200212 | 順口溜 |
| 200301 | 動物叫聲 |
| 200302 | 大自然的聲音 |
| 200303 | 樂器的聲音 |
| 200401 | 詩詞背誦 |
| 200501 | 拍照/關閉拍照 |
| 200701 | 跳舞 |
| 200702 | 日期查詢 |
| 200710 | 備忘/鬧鐘 |
| 201204 | 笑話大全 |
| 201401 | 天氣查詢 |
| 201501 | 計算 |
| 201711 | 英漢互譯 |
| 300101 | 動作控制 |
| 900110 | 系統設置 |
| 1000014 | 兒童電臺初始化 |
>功能參數說明(intent-parameters)
**唱歌(200101)**
| 參數 | 類型 | 是否必須 | 說明 |
| ------ | ------ | ---- | ---- |
| singer | String | N | 歌手名 |
| name | String | N | 歌曲名 |
**動物叫聲(200301)**
| 參數 | 類型 | 是否必須 | 說明 |
| ------- | ------ | ---- | ------ |
| english | String | N | 動物名稱 |
| name | String | N | 動物英文名稱 |
**大自然的聲音(200302)**
| 參數 | 類型 | 是否必須 | 說明 |
| ---- | ------ | ---- | ---- |
| name | String | N | 名稱 |
**樂器的聲音(200303)**
| 參數 | 類型 | 是否必須 | 說明 |
| ---- | ------ | ---- | ---- |
| name | String | N | 名稱 |
**系統設置(900110)**
| 參數 | 類型 | 是否必須 | 說明 |
| -------------------- | ------ | ---- | ---------------------------------------- |
| intent- operateState | int | Y | 操作11021為增大屏幕亮度，11022為減小屏幕亮度。11010為增大音量，11011為減小音量。11030電量查詢 |
| setting_level | String | N | 設置級別，默認為增大一格。 |
**備忘/鬧鐘(200710)**
| 參數 | 類型 | 是否必須 | 說明 |
| ----------- | ------ | ---- | ---- |
| memoContent | String | N | 內容 |
| cycleType | String | N | 循環周期 |
| alarmType | String | N | 鬧鐘類型 |
| endDate | String | N | 結束日期 |
| timeLen | String | N | 時間長度 |
| alarmTag | String | N | 鬧鐘標簽 |
| time | String | N | 鬧鐘時間 |
| startDate | String | N | 開始日期 |
**動作控制(300101)**
| 參數 | 類型 | 是否必須 | 說明 |
| --------- | ------ | ---- | ------------- |
| force | int | N | 力量，默認0，使用最小力量 |
| direction | String | Y | 運動方向 |
direction說明
| 參數 | 說明 |
| ---------------- | ---- |
| see_top | 向上看 |
| see_bottom | 向下看 |
| see_left | 向左看 |
| see_right | 向右看 |
| raise_left_hand | 抬左手 |
| raise_right_hand | 抬右手 |
| raise_all_hand | 抬雙手 |
| site_down | 坐下 |
| go_front | 前走 |
| go_left | 左走 |
| go_right | 右走 |
| rotate_left | 左轉 |
| rotate_right | 右轉 |
| sit_up | 仰臥起坐 |
| push_up | 俯臥撐 |
**詩詞背誦(200401)**
| 參數 | 類型 | 是否必須 | 說明 |
| ------ | ------ | ---- | ---- |
| year | String | N | 年代 |
| author | String | N | 作者 |
| name | String | N | 詩名 |
| type | String | N | 詩詞類型 |
**中英互譯(200401)**
| 參數 | 類型 | 是否必須 | 說明 |
| ------------ | ------ | ---- | ------------------------------------- |
| originalText | String | Y | 要翻譯的內容 |
| model | String | Y | 模式 [Chinese2English, English2Chinese] |
**天氣(201401)**
| 參數 | 類型 | 是否必須 | 說明 |
| ---- | ------ | ---- | -------------- |
| date | String | N | 時間(yyyy-MM-dd) |
| city | String | N | 城市 |
######
