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

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

提示

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

升级

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

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

地址本类

获取地址本会场列表

接口名称

WEB_GetSiteListAPI

功能描述

获取地址本会场列表时调用该接口。地址本有变化时,邮箱上报MSG_SAVEBOOK_ADDR消息,刷新地址本列表。

应用场景

获取地址本会场列表。支持获取全部列表和部分列表。

URL

POST /action.cgi?ActionID=WEB_GetSiteListAPI

请求参数结构

{

"ParamIntArray": []

}

"ParamIntArray"字段表示需要获取的地址本会场ID数组。该接口可以不带参数,此时默认获取全部会场列表。如果需要获取指定记录,就需要携带参数,可以参考下面的参数示例。

请求参数示例

{"ParamIntArray":[1,4,5]}

1、4、5表示需要获取的地址本记录ID

成功响应结构

{

"success": 1,

"data": {

"ulSiteNum": X,

"astSites": [],

"ulMeetingRoomNum": Y,

"astMeetingRoom":[]

}

}

success表示响应结果,0表示失败,1表示成功。ulSiteNum表示地址本会场个数,"astSites"表示地址本记录数组,参见WEB_ADDR_RECORD结构,"ulMeetingRoomNum"表示虚拟会议室记录个数,"astMeetingRoom"表示虚拟会议室记录数组。

成功响应示例

{"success":1,"data":"{\"astSites\":[{\"uwID\":1,\"ucType\":8,\"ucDevice\":0,\"bIsLdap\":0,\"ucOnline\":4,\"uwSortPos\":0,\"stTPS\":{},\"stCTS\":{},\"stISDN\":{},\"stIP\":{},\"stSIP\":{\"ucBaudRate\":159,\"szAlias\":\"0755001\",\"szIP\":\"\",\"szUri\":\"\"},\"stV35\":{},\"stE1\":{},\"stIPOverE1\":{},\"stT1\":{},\"stPhone\":{},\"stPSTN\":{},\"szName\":\"AddrRecord 001\",\"szAddrFilter\":\"\"},{\"uwID\":4,\"ucType\":8,\"ucDevice\":0,\"bIsLdap\":1,\"ucOnline\":2,\"uwSortPos\":0,\"stTPS\":{},\"stCTS\":{},\"stISDN\":{},\"stIP\":{},\"stSIP\":{\"ucBaudRate\":239,\"szAlias\":\"\",\"szIP\":\"\",\"szUri\":\"01513208722@zdtest.com\"},\"stV35\":{},\"stE1\":{},\"stIPOverE1\":{},\"stT1\":{},\"stPhone\":{},\"stPSTN\":{},\"szName\":\"01513208722\",\"szAddrFilter\":\"\"}],\"astMeetingRoom\":[]}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":

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

新增一条会场记录

接口名称

WEB_AddSiteItemAPI

功能描述

新增一条会场记录时调用该接口。

应用场景

新增一条会场记录到地址本中,包括会场名称,号码,速率,线路状态,在线状态等参数。添加成功后,邮箱上报MSG_SAVEBOOK_ADDR消息,此时可以根据需要刷新会场列表。

URL

POST /action.cgi?ActionID=WEB_AddSiteItemAPI

请求参数结构

WEB_ADDR_RECORD

请求参数示例

{"uwID":0,"ucType":8,"ucDevice":0,"bIsLdap":0,"ucOnline":0,"uwSortPos":0,"stTPS":{},"stCTS":{},"stISDN":{},"stIP":{},"stSIP":{"ucBaudRate":159,"szAlias":"0755002","szIP":"","szUri":""},"stV35":{},"stE1":{},"stIPOverE1":{},"stT1":{},"stPhone":{},"stPSTN":{},"szName":"AddrRecord 002","szPName":""}

成功响应结构

{

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

修改会场记录

接口名称

WEB_SaveSiteItemAPI

功能描述

修改会场记录时调用该接口。

应用场景

修改地址本中的一条会场记录,包括会场名称,号码,速率,线路状态,在线状态等参数。修改成功后,邮箱上报MSG_SAVEBOOK_ADDR消息,此时可以根据需要刷新会场列表。

URL

POST /action.cgi?ActionID=WEB_SaveSiteItemAPI

请求参数结构

WEB_ADDR_RECORD

请求参数示例

{"uwID":5,"ucType":8,"ucDevice":0,"bIsLdap":0,"ucOnline":0,"uwSortPos":0,"stTPS":{},"stCTS":{},"stISDN":{},"stIP":{},"stSIP":{"ucBaudRate":159,"szAlias":"0755002","szIP":"","szUri":""},"stV35":{},"stE1":{},"stIPOverE1":{},"stT1":{},"stPhone":{},"stPSTN":{},"szName":"AddrRecord 002_Change_Name","szPName":""}

成功响应结构

{

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

删除会场记录

接口名称

WEB_DelSiteItemAPI

功能描述

删除会场记录时调用该接口。

应用场景

把一条或多条会场记录从地址本中删除。删除成功后,邮箱上报MSG_SAVEBOOK_ADDR消息,此时可以根据需要刷新会场列表。

URL

POST /action.cgi?ActionID=WEB_DelSiteItemAPI

请求参数结构

{

"ParamIntArray":[]

}

"ParamIntArray"字段表示要删除的会场ID数组

请求参数示例

{"ParamIntArray":[2,4,5]}

成功响应结构

{

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

获取群组列表

接口名称

WEB_GetGroupListAPI

功能描述

获取群组列表时调用该接口。

应用场景

群组是指包含若干条会场记录的一条纪录。支持获取全部群组列表和部分群组列表。请求参数允许为空,此时默认返回全部群组列表。

URL

POST /action.cgi?ActionID=WEB_GetGroupListAPI

请求参数结构

{

"ParamIntArray": []

}

"ParamIntArray"字段表示需要获取的群组ID数组,如果不携带参数,则默认为返回全部群组列表。

请求参数示例

{"ParamIntArray":[1,4,5]}

成功响应结构

{

"success":1,

"data":"{

"GroupList":[]

}"

}

Success表示响应结果,0表示失败,1表示成功。GroupList表示群组列表数组。数组中的每个元素都是如下结构,szGroupName表示群组名称,uwGroupID表示群组ID,uwSiteCount表示群组中会场个数,auwSiteID表示该群组中包含会场的数组。

{

"szGroupName":"Group002",

"uwGroupID":3,

"uwSiteCount":2,

"auwSiteID":[3,21]

}

成功响应示例

{"success":1,"data":"{\"GroupList\":[{\"uwGroupID\":1,\"uwSiteCount\":1,\"auwSiteID\":[1],\"szGroupName\":\"Group 001\"},{\"uwGroupID\":2,\"uwSiteCount\":1,\"auwSiteID\":[4],\"szGroupName\":\"Group 002\"}]}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

新增群组记录

接口名称

WEB_AddGroupItemAPI

功能描述

新增群组记录时调用该接口。

应用场景

在地址本中新增一条群组记录。新增成功后,邮箱会上报MSG_SAVEBOOK_GROUP消息,根据此消息刷新列表

URL

POST /action.cgi?ActionID=WEB_AddGroupItemAPI

请求参数结构

{

"szGroupName":"Group002",

"uwGroupID":0,

"uwSiteCount":2,

"auwSiteID":[3,21]

}

szGroupName表示群组名称,uwGroupID固定为0,uwSiteCount表示群组中会场个数,auwSiteID表示该群组中包含会场的数组。

请求参数示例

{"szGroupName":"Group 003","uwGroupID":0,"uwSiteCount":1,"auwSiteID":[5] }

成功响应结构

{

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

修改群组记录

接口名称

WEB_SaveGroupItemAPI

功能描述

修改群组记录时调用该接口。

应用场景

修改地址本中的一条群组记录,可以修改群组名称,添加,删除会场等。修改成功后,邮箱会上报MSG_SAVEBOOK_GROUP消息,根据此消息刷新列表

URL

POST /action.cgi?ActionID=WEB_SaveGroupItemAPI

请求参数结构

{

"szGroupName":"Group002",

"uwGroupID":5,

"uwSiteCount":2,

"auwSiteID":[3,21]

}

szGroupName表示群组名称,uwGroupID表示群组ID,uwSiteCount表示群组中会场个数,auwSiteID表示该群组中包含会场的数组。

请求参数示例

{"szGroupName":"Group 002","uwGroupID":2,"uwSiteCount":2,"auwSiteID":[4,1]}

成功响应结构

{

"success": 1,

"data":"YYYY"

}

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

成功响应示例

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

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666039,"code":83906589,"params":[]}}

删除群组记录

接口名称

WEB_DelGroupItemAPI

功能描述

删除群组记录时调用该接口。

应用场景

删除地址本中的一条或多条群组记录。删除成功后,邮箱会上报MSG_SAVEBOOK_GROUP消息,根据此消息刷新列表。

URL

POST /action.cgi?ActionID=WEB_DelGroupItemAPI

请求参数结构

{

"auwGroupID":[2,4,5]

}

"auwGroupID"表示要删除的群组ID数组

请求参数示例

{"auwGroupID":[2,4,5]}

成功响应结构

{

"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_RequestDefaultRecordNameAPI

功能描述

获取记录本缺省名称时调用该接口。

应用场景

获取记录本缺省名称。

用于新建一条记录时自动生成一个不重复的缺省名称。

URL

POST /action.cgi?ActionID=WEB_RequestDefaultRecordNameAPI

请求参数结构

{

"recordType":"SITE"

}

recordType表示记录本类型,如下:

‘SITE’:获取地址本名称缺省

’GROUP':获取群组缺省名称,

‘CONF’:获取预定义会议缺省名称

‘TEMPLATE’:获取会场缺省模板

请求参数示例

{"recordType":"SITE"}

成功响应结构

{

"success": 1,

"data": {

"defaultName": "XXX"

}

}

“success”字段表示响应结果,0表示失败,1表示成功。”defaultName”字段表示获取的缺省名称。

成功响应示例

{"success":1,"data":"{\"defaultName\":\"AddrRecord 004\"}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

请求地址本变化的ID列表

接口名称

WEB_GetSiteTabelChangeListAPI

功能描述

请求地址本变化的ID列表时调用该接口。

应用场景

请求地址本变化的ID列表。当地址本记录发生变化,系统会对所有订阅了地址本变化消息的用户推送邮箱消息,同时将变化的ID列表缓存(每个注册了该消息的用户缓存一份)。用户读取了该列表后,会将ID列表缓存清空。

URL

POST /action.cgi?ActionID=WEB_GetSiteTabelChangeListAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"{

"result":2,

"list":[]

}"

}

success表示响应结果,0表示失败,1表示成功;list表示变化的地址本数组,数组中的每个元素都是如下结构:

{

"id": 22,

"operation":1

}

其中,id表示地址本记录ID,operation表示地址本记录发生变化的类型,0表示添加,1表示修改,2表示删除

成功响应示例

{"success":1,

"data":"{\"result\":2,\"list\":[{\"id\":22,\"operation\":1},

{\"id\":23,\"operation\":1},{\"id\":24,\"operation\":1},

{\"id\":25,\"operation\":1},{\"id\":56,\"operation\":0},

{\"id\":57,\"operation\":0}]}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

搜索LDAP地址本

接口名称

WEB_SeachLdapAddrAPI

功能描述

搜索LDAP地址本时调用该接口。

应用场景

一般和接口WEB_GetLdapAddrResultListAPI配合使用。

WEB_SeachLdapAddrAPI用于向服务器发起查询请求,是否查询成功,是通过MSG_LDAP_SEARCH_RSP消息上报的,如果是成功的消息,就需要再调用WEB_GetLdapAddrResultListAPI获取查询结果。

URL

POST /action.cgi?ActionID=WEB_SeachLdapAddrAPI

请求参数结构

{

"szKeyWords":"0755"

}

"szKeyWords"字段表示搜索关键字,如果是*,默认搜索全部记录。

请求参数示例

{"szKeyWords":"0755"}

成功响应结构

{

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

获取已搜索到的LDAP地址本结果列表

接口名称

WEB_GetLdapAddrResultListAPI

功能描述

获取已搜索到的LDAP地址本结果列表时调用该接口。

应用场景

获取已搜索到的LDAP地址本结果列表。使用本接口的前提是收到了MSG_LDAP_SEARCH_RSP,并且是成功的消息。

URL

POST /action.cgi?ActionID=WEB_GetLdapAddrResultListAPI

请求参数结构

请求参数示例

成功响应结构

响应结构具体见

WEB_LDAP_RESULT_ASN

WEB_LDAP_RECORD_ASN

LdapList表示要保存的LDAP记录数组,数组中的每个元素都如下结构,各字段函数不再赘述。

{

"site":"AddrRecord002",

"type":8,

"device":3,

"dn":"",

"cn":"",

"h323Ip":"",

"h323Num":"",

"h323Uri":"",

"sipIp":"",

"sipNum":"",

"sipUri":"",

"mainIp":"",

"mainNum":"",

"leftIp":"",

"leftNum":"",

"rightIp":"",

"rightNum":"",

"ctNum":"",

"screen":0,

"vccNum":"0123456789@",

"mobile":"",

"telephone":"",

"email":""

}

成功响应示例

{"success":1,

"data":"{\"count\":2,

\"LdapList\":[{\"site\":\"Y_ldap_common_all_07550123\",\"type\":0,

\"device\":0,\"dn\":\"\\n\",\"cn\":\"\",\"h323Ip\":\"10.11.3.1\",

\"h323Num\":\"h3231234\",\"h323Uri\":\"123@huawei\",

\"sipIp\":\"10.11.3.1\",\"sipNum\":\"h3231234\",

\"sipUri\":\"123@huawei\",\"mainIp\":\"\",\"mainNum\":\"\",

\"leftIp\":\"\",\"leftNum\":\"\",\"rightIp\":\"\",\"rightNum\":\"\",

\"ctNum\":\"\",

\"screen\":0,\"vccNum\":\"\",\"mobile\":\"\",\"telephone\":\"\",

\"email\":\"\"},{\"site\":\"AddrRecord004\",

\"type\":0,\"device\":0,\"dn\":\"\",\"cn\":\"\",\"h323Ip\":\"10.11.3.1\",

\"h323Num\":\"h3231234\",\"h323Uri\":\"123@huawei\",

\"sipIp\":\"10.11.3.1\",\"sipNum\":\"h3231234\",

\"sipUri\":\"123@huawei\",\"mainIp\":\"\",\"mainNum\":\"\",

\"leftIp\":\"\",\"leftNum\":\"\",

\"rightIp\":\"\",\"rightNum\":\"\",\"ctNum\":\"\",

\"screen\":0,\"vccNum\":\"\",

\"mobile\":\"\",\"telephone\":\"\",\"email\":\"\"}]}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

保存LDAP地址本

接口名称

WEB_SaveLdapSiteToAddrbookAPI

功能描述

保存LDAP地址本时调用该接口。

应用场景

将搜索到的LDAP地址本记录保存到本地终端的地址本。

URL

POST /action.cgi?ActionID=WEB_ SaveLdapSiteToAddrbookAPI

请求参数结构

{

"overwrite":0,

"LdapList":[]

}

具体见WEB_LDAP_SAVE_LIST结构体;

overwrite字段表示当LDAP记录同本地记录冲突时,是否覆盖本地记录。LdapList表示要保存的LDAP记录数组,数组中的每个元素都如下结构,各字段函数不再赘述。

{

"site":"AddrRecord002",

"type":8,

"device":3,

"dn":"",

"cn":"",

"h323Ip":"",

"h323Num":"",

"h323Uri":"",

"sipIp":"",

"sipNum":"",

"sipUri":"",

"mainIp":"",

"mainNum":"",

"leftIp":"",

"leftNum":"",

"rightIp":"",

"rightNum":"",

"ctNum":"",

"screen":0,

"vccNum":"0123456789@",

"mobile":"",

"telephone":"",

"email":""

}

请求参数示例

{"overwrite":0,

"LdapList":[{"site":"AddrRecord002",

"type":8,"device":3,"dn":"","cn":"","h323Ip":"",

"h323Num":"","h323Uri":"","sipIp":"","sipNum":"","sipUri":"",

"mainIp":"","mainNum":"","leftIp":"",

"leftNum":"","rightIp":"","rightNum":"","ctNum":"","screen":0,

"vccNum":"0123456789@","mobile":"","telephone":"","email":""},

{"site":"AddrRecord003","type":0,"device":0,

"dn":"","cn":"","h323Ip":"10.11.3.1",

"h323Num":"h3231234","h323Uri":"123@huawei",

"sipIp":"10.11.3.1","sipNum":"h3231234",

"sipUri":"123@huawei","mainIp":"","mainNum":"",

"leftIp":"","leftNum":"","rightIp":"","rightNum":"","ctNum":"",

"screen":0,"vccNum":"","mobile":"","telephone":"","email":""}]}

成功响应结构

{

"success":1,

"data":{

"send":8,

"save":4

}

}

success表示响应结果,0表示失败,1表示成功。send表示需要保存的LDAP记录总条数,save表示保存成功的条数。Send和save两个字段不一定一致。

成功响应示例

{"success":1,"data":"{\"send\":8,\"save\":4}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

地址本导入到终端

接口名称

addrimport

功能描述

地址本导入到终端时调用该接口。

应用场景

地址本文件从本地计算机导入到终端。addrimport为要导入的地址本文件名称。

URL

POST /addrimport

请求参数结构

请求参数示例

POST /addrimport HTTP/1.1

成功响应结构

{

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

地址本导出

接口名称

WEB_ AddrExportAPI

功能描述

地址本导出到本地计算机时调用该接口。

应用场景

地址本导出CGI请求。和文件请求接口’addrbook.vcf’配合使用。

‘WEB_AddrExportAPI’ 用于系统准备地址本文件。之后通知用户,用户再调用’addrbook.vcf’接口获取地址本文件。

URL

POST /action.cgi?ActionID=WEB_ AddrExportAPI

请求参数结构

{

"charset":"UTF8"

}

charset字段表示地址本导出后的字符类型,“LOCAL”表示本地字符集,“UTF8”表示UTF8。

请求参数示例

{"charset":"UTF8"}

成功响应结构

如下

成功响应示例

HTTP/1.1 200 OK

SEVER-VER: TSP_HTTP_SERVER/2.1.3 VCT WEB 1.0

Connection: Keep-Alive

Content-Type: application/octet-stream

Cache-Control: max-age=0

Content-Length: 244

BEGIN:VCARD

VERSION:2.1

X-CHARSET:UTF-8

N:...............

X-LINETYPE:4E1

X-SPEED:246

TEL;WORK;VIDEO: 010000002

END:VCARD

BEGIN:VCARD

VERSION:2.1

X-CHARSET:UTF-8

N:......

X-LINETYPE:IP

X-SPEED:246

TEL;WORK;VIDEO: 01001

END:VCARD

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

地址本导出文件请求

接口名称

addrbook.vcf

功能描述

地址本导出文件请求时调用该接口。

应用场景

地址本导出文件请求。和’ WEB_ AddrExportAPI’配合使用。

‘addrbook.vcf’为要导出的文件名称。

‘WEB_ AddrExportAPI’ 用于系统准备地址本文件。之后通知用户,用户再调用‘addrbook.vcf’接口获取地址本文件。

URL

GET / addrbook.vcf

请求参数结构

请求参数示例

GET /AddressBook.vcf HTTP/1.1

成功响应结构

成功响应示例

HTTP/1.1 200 OK

SEVER-VER: TSP_HTTP_SERVER/2.1.3 VCT WEB 1.0

Connection: Keep-Alive

Content-Type: application/octet-stream

Cache-Control: max-age=0

Content-Length: 244

失败响应结构

失败响应示例

批量添加云大厅

接口名称

WEB_AddCloudPlatListAPI

功能描述

批量添加云大厅

应用场景

批量添加云大厅

URL

POST /action.cgi?ActionID=WEB_AddCloudPlatListAPI

请求参数结构

{

"cloudsList":[]

}

请求参数示例

{

"cloudsList":[{"name":"name1","addr":"addr1"},{"name":"name2","addr":"addr2"}]

}

成功响应结构

如下

成功响应示例

{"success":1,"data":"{\"Param1\":2,\"Param2\":0,\"Param3\":0,\"Param4\":0}"}

失败响应结构

如下

失败响应示例

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

清空云大厅列表

接口名称

WEB_DelAllCloudPlatsAPI

功能描述

清空云大厅列表

应用场景

清空云大厅列表

URL

POST /action.cgi?ActionID=WEB_DelAllCloudPlatsAPI

请求参数结构

请求参数示例

成功响应结构

如下

成功响应示例

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

失败响应结构

如下

失败响应示例

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

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

文档编号:EDOC1100044503

浏览量:4930

下载量:63

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