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

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

提示

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

升级

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

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

配置类

终端配置文件导入前密码校验

接口名称

WEB_CheckImportConfigPwdAPI

功能描述

终端配置文件从本地计算机导入到终端前,需要调用该接口验证用户密码,当前用户的登录密码。

应用场景

终端配置文件从本地计算机导入到终端前,需要验证当前用户的登录密码,验证成功后才能进行下一步导入操作。

URL

POST /action.cgi?ActionID= WEB_CheckImportConfigPwdAPI

请求参数结构

{

"upgPwd": "Change_Me"

} /*upgPwd :用户登录密码*/

请求参数示例

{"upgPwd":"Change_Me"}

成功响应结构

{

"success": X,

"data":"YYYY"

}

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

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100665912,"code":67125432,"params":[]}}

终端配置文件从本地计算机导入到终端中

接口名称

configimportAPI

功能描述

终端配置文件从本地计算机导入到终端中时调用该接口。

应用场景

终端配置文件从本地计算机导入到终端成功后,需要重启终端生效,可以通过导入成功后调用重启终端的接口WEB_RequestRebootAPI实现。也支持部分配置项的导入。

URL

POST /configimportAPI

请求参数结构

请求参数示例

POST /configimport HTTP/1.1

成功响应结构

{

"success": X,

"data":"YYYY"

}

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

成功响应示例

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

失败响应结构

{

"success": X,

"data":{

" errCode ": XXXXXX,

" errLine ":YYYYYY,

……

}

}

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

失败响应示例

{"success":0,"data":{"errCode":7,"errLine":0,"errOverLap":0,"legalMin":0,"legalMax":0,"isInvalid":1,"errNodeCount":0,"valueType":0,"errNodeName":"Root. Common. LoginErrTimes"}}

将终端配置导出到本地计算机上

接口名称

WEB_SettingExportAPI

功能描述

通过该接口,可以将终端的配置文件导出到本地计算机上,以xml格式的文件存放。

应用场景

该API接口和’configAPI’配合使用。先调用本接口,系统生成配置文件之后,再调用’ configAPI’接口获取xml格式的配置文件。

URL

POST /action.cgi?ActionID=WEB_SettingExportAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": 1,

"data":"YYYY"

}

“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":[]}}

请求配置文件

接口名称

configAPI

功能描述

终端配置导出到本地计算机上时调用该接口。

应用场景

支持将终端配置导出到本地计算机上,以xml格式的文件存放,configAPI为要导出的文件名称,和’ WEB_SettingExportAPI’配合使用。‘WEB_SettingExportAPI’用于系统准备配置xml文件,’configAPI’则是获取该文件。

URL

GET /configAPI

请求参数结构

请求参数示例

GET /config HTTP/1.1

成功响应结构

成功响应示例

HTTP/1.1 200 OK

Connection: Keep-Alive

X-Content-Type-Options: nosniff

X-Download-Options: noopen

X-Frame-Options: sameorigin

X-XSS-Protection: 1; mode=block

Strict-Transport-Security: max-age=31536000; includeSubdomains

Content-Security-Policy: img-src 'self'

Content-Type: application/x-octet-stream

Cache-Control: max-age=0

Content-Length: 680799

<cfg name="Root">

<val name="Guide" type="UINT32">3435973836</val>

……

失败响应结构

失败响应示例

读取配置项缺省值

接口名称

WEB_GetCfgDftParamAPI

功能描述

读取配置项缺省值时可以调用该接口。

应用场景

配置项在系统中有缺省值,调用该接口可以读取配置项在系统中的缺省值。支持的全部配置项请参见配置项

URL

POST /action.cgi?ActionID=WEB_GetCfgDftParamAPI

请求参数结构

{

"CfgIDString": []

}

CfgIDString字段表示要读取的配置项ID字符串数组,支持的配置项ID请参见配置项。注意,一次最多请求配置项个数不要太多,建议限制在50个以下。

请求参数示例

{"CfgIDString":["autoreply","isOpenNotReplyToUser","autoanswermute","dftCallWidth","openCallParam","isWifiPriority","maxInCallWidth"]}

成功响应结构

{

"success": X,

"data":"YYYY"

}

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

成功响应示例

{"success":1,"data":"{\"autoreply\":1,\"isOpenNotReplyToUser\":1,\"autoanswermute\":0,\"dftCallWidth\":159,\"openCallParam\":0,\"isWifiPriority\":0,\"maxInCallWidth\":240}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

读取配置项当前值

接口名称

WEB_GetCfgParamAPI

功能描述

读取配置项当前值时,可以调用该接口。

应用场景

读取当前配置项的值。支持的全部配置项请参见配置项。该接口实例参见读取配置项

URL

POST /action.cgi?ActionID=WEB_GetCfgParamAPI

请求参数结构

{

"CfgIDString": []

}

CfgIDString字段表示要读取的配置项ID字符串数组。注意,一次最多请求配置项个数不要太多,建议限制在50个以下。

请求参数示例

{"CfgIDString":["autoreply","isOpenNotReplyToUser","autoanswermute","dftCallWidth","openCallParam","isWifiPriority","maxInCallWidth"]}

成功响应结构

{

"success": X,

"data":"YYYY"

}

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

成功响应示例

{"success":1,"data":"{\"autoreply\":0,\"isOpenNotReplyToUser\":1,\"autoanswermute\":0,\"dftCallWidth\":159,\"openCallParam\":0,\"isWifiPriority\":0,\"maxInCallWidth\":240}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

保存配置项参数

接口名称

WEB_SaveCfgParamAPI

功能描述

保存配置项参数时可以调用该接口。

应用场景

该接口用于将配置项保存到系统中,同时通知相关的参数生效。支持的全部配置项请参见配置项。该接口实例参见保存配置项流程

URL

POST /action.cgi?ActionID=WEB_SaveCfgParamAPI

请求参数结构

{

"CfgItemInt":[],

"CfgItemString":[]

}

"CfgItemInt"字段表示需要保存的数字型配置项数组,而"CfgItemString"字段表示需要保存的字符串型配置项数组。数组中的每个元素都是如下结构,"CfgItemID"表示配置项ID,"CfgItemInfo"表示配置项的值。注意,一次最多保存配置项个数不要太多,建议限制在50个以下。

{

"CfgItemID": “xxx”,

"CfgItemInfo": YY

}

请求参数示例

{"CfgItemInt":[{"CfgItemID":"autoanswermute","CfgItemInfo":0},{"CfgItemID":"isOpenNotReplyToUser","CfgItemInfo":1},{"CfgItemID":"autoreply","CfgItemInfo":0},{"CfgItemID":"dftCallWidth","CfgItemInfo":159},{"CfgItemID":"openCallParam","CfgItemInfo":0},{"CfgItemID":"isWifiPriority","CfgItemInfo":0},{"CfgItemID":"maxInCallWidth","CfgItemInfo":159}],"CfgItemString":[]}

成功响应结构

{

"success": 1,

"data":"YYYY"

}

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

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666117,"code":151031810,"params":[]}}

获取某个配置项值的可选范围列表

接口名称

WEB_GetItemListCfgParamAPI

功能描述

获取某个配置项值的可选范围时,可以调用该接口。

应用场景

某个配置项,可选范围是A\B\C三种情况,该接口可以返回一个数组,包括A\B\C三个值。

URL

POST /action.cgi?ActionID=WEB_GetItemListCfgParamAPI

请求参数结构

{

{"CfgIDString":[配置项A名称, 配置项B名称,…]}

}

请求参数示例

{"CfgIDString":["country","timezone"]}

该参数是请求国家、时区两个配置项的可选范围。注意:本接口只适用于以下配置项:"country"\"timezone"\"audio_protocol"\"main_protocol"\

"aux_protocol"\"auxband_width"\"calltype"

成功响应结构

{

"success": X,

"data":"YYYY"

}

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

成功响应示例

参见国家选项枚举值时区选项枚举值

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":

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

读取SNMP配置项缺省值

接口名称

WEB_GetDftSnmpCfgAPI

功能描述

读取SNMP配置项缺省值时可以调用该接口。

应用场景

SNMP配置项在系统中有缺省值,调用该接口可以读取SNMP配置项在系统中的缺省值。

URL

POST /action.cgi?ActionID=WEB_ GetDftSnmpCfgAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": X,

"data":"YYYY"

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据。具体见8.1 SNMP结构体;

成功响应示例

{"success":1,"data":"{\"TrapVersion\":3,\"TrapTimeout\":1,\"TrapRetryTime\":5,\"TrapDestNum\":3,\"IsEnableSnmp\":1,\"TrapAddress1\":\"\",\"TrapAddress2\":\"\",\"TrapAddress3\":\"\",\"SnmpUserName\":\"trapinit\",\"SnmpEngineID\":\"\",\"SnmpSecurityLevel\":0,\"AccessProtocol\":1,\"AccessPwd\":\"***__***\",\"EncryptProtocol\":1,\"EncryptPwd\":\"***__***\",\"stV3UserInfo\":{\"AuthProtocal\":1,\"PrivProtocal\":1,\"UserPermission\":1,\"Username\":\"v3user\",\"Password\":\"***__***\",\"Key\":\"***__***\"}}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

读取SNMP配置项当前值

接口名称

WEB_GetSnmpCfgAPI

功能描述

读取SNMP配置项当前值时,可以调用该接口。

应用场景

读取当前配置项的值。

URL

POST /action.cgi?ActionID=WEB_ GetSnmpCfgAPI

请求参数结构

请求参数示例

-

成功响应结构

{

"success": X,

"data":"YYYY"

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应数据。具体见8.1 SNMP结构体;

成功响应示例

{"success":1,"data":"{\"TrapVersion\":3,\"TrapTimeout\":1,\"TrapRetryTime\":5,\"TrapDestNum\":3,\"IsEnableSnmp\":1,\"TrapAddress1\":\"192.168.0.47\",\"TrapAddress2\":\"192.168.0.46\",\"TrapAddress3\":\"192.168.0.45\",\"SnmpUserName\":\"trapinit\",\"SnmpEngineID\":\"800007DB0422\",\"SnmpSecurityLevel\":0,\"AccessProtocol\":1,\"AccessPwd\":\"***__***\",\"EncryptProtocol\":1,\"EncryptPwd\":\"***__***\",\"stV3UserInfo\":{\"AuthProtocal\":1,\"PrivProtocal\":1,\"UserPermission\":1,\"Username\":\"v3user\",\"Password\":\"***__***\",\"Key\":\"***__***\"}}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":

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

保存SNMP配置项参数

接口名称

WEB_SetSnmpCfgAPI

功能描述

保存SNMP配置项参数时可以调用该接口。

应用场景

该接口用于将SNMP配置项保存到系统中,同时通知相关的参数生效。

URL

POST /action.cgi?ActionID=WEB_ SetSnmpCfgAPI

请求参数结构

具体见8.1 SNMP结构体

请求参数示例

{"IsEnableSnmp":1,

/*UINT8 1: 启用

0:禁用

*/

"TrapAddress1":"192.168.0.47",

/*Trap服务器地址 1 2 3*/

"TrapAddress2":"192.168.0.46",

"TrapAddress3":"192.168.0.45",

"TrapVersion":3,

/*Trap版本

v3 trap:3

v3 inform:4

*/

"TrapTimeout":1,

"TrapRetryTime":5,

/*

TrapTimeout:Trap超时时间,秒,[1,5];

TrapRetryTime:重试次数,[1,10];

这两个参数在TrapVersion值为4时需要设置;

*/

"TrapDestNum":3,// 隐藏项,默认3

"SnmpUserName":"trapinit",

/*Trap用户名最大128字节*/

"SnmpEngineID":"800007DB0422",

/*

ID:该信息允许为空,只允许输入数字或a-f或A-F,长度12-64位,前缀是800007DB04,不区分大小写,并且长度必须是偶数。

*/

"SnmpSecurityLevel":0,// 隐藏项,默认0

"AccessProtocol":1,

/*

Trap认证协议;

MD5:0

SHA:1

不认证:2

*/

"AccessPwd":"***__***",

/*Trap认证密码*/

"EncryptProtocol":1,

/*

Trap加密协议;

DES:0;

AES:1;

不加密:2

*/

"EncryptPwd":"***__***",

/*加密密码*/

"stV3UserInfo":

/*以下是snmpv3认证信息*/

{"AuthProtocal":1,

/*

认证协议;

MD5:0

SHA:1

不认证:2

*/

"PrivProtocal":1,

/*

加密协议;

DES:0;

AES:1;

不加密:2

*/

"UserPermission":1,

/*用户读写权限*/

只读:0

读写:1

"Username":"v3user",

/*用户名*/

"Password":"***__***",

/*认证密码,最少8八位,必须包含大小写或者特殊字符*/

"Key":"***__***"

/*加密密码*/

}

}

成功响应结构

{

"success": 1,

"data":"YYYY"

}

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

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100668795,"code":1,"params":[]}}

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

文档编号:EDOC1100044503

浏览量:5381

下载量:63

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