所选语种没有对应资源,请选择:

本站点使用Cookies,继续浏览表示您同意我们使用Cookies。Cookies和隐私政策>

提示

尊敬的用户,您的IE浏览器版本过低,为获取更好的浏览体验,请升级您的IE浏览器。

升级

TE10, TE20 会议电视终端 V600R019C00 HTTP API 编程参考

为了方便用户在自定义操作界面上控制终端,终端提供了大量的API(Application Programming Interface)命令行接口,用户可以通过调用这些接口控制终端。
评分并提供意见反馈 :
华为采用机器翻译与人工审校相结合的方式将此文档翻译成不同语言,希望能帮助您更容易理解此文档的内容。 请注意:即使是最好的机器翻译,其准确度也不及专业翻译人员的水平。 华为对于翻译的准确性不承担任何责任,并建议您参考英文文档(已提供链接)。
终端控制类

终端控制类

查询休眠状态

接口名称

WEB_IsSystemSleepAPI

功能描述

查询休眠状态。

应用场景

用户可以查询当前系统是否处于休眠状态。

URL

POST /action.cgi?ActionID=WEB_IsSystemSleepAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{"isSystemSleep": "sleep"}

}

success表示响应结果,isSystemSleep表示休眠状态,休眠是"sleep", 未休眠是"unsleep"。

成功响应示例

{"success":1,"data":{

"isSystemSleep":"sleep"}}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

启动系统休眠

接口名称

WEB_StartSystemSleepAPI

功能描述

终端进入系统休眠。

应用场景

终端满足休眠条件之后,启动系统休眠,进入休眠状态。

URL

POST /action.cgi?ActionID=WEB_StartSystemSleepAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 0,

"data":""

}

“success”字段表示响应结果,0表示失败, 1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

唤醒休眠

接口名称

WEB_SystemWakeUpAPI

功能描述

调用该接口可以把系统从休眠状态唤醒。

应用场景

终端进入休眠后,可以唤醒终端。

URL

POST /action.cgi?ActionID=WEB_SystemWakeUpAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 0,

"data":""

}

“success”字段表示响应结果,0表示失败, 1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

关机

接口名称

WEB_RequestPowerDownAPI

功能描述

调用该接口可以关闭终端,使系统处于关机状态。

应用场景

关闭终端。调用该接口后,会收到MSG_POWERDOWN_RESULT消息,表示终端即将关机。

该接口仅TE20支持;

URL

POST /action.cgi?ActionID=WEB_RequestPowerDownAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 0,

"data":""

}

“success”字段表示响应结果,0表示失败, 1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

重启终端

接口名称

WEB_RequestRebootAPI

功能描述

调用该接口可以重启终端。

应用场景

控制终端重新启动。调用该接口后,会收到MSG_REBOOT_RESULT消息,用于表示终端即将重启。

URL

POST /action.cgi?ActionID=WEB_RequestRebootAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 0,

"data":""

}

“success”字段表示响应结果,0表示失败, 1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

虚拟遥控器

接口名称

WEB_EmuRemoteKeyAPI

功能描述

该接口模拟遥控器操作。

应用场景

模拟遥控器控制终端时使用;

URL

POST /action.cgi?ActionID= WEB_EmuRemoteKeyAPI

请求参数结构

{

"keyState":0,

"keyCode":9

}

请求参数示例

{

"keyState":0,

"keyCode":9

}

keyState:0: 按下 1:持续按下 2: 弹起;

keyCode:表示按键的键值,具体如下:

4:返回键;

7:数字0;

8:数字1;

9:数字2;

10:数字3;

11:数字4;

12:数字5;

13:数字6;

14:数字7;

15:数字8;

16:数字9;

17:星号键;

18:#号键;

19:方向键,向上;

20:方向键,向下;

21:方向键,向左;

22:方向键,向右;

24:音量键,加;

25:音量键,减;

26:电源键;

66:ok键;

82:目录键;

164:闭音键;

成功响应结构

{

"success": 0,

"data":""

}

“success”字段表示响应结果,0表示失败, 1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

获取本地时间日期

接口名称

WEB_GetSysLocalTimeAPI

功能描述

获取本地时间日期

应用场景

调用该接口可以获得本地时间日期和是否启用夏令时

URL

POST /action.cgi?ActionID=WEB_GetSysLocalTimeAPI

请求参数结构

请求参数示例

成功响应结构

{"success":1,

"data":

"{\"year\":2016,

\"month\":3,

\"day\":4,

\"hour\":13,

\"minute\":38,

\"second\":24,

\"daylight\":0,// 是否启用夏令时;

\"isDst\":0// 是否在夏令时范围内

}

"}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,

"data":

"{\"year\":2016,

\"month\":3,

\"day\":4,

\"hour\":13,

\"minute\":38,

\"second\":24,

\"daylight\":0,

\"isDst\":0}

"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

设置本地时间日期

接口名称

WEB_SetSysTimeAPI

功能描述

设置本地时间日期

应用场景

调用该接口可以设置本地时间日期

URL

POST /action.cgi?ActionID=WEB_SetSysTimeAPI

请求参数结构

参见示例

请求参数示例

{"year":2016,"month":3,"day":4,"hour":12,"minute":45,"second":24,"daylight":0}

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

系统休眠

接口名称

WEB_StartTermSleepAPI

功能描述

终端进入系统休眠。

应用场景

终端满足休眠条件之后,启动系统休眠,进入休眠状态。

URL

POST /action.cgi?ActionID=WEB_StartTermSleepAPI

请求参数结构

请求参数示例

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666995,"code":33558532,"params":[]}}

云平台激活

接口名称

WEB_CloudPlatActivate

功能描述

激活云平台。

应用场景

在使用云平台情况下,该接口用于激活云平台。

URL

POST /action.cgi?ActionID= WEB_CloudPlatActivate

请求参数结构

请求参数示例

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id": 100667761,"code": 50343939,"params":[]}}

设置界面编辑框

接口名称

WEB_SetEditboxStringAPI

功能描述

设置遥控器界面编辑框的值。

应用场景

给第三方使用,通过该接口可以设置遥控器界面编辑框控件的值,可以一次输入长字符串,而不用按字符输入。

URL

POST /action.cgi?ActionID= WEB_SetEditboxStringAPI

请求参数结构

{"szCommStr":"stringvalue"}

请求参数示例

成功响应结构

{"success":1,"data":""}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据,允许为空。

成功响应示例

{"success":1,"data":""}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id": 100667761,"code": 50343939,"params":[]}}

翻译
下载文档
更新时间:2019-03-08

文档编号:EDOC1100044503

浏览量:5409

下载量:63

平均得分:
本文档适用于这些产品
相关文档
相关版本
Share
上一页 下一页