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

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

提示

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

升级

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

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

登录认证类

请求会话ID

接口名称

WEB_RequestSessionIDAPI

功能描述

请求会话ID,会话ID是区分不同用户连接的唯一标识。

应用场景

用户登录认证前,请求会话ID,后续认证时,需要将会话ID作为cookie的一部分传递下去。该接口应用实例,参见登录认证流程介绍

URL

POST /action.cgi?ActionID=WEB_RequestSessionIDAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": X,

"data":"{

"acSessionId": "",

"szTermType":"Huawei TE10"

}

}

“success”字段表示响应结果,0表示失败,1表示成功。

"acSessionId",字段返回空,TE10、TE20已将Sessionid放在cookie中。

成功响应示例

{"success":1,"data":"{\"acSessionId\":\" \",\"szTermType\":\"Huawei TE10\"}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。

“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

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

请求认证

接口名称

WEB_RequestCertificateAPI

功能描述

调用该接口请求认证,校验用户名、密码。并返回CSRF Token;

应用场景

通过该接口,将用户名、密码等发到服务器端校验,如果校验成功,则认证通过,并返回CSRF Token,后续所有json数据请求,都必须带上CSRF Token字段;;反之,返回失败响应,认证不通过。通过HTTP API接口对终端的操作,前提是认证通过。该接口应用实例,参见登录认证流程介绍

URL

POST /action.cgi?ActionID=WEB_RequestCertificateAPI

请求参数结构

{

“user” : “XXXXXX”,

"password": "YYYYYYYY"

}

“user”字段是用户名,”password”字段是密码。

请求参数示例

{

"user":"api",

"password":"Change_Me"

}

成功响应结构

{"success":1,

"data":"

{

\"acCSRFToken\":\"s9C1zjO5HLnSf9u4eKP9uKfn8Kb9T94j\"

}

"}

“success”字段表示响应结果,0表示失败,1表示成功。

“data”字段表示响应数据,允许为空。

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。

“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

{"success":0,"error":{"id":100666780,"code":16781315,"params":[]}}

更换会话ID

接口名称

WEB_ChangeSessionIDAPI

功能描述

请求更换会话ID,会话ID是区分不同用户连接的唯一标识。

应用场景

认证成功后,需要更换会话ID,后续认证时,需要将该会话ID作为cookie的一部分传递下去。该接口应用实例,参见2.2 登录认证流程介绍。

URL

POST /action.cgi?ActionID= WEB_ChangeSessionIDAPI

请求参数结构

请求参数示例

成功响应结构

{

"success": X,

"data":"{

"acSessionId": "",

"szTermType":"Huawei TE10"

}

}

“success”字段表示响应结果,0表示失败,1表示成功。

"acSessionId",字段返回空,TE10、TE20已将Sessionid放在cookie中。

成功响应示例

{"success":1,"data":"{\"acSessionId\":\" \",\"szTermType\":\"Huawei TE10\"}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

“success”字段表示响应结果,0表示失败,1表示成功。

“code”字段表示错误码,而“params”字段表示该失败响应的附带参数。

失败响应示例

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

请求邮箱数据

接口名称

WEB_GetMailboxDataAPI

功能描述

Web前台向后台请求邮箱数据时调用该接口。

应用场景

该接口用于请求消息数据和用户订阅的状态数据,同时用于维持客户端和服务端之间的常连接。客户端向服务端发送该请求的时间间隔必须小于60秒。该接口实例参见综合示例

URL

POST /action.cgi?ActionID=WEB_GetMailboxDataAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":{

“state":{},

"msgStruct": {

“iResult":0,

"msg":[]

}

}

}

“success”字段表示请求结果,0表示失败,1表示成功。

state字段表示订阅的邮箱状态。msgStruct字段表示收到的消息数组。

成功响应示例

{"success":1,"data":"{\"state\":{\"sitename\":\"site\",\"speaker\":1,\"mic\":1,\"gk\":1,\"sip\":1,\"upgrade\":0,\"callstate\":0,\"calltype\":0,\"conftype\":0,\"sitecall\":0,\"chair\":0,\"miniMcu\":0,\"isInConf\":0,\"pstnstate\":0,\"t140cap\":2,\"isHwGk\":1,\"h239cap\":0,\"tv_H239_hd2\":0,\"useminimcu\":0,\"wifi\":0,\"RemoteMicStates\":0,\"cfgonebit\":189,\"statebit\":4,\"speakerValue\":0,\"micValue\":0,\"statebit2\":0},\"msgStruct\":\"{\\\"iResult\\\":0,\\\"msg\\\":[\\\"{\\\\\\\"msgID\\\\\\\":4500,\\\\\\\"msgName\\\\\\\":\\\\\\\"MSG_SAVEBOOK_ADDR\\\\\\\",\\\\\\\"subMsgID\\\\\\\":31744,\\\\\\\"param1\\\\\\\":0,\\\\\\\"param2\\\\\\\":0,\\\\\\\"msgData\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"sessionID\\\\\\\":\\\\\\\"\\\\\\\"}\\\"]}\"}"}

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

订阅邮箱状态数据

接口名称

WEB_SubscribeMailboxDataAPI

功能描述

订阅邮箱状态数据。对应的取消订阅邮箱状态数据的接口为WEB_UnSubscribeMailboxDataAPI。订阅的数据,会在邮箱请求中(WEB_GetMailboxDataAPI)响应给用户。该接口实例参见订阅消息数据和状态数据

目前TE10/20已不需要订阅或者取消订阅状态数据,状态数据自动随邮箱返回;为保持兼容性,该接口直接返回成功;

应用场景

订阅邮箱状态数据。提供的状态数据接口请参见邮箱

URL

POST /action.cgi?ActionID=WEB_SubscribeMailboxDataAPI

请求参数结构

{

"aszMailboxItems":[]

}

aszMailboxItems字段表示取消订阅邮箱数据的状态数组

请求参数示例

{"aszMailboxItems ":["sitename","pstnState"]}

该示例表示对sitename(会场名称)和pstnState(PSTN状态)这两个状态注册侦听。

成功响应结构

{

"success": X,

"data": "YYYYY”

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应的附带数据,可以为空。

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

取消订阅邮箱状态数据

接口名称

WEB_UnSubscribeMailboxDataAPI

功能描述

取消订阅邮箱状态数据时调用该接口。

应用场景

取消订阅邮箱状态数据。提供的状态数据接口请参见邮箱。该接口实例参见订阅消息数据和状态数据

目前TE10/20已不需要订阅或者取消订阅状态数据,状态数据自动随邮箱返回;为保持兼容性,该接口直接返回成功;

URL

POST /action.cgi?ActionID=WEB_UnSubscribeMailboxDataAPI

请求参数结构

{

"aszMailboxItems":[]

}

aszMailboxItems字段表示取消订阅邮箱数据的状态数组。

请求参数示例

{"aszMailboxItems":["sitename","pstnState"]}

表示对sitename和pstnState两项状态的取消注册侦听。

成功响应结构

{

"success": X,

"data": "YYYYY”

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应的附带数据,可以为空。

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

订阅邮箱消息数据

接口名称

WEB_SubscribeMsgAPI

功能描述

订阅邮箱消息数据时调用该接口。对应的取消邮箱订阅消息的接口为WEB_UnSubscribeMsgAPI。

应用场景

订阅邮箱消息数据。提供的消息接口请参见消息接口。如果侦听的消息数据发生了变化,则会在邮箱请求中(WEB_GetMailboxDataAPI)响应给用户。该接口实例参见订阅消息数据和状态数据

URL

POST /action.cgi?ActionID=WEB_SubscribeMsgAPI

请求参数结构

{

" aszMsgIDs": []

}

aszMsgIDs字段表示要订阅的消息ID数组

请求参数示例

{"aszMsgIDs":["MSG_CALL_RSP","MSG_CALL_INCOMING"]}

该参数表示侦听MSG_CALL_RSP和MSG_CALL_INCOMING这两个消息

成功响应结构

{

"success": X,

"data": "YYYYY”

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应的附带数据,可以为空。

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id": 100666777,"code": 151031814,"params":[]}}

取消订阅邮箱消息

接口名称

WEB_UnSubscribeMsgAPI

功能描述

取消订阅邮箱消息时调用该接口。

应用场景

取消订阅邮箱消息。提供的消息接口请参见消息接口。该接口实例参见订阅消息数据和状态数据

URL

POST /action.cgi?ActionID=WEB_UnSubscribeMsgAPI

请求参数结构

{

" aszMsgIDs": []

}

aszMsgIDs字段表示要取消侦听的消息ID数组

请求参数示例

{" aszMsgIDs ":["MSG_CALL_RSP","MSG_CALL_INCOMING"]}

该参数表示对MSG_CALL_RSP和MSG_CALL_INCOMING这两个消息取消注册侦听

成功响应结构

{

"success": X,

"data": "YYYYY”

}

“success”字段表示响应结果,0表示失败,1表示成功。“data”字段表示响应的附带数据,可以为空。

成功响应示例

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

失败响应结构

{

"success": X,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id": 100666777,"code": 151031814,"params":[]}}

退出登录

接口名称

WEB_LogoutAPI

功能描述

Api用户退出登录时可以调用该接口。

应用场景

Api用户断开连接时需要执行此操作。

URL

POST /action.cgi?ActionID=WEB_LogoutAPI

请求参数结构

请求参数示例

成功响应结构

{

"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":100666995,"code":33558532,"params":[]}}

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

文档编号:EDOC1100044503

浏览量:5343

下载量:63

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