### 使用说明
接口地址：
Post http://www.tuling123.com/openapi/api
#### 输入协议
~~~
{
"location": {
"province": "北京",
"city": "北京",
“county”："海淀区",
"street": "信息路",
"nearest_poi_name": "上地环岛南",
"latitude": "39.45492",
"longitude": "119.239293"
},
"appState": {
"appKey": "platform.fm",
"operateState": 1000
},
"info": "播放刘德华的小苹果",
"userid": "userid",
key:"key"//测试apikey
}
~~~
#### 输出协议
~~~
{
"appState": {
"appKey": "platform.music",
"operateState": 1000,
"parametes": {
"singer_name": "刘德华",
"song_name": "小苹果"
}
},
"tts": ""
}
~~~
>字段说明
| 参数 | 说明 |
| --- | --- |
| appState |当前应用状态（可选输入，不输入将默认使用上下文获取当前应用状态） |
| appKey | 当前应用唯一标识 |
| operateState | 当前应用状态值 |
| nearest_poi_name | 最近街道名称 |
| key | 该apikey关联车载产品 |
| userid | 设备唯一标识 |
| info | 用户输入信息 |
#### 通讯录上传协议
接口地址：
Post http://update.tuling123.com/multibiz
>[info] 请求参数
~~~
{
"userid": userid,
"info": "|张三:1353743XXXX|阿财:1358073XXXX|"//注意上传格式
}
~~~
>[success] 返回参数
~~~
{
"ret":0,
"text":"通讯录上传成功"
}{
"ret": 1,
"text": "解密失败，您的加密逻辑存在异常！"
}
~~~
~~~
{
"ret": 1,
"text": "解密失败，您的加密逻辑存在异常！"
}
~~~
#### 加密输入协议
~~~
{
"key":apiKey,
"timestamp":456789,
"service_identify":"uploadphone", //上传通讯录特殊参数 ,通讯录上传必须加密
"data":TwPFGlIQk/yl2qDbNyuSQg9JMeV6aLdCS7yo6lT5Ia0=//加密后的输入参数
}
~~~
#### 应用相关协议
###### 打电话
>[info] 请求参数
~~~
{
"key": "apikey",
"info": "给张三打电话",
"userid": "userid"
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.phone",
"operateState": 2000,
"parametes": {
"address_blank": true,
"people_name": "张三",
"phone_number": "1353743XXXX"
}
},
"tts": "正在为您呼叫张三"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 进入电话应用 |
| 2100 | 接电话 |
| 2010 | 可拨打号码 |
| 2000 | 立即拨打号码 |
| 1000 | 结束该应用 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| list | 多匹配 |
| address_blank | 有无通讯录 |
| phone_number | 拨打号码 |
| people_name | 拨打姓名 |
###### 视频通话
>[info] 请求参数
~~~
{
"key": "key",
"info": "给张三打视频",
"userid": "userid"
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "vehicle.video_call",
"operateState": 2000,
"parametes": {
"address_blank": true,
"people_name": "张三",
"phone_number": "1353743XXXX"
}
},
"tts": "正在向张三发送视频请求"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 进入视频通话应用 |
| 2100 | 接视频 |
| 2010 | 可拨打号码 |
| 2000 | 立即拨打号码 |
| 1000 | 结束该应用 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| list | 多匹配 |
| address_blank | 有无通讯录 |
| phone_number | 拨打号码 |
| people_name | 拨打姓名 |
###### 相声
>[info] 请求参数
~~~
{
"key": "key",
"info": "打开相声",
"userid": "userid"
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "vehicle.crosstalk",
"operateState": 1000,
"parametes": {}
},
"tts": "恩，播放相声"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 打开相声 |
| 1400 | 关闭相声 |
###### 电台
>[info] 请求参数
~~~
{
"key": "key",
"info": "打开相声",
"userid": "userid"
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "vehicle.crosstalk",
"operateState": 1000,
"parametes": {}
},
"tts": "恩，播放相声"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 打开电台 |
| 2000 | 换台 |
| 1100 | 关闭电台 |
###### 音乐
>[info] 请求参数
~~~
{
"key": "key",
"info": "播放周杰伦的青花瓷",
"userid": "userid"
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.music",
"operateState": 1000,
"parametes": {
"singer_name": "周杰伦",
"song_name": "青花瓷"
}
},
"tts": "马上为您播放歌曲"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 开始音乐 |
| 1200 | 暂停 |
| 1400 | 停止 |
| 1300 | 继续播放 |
| 2008 | 换一曲 |
| 2009 | 上一曲 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| singer_name | 歌手名 |
| song_name | 歌曲名 |
###### 附近信息
>[info] 请求参数
~~~
{
"key": "key",
"info": "周围有什么酒店",
"userid": "userid",
"location": {
"province": "北京",
"city": "北京",
"street": "信息路",
"nearest_poi_name": "上地环岛南",
"latitude": "39.45492",
"longitude": "119.239293"
}
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.nearby",
"operateState": 1000,
"parametes": {
"nearby_place": "酒店"
}
},
"tts": "正在查找附近酒店，请稍等"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 打开附件信息搜索 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| nearby_place | 附近事物关键词 |
###### 导航
>[info] 请求参数
~~~
{
"key": "key",
"info": "去天安门怎么走",
"userid": "userid",
"location": {
"province": "北京",
"city": "北京",
"street": "信息路",
"nearest_poi_name": "上地环岛南",
"latitude": "39.45492",
"longitude": "119.239293"
}
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.navigation",
"operateState": 2000,
"parametes": {
"end_city": "",
"start_place": "信息路",
"end_place": "天安门",
"start_city": "",
"needstartgeo": "1",
"needendgeo": "",
"city": "北京"
}
},
"tts": "已确定目的地天安门，正在规划路线请稍等"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 2000 | 打开导航并确认目的地，例：导航天安门 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| city | 当前城市 |
| end_city | 目的城市 |
| end_place | 目的地地址 |
| needendgeo | 目的地定位 |
| needstartgeo | 出发地定位 |
| start_city | 出发城市 |
| start_place | 出发地址 |
###### 天气信息
>[info] 请求参数
~~~
{
"key": "key",
"info": "今天天气怎么样",
"userid": "userid",
"location": {
"province": "北京",
"city": "北京",
"street": "信息路",
"nearest_poi_name": "上地环岛南",
"latitude": "39.45492",
"longitude": "119.239293"
}
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.weather",
"operateState": 1000,
"parametes": {
"city": "北京",
"date": "2016-11-09",
"weather": {
"date": "周三 11月09日 (实时：6℃)",
"maxTemperature": 8,
"maxWind": 1,
"minTemperature": 2,
"temperature": "8 ~ 2℃",
"weather": "霾",
"wind": "微风"
}
}
},
"tts": "雾霾对我们身体有害！北京今天霾，微风，8到2度。"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 进入应用 |
| parametes内字段 | parametes字段详解 |
| --- | --- |
| city | 城市 |
| date | 时间 |
| weather | 天气信息|
###### 洗车指数
>[info] 请求参数
~~~
{
"key": "key",
"info": "今天去洗车怎么样",
"userid": "userid",
"location": {
"province": "北京",
"city": "北京",
"street": "信息路",
"nearest_poi_name": "上地环岛南",
"latitude": "39.45492",
"longitude": "119.239293"
}
}
~~~
>[success] 返回参数
~~~
{
"appState": {
"appKey": "platform.carwashing",
"operateState": 1000,
"parametes": {}
},
"tts": "洗车指数： 比较适宜 洗车后未来2天内没有降水、大风或沙尘天气，比较适宜洗车"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 1100 | 进入应用 |
#### 返回异常码
~~~
{
"appState": {
"appKey": "system.error",
"operateState": 4002
},
"tts": "今天天气怎么样"
}
~~~
>字段说明
| operateState | operateState详情 |
| --- | --- |
| 5000 | 暂不支持该功能 |
| 6000 | 暂不支持该功能 |
| 4000 | 请求参数格式错误 |
| 4002 | 无功能权限 |
| 4005 | 无功能权限|
| 4003 | 该apikey没有可用请求次数 |
#### 附错误码
（1）ret为0成功，为1失败。
（2）apikey不对错误，返回结果：{"ret":1,"text":"亲爱的，未找到对应的用户信息，请稍后重试。"}
（3）加密逻辑错误，返回结果：{"ret":1,"text":"解密失败，您的加密逻辑存在异常！"}
（4）userid不合法，返回结果：{"ret":1,"text":"亲爱的，userid不合法。"}
（5）上传失败，返回结果：{"ret":1,"text":"通讯录上传失败"}
（6）上传成功，返回结果：{"ret":0,"text":"通讯录上传成功"}
