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

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

提示

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

升级

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

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

会议控制类

观看会场

接口名称

WEB_ViewSiteAPI

功能描述

观看某个入会会场或多画面;

应用场景

1.适应于主席会场、非主席会场;

2.在需要观看会场或多画面时,可以通过调用该接口实现。观看会场后,会上报MSG_VIEW_SITE_RSP消息,表示观看结果(成功、失败)。观看成功后,就显示被选中观看的会场或多画面。观看失败后,可以根据实际需要做处理。

URL

POST /action.cgi?ActionID=WEB_ViewSiteAPI

请求参数结构

{

"M": 1,

"T": 2,

"type": "normal",

"picID": 0

}

M表示会场M号,T号表示会场T号,type表示类型,观看普通会场时是“normal”,观看多画面时是“mulpic”,picID表示多组多画面ID,只有在观看多画面时才有用。

请求参数示例

{

"M": 1,

"T": 2,

"type": "normal",

"picID": 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":100666767,"code":50343937,"params":[]}}

错误码包括如下:(50343937: 0x3003001)

0x3001 /* 当前不在多点会议中,一般由于误操作导致 */

0x9004 /* 系统内部错误,一般是由于下发参数格式错误导致,例如,M号应该是数字型的1,但是参数中写成了“1” ;或者是服务端与底层模块通信异常导致 */

0x9003 /* 其他用户正在进行该操作 */

主席结束会议

接口名称

WEB_EndConfAPI

功能描述

主席结束会议时调用该接口。

应用场景

主席结束会议。只有主席才能进行该操作。

处理结果由消息MSG_END_CONF_RSP上报。

URL

POST /action.cgi?ActionID=WEB_EndConfAPI

请求参数结构

请求参数示例

成功响应结构

{

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

功能描述

广播会场。

应用场景

只有主席才能进行该操作。

在会场列表中选择一个会场进行广播操作,也可以选择广播多画面。语音会场和未入会会场不能被广播。某个会场被广播后,其他会场都会看到该会场的图像。

处理结果由消息MSG_BROADCAST_RSP上报。

URL

POST /action.cgi?ActionID=WEB_ConfBroadcastSiteAPI

请求参数结构

{

"M": 1,

"T": 2,

"type": "normal",

"picID": 0

}

M表示会场M号,T号表示会场T号,广播会场时type固定为“normal”, picID表示多组多画面ID,广播会场时固定为0。

请求参数示例

{

"M": 1,

"T": 2,

"type": "normal",

"picID": 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_ConfCancelBroadcastAPI

功能描述

停止广播。

应用场景

只有主席才能进行该操作。同广播操作相对应,停止广播后,各个会场可以自由地观看任意会场。

处理结果由消息MSG_BRDCAST_CANCEL上报。

URL

POST /action.cgi?ActionID=WEB_ViewSiteAPI

请求参数结构

请求参数示例

成功响应结构

{

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

功能描述

释放主席。

应用场景

只有主席才能进行该操作。释放主席后,会议中就没有主席,其他会场可以去申请主席。会场释放主席后,就只能进行观看会场操作;释放主席后,只要会议中没有主席,仍然可以再次申请主席。

处理结果由消息MSG_FREE_CHAIR_RSP上报。

URL

POST /action.cgi?ActionID=WEB_ReleaseChairAPI

请求参数结构

请求参数示例

成功响应结构

{

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

功能描述

挂断某个入会会场;

应用场景

挂断会场。只有主席才能进行该操作。

在会场列表中选择一个入会会场进行挂断操作。一旦某个会场被挂断后,该会场就处于未入会状态。主席会场可以通过呼叫该会场方式,将其再次呼叫入会。主席会场也可以挂断自己。

处理结果由消息MSG_HANGUP_SITE_RSP上报。

URL

POST /action.cgi?ActionID=WEB_ConfHangupSiteAPI

请求参数结构

{

"M": 1,

"T": 2

}

M表示会场M号,T表示会场T号。

请求参数示例

{

"M": 1,

"T": 2

}

成功响应结构

{

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

主席开关MIC

接口名称

WEB_ConfMuteSiteAPI

功能描述

打开或关闭某个会场的MIC。

应用场景

只有主席才能进行该操作。

在会场列表中选择一个入会会场,对其MIC进行打开、关闭操作。关闭某个会场的MIC后,其他会场就听不到该会场的声音了。

处理结果由消息MSG_MUTE_RSP上报

URL

POST /action.cgi?ActionID=WEB_ConfMuteSiteAPI

请求参数结构

{

"action": "mute",

"mt": {

"M": 1,

"T": 3

}

}

action字段表示操作类型,mute表示关闭MIC,unMute表示打开MIC,M表示要操作的会场M号,T表示要操作的会场T号。

请求参数示例

{

"action": "mute",

"mt": {

"M": 1,

"T": 3

}

}

成功响应结构

{

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

功能描述

将一个地址本会场添加到会议中。

应用场景

只有主席才能进行该操作。终端支持在会议中动态地添加会场,但是添加成功后,添加进来的会场可能入会,也可能不入会。

处理结果由消息MSG_ADD_SITE_RSP上报。可以通过通过WEB_GetSiteListAPI接口获取地址本列表。

URL

POST /action.cgi?ActionID=WEB_ConfAddSiteAPI

请求参数结构

{

"siteId": 11

}

siteId字段表示要添加的地址本会场ID。

请求参数示例

{

"siteId": 11

}

成功响应结构

{

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

功能描述

呼叫未入会会场。

应用场景

只有主席会场才能进行该操作。

从会场列表中选择一个未入会会场进行呼叫,呼叫结果可能是该会场入会,也可能不入会。呼叫会场同挂断会场是相对应的。

处理结果由消息MSG_CALL_SITE_RSP上报。

URL

POST /action.cgi?ActionID=WEB_ConfCallSiteAPI

请求参数结构

{

"M": 1,

"T": 2

}

M表示会场M号,T表示会场T号。

请求参数示例

{

"M": 1,

"T": 2

}

成功响应结构

{

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

功能描述

主席延长会议。

应用场景

只有主席才能进行该操作。延长时间单位是分钟,最大允许延长360分钟。在会议剩余时间较短,但会议议程还有很多的情况下,使用该接口。

处理结果由消息MSG_DELAY_CONF_RSP上报。

URL

POST /action.cgi?ActionID=WEB_ConfTimeDelayAPI

请求参数结构

{

"delayTime": 200

}

"delayTime"表示延长的会议时间,最小值是10,最大值是360

请求参数示例

{

"delayTime": 200

}

成功响应结构

{

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

功能描述

申请主席。

应用场景

非主席才能进行该操作,在会议中没有主席时才能申请。一旦有会场申请主席后,其他会场就不能再去申请。申请主席后,主席会场拥有较多的权限,比如:结束会议、广播会场、声控切换等。申请主席和释放主席两个操作是相对应的。

处理结果由消息MSG_APPLY_CHAIR_RSP上报。

URL

POST /action.cgi?ActionID=WEB_RequestChairAPI

请求参数结构

请求参数示例

成功响应结构

{

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

功能描述

确认会控密码时调用该接口。

应用场景

确认会控密码,如果密码正确,则返回成功失败响应,密码错误就返回失败响应。已不使用该接口,为保持兼容性,该接口功能与WEB_SendPswToMcuExAPI功能一致;

URL

POST /action.cgi?ActionID=WEB_SendConfCtrlPsdAPI

请求参数结构

{

"pwd": "1234"

}

pwd字段表示会议控制密码。

请求参数示例

{

"pwd": "1234"

}

成功响应结构

{

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

功能描述

查询会议信息(包含会场列表)。

应用场景

会场列表中包含入会和未入会会场。多用在窗口或界面初始化时。大部分会议控制操作是针对会场的,即需要下发会场参数,如:观看会场等,此类操作的前提是获取到当前的会场列表。

URL

POST /action.cgi?ActionID=WEB_InitSiteListDataAPI

请求参数结构

请求参数示例

成功响应结构

具体见会议列表结构

成功响应示例

{"success":1,

"data":"

{

\"joinSum\":2,

\"unJoinSum\":0,

\"confState\":\"freetalk\",

\"localMT\":{\"M\":1,\"T\":1},

\"isChair\":1,

\"seeingSite\":{\"M\":1,\"T\":2},

\"hasChair\":1,

\"permitChair\":1,

\"chairMT\":{\"M\":1,\"T\":1},

\"auxTokenMT\":{},

\"isSiteCall\":0,

\"isSupportRecord\":0,

\"recStatus\":0,

\"confLockState\":0,

\"brdSite\":{\"M\":0,\"T\":0},

\"mulPicMode\":33,

\"mutiPicCount\":0,

\"mutiPicStyle\":0,

\"mulPicCount\":255,

\"autoViewIntvl\":0,

\"autoBrdIntvl\":0,

\"confLeftTime\":110,

\"isInMinimcuConf\":0,

\"viewMultipicID\":0,

\"viewMultipicM\":0,

\"brdID\":0,

\"siteList\":[…],

\"siteInfo\":[],

\"voiceState\":0,

\"voiceType\":\"site\",

\"isAutoView\":0,

\"auxCapb\":1,

\"auxStatus\":\"idle\",

\"auxMT\":{\"M\":0,\"T\":0},

\"isSupportT140\":0,

\"isOpenT140\":1,

\"isUnderMCU\":0,

\"isPstnJoinConf\":0,

\"isReportMode\":0,

\"isCanReportMode\":0,

\"isDeprivationAux\":0,

\"ConfCtrlVersion\":3,

\"teleConfState\":0

}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

查看会场信息

接口名称

WEB_QuerySiteInfoAPI

功能描述

通过M/T查看某个会场的具体信息。

应用场景

会议中,MT号的组合可以作为会场唯一的标识。添加会场或者未入会会场入会后,常调用该接口,查询新增会场的详细信息,并根据具体应用场景做处理。

URL

POST /action.cgi?ActionID=WEB_QuerySiteInfoAPI

请求参数结构

{

"M": 1,

"T": 2

}

M表示会场M号,T表示会场T号。

请求参数示例

{

"M": 1,

"T": 2

}

成功响应结构

具体见8.6会议列表结构

成功响应示例

{"success":1,

"data":"

{\"siteInfo\":

{\"siteNum\":0,

\"joinConf\":1,

\"M\":1,

\"T\":2,

\"type\":\"H.323\",

\"isPSTN\":0,

\"isGetName\":1,

\"siteName\":\"075564228\",

\"isGetNumber\":0,

\"siteNumber\":\"\",

\"mute\":0,

\"silent\":0,

\"isReqTalk\":0,

\"isAutoView\":0,

\"isAutoBroad\":0,

\"autoViewSeq\":0,

\"autoBroadSeq\":0,

\"isChair\":0,

\"class\":0,

\"MT\":\"1-2\",

\"isView\":0,

\"isBroad\":0,

\"siteType\":\"site\",

\"screenNum\":0,

\"remotemicstates\":0

},

\"siteStatus\":{}

}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

获取会议信息

接口名称

WEB_QueryConfInfo

功能描述

获取当前会议信息。

应用场景

多点会议中,调用该接口可以获取当前会议的信息,包括:入会会场数目,未入会数目,会议状态,本端MT号,本端是否主席,本端正在观看的会场,会议中是否存在主席,会议中是否禁止或允许主席,主席会场的MT号,演示令牌所有者MT号,本端是否是主叫呼集方,是否支持录播,正在被广播的会场MT号,多画面模式,子画面个数,多画面样式,多画面组数,循环观看间隔,循环广播间隔,会议剩余时间,是否加入MiniMCU会议,观看的多组多画面的ID,观看的多组多画面的M号,正在被广播的多组多画面ID,会场列表,会场状态列表,声控切换状态,声控切换类别,循环观看状态,演示能力,本地持有令牌,发送演示的会场的MT号,是否支持T140,是否开启T140,是否在大MCU下,PSTN是否加入会议,是否汇报模式,是否支持汇报模式。

URL

POST /action.cgi?ActionID= WEB_QueryConfInfo

请求参数结构

请求参数示例

成功响应结构

见结构体WEB_CONF_INFO

成功响应示例

{"success":1,

"data":"

{\"joinSum\":2,

\"unJoinSum\":0,

\"confState\":\"\",

\"localMT\":{\"M\":1,\"T\":1},

\"isChair\":1,

\"seeingSite\":{\"M\":1,\"T\":2},

\"hasChair\":1,

\"permitChair\":1,

\"chairMT\":{\"M\":1,\"T\":1},

\"auxTokenMT\":{\"M\":0,\"T\":0},

\"isSiteCall\":0,

\"isSupportRecord\":0,

\"recStatus\":0,

\"confLockState\":0,

\"brdSite\":{\"M\":0,\"T\":0},

\"mulPicMode\":33,

\"mutiPicCount\":0,

\"mutiPicStyle\":0,

\"mulPicCount\":255,

\"autoViewIntvl\":0,

\"autoBrdIntvl\":0,

\"confLeftTime\":92,

\"isInMinimcuConf\":0,

\"viewMultipicID\":0,

\"viewMultipicM\":0,

\"brdID\":0,

\"siteList\":[],

\"siteInfo\":[],

\"voiceState\":0,

\"voiceType\":\"\",

\"isAutoView\":0,

\"auxCapb\":0,

\"auxStatus\":\"\",

\"auxMT\":{},

\"isSupportT140\":0,

\"isOpenT140\":0,

\"isUnderMCU\":0,

\"isPstnJoinConf\":0,

\"isReportMode\":0,

\"isCanReportMode\":0,

\"isDeprivationAux\":0,

\"ConfCtrlVersion\":3,

\"teleConfState\":0

}"

}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666955,"code":50343937,"params":[]}}

发送鉴权会议密码

接口名称

WEB_SendAuthConfPswdAPI

功能描述

发送鉴权会议密码时调用该接口。

应用场景

发送鉴权会议密码。

URL

POST /action.cgi?ActionID=WEB_SendAuthConfPswdAPI

请求参数结构

{

"Password": "1234"

}

Password表示鉴权密码字符串。

请求参数示例

{

"Password": "1234"

}

成功响应结构

{

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

功能描述

验证申请主席的密码,密码为6位数字。

应用场景

多点会议中,会场发送验证申请主席的密码,如果密码不正确,会提示用户重新输入,如果验证通过,则会场申请主席成功。已不使用该接口,为保持兼容性,该接口功能与WEB_SendPswToMcuExAPI功能一致;

URL

POST /action.cgi?ActionID=WEB_StartVerifyPswAPI

请求参数结构

{

"pwd": "123"

}

pwd表示申请主席的密码。

请求参数示例

{"pwd": "123456" }

成功响应结构

{

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

功能描述

获取会议演示令牌状态;

应用场景

多点会议中,终端调用该接口获取会议演示令牌状态。

URL

POST /action.cgi?ActionID=WEB_GetTokenStatus

请求参数结构

请求参数示例

成功响应结构

{"success":1,"data":"{\"tokenStatus\":\"initToken\"}"}

成功响应示例

{"success":1,"data":"{\"tokenStatus\":\"initToken\"}"}

失败响应结构

{

"success": 0,

"error":{

"id": XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

发送会议控制密码到网络侧进行校验

接口名称

WEB_SendPswToMcuExAPI

功能描述

将输入的会议控制密码发送到网络侧进行校验;

应用场景

多点会议中,发送申请主席API后,如果会议中有密码,需要验证,则会收到"MSG_CONFCTRL_PWD_INPUT_CMD"消息后,需要输入密码,通过WEB_SendPswToMcuExAPI接口就可以将输入的密码发送到网络侧进行校验。

URL

POST /action.cgi?ActionID=WEB_SendPswToMcuExAPI

请求参数结构

{"confPsw":"123"}

请求参数示例

同上

成功响应结构

{"success":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_ConfDeleteSiteAPI

功能描述

删除会场。

应用场景

只有主席才能进行该操作。从会场列表中选择一个会场删除。

删除某个会场后,可以通过添加会场方法将该会场加入到会议中,但是主席会场不能删除自己。

处理结果由消息MSG_DEL_SITE_RSP上报。

URL

POST/action.cgi?ActionID=WEB_ViewSiteAPI

请求参数结构

{

"M": 1,

"T": 2

}

M表示会场M号,T表示会场T号。

请求参数示例

{

"M": 1,

"T": 2

}

成功响应结构

{

"success":1,

"data":""

}

“success”字段表示响应结果,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_QueryDirectBroadStateAPI

功能描述

查询录播和直播的状态时调用该接口。

应用场景

只有主席才允许进行该操作,查询单点录播(该模式不需要主席权限)或当前会议中录播和直播的状态(即:是否开始了录播、是否开始了直播)。

URL

POST/action.cgi?ActionID=WEB_QueryDirectBroadStateAPI

请求参数结构

请求参数示例

成功响应结构

{

"success":1,

"data":"

{

\"ulDirectBroad\":0,

\"ulRecordBroad\":0,

\"ulIsRecServerOnline\":0

}"

}

success表示响应结果,1表示成功;ulDirectBroad表示当前直播状态;ulRecordBroad表示录播状态;0表示没有启动,1表示会议录制中,2表示单点录播暂停中,3表示单点录播录制中;

ulIsRecServerOnline录播服务器是否在线 0表示在线,1表示离线。

成功响应示例

{

"success":1,

"data":"

{

\"ulDirectBroad\":0,

\"ulRecordBroad\":0,

\"ulIsRecServerOnline\":0

}"

}

失败响应结构

{

"success":0,

"error":{

"id":XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

查询当前会议是否支持录播和直播(暂不支持直播)

接口名称

WEB_IsSupportReocrdAPI

功能描述

查询当前会议是否支持录播、是否支持直播。

应用场景

只有主席才允许进行该操作。只有支持录播(直播),才能启动录播或停止录播(启动直播或停止直播)。启动录播、停止录播的接口是WEB_RecordBroadAPI,启动直播、停止直播的接口是WEB_DirectBroadAPI,这两个接口在下文中会提到。

URL

POST/action.cgi?ActionID=WEB_IsSupportReocrdAPI

请求参数结构

请求参数示例

成功响应结构

{

success: 1,

data: {

isSupportRecord: 1,

isSupportLive: 0

}

}

success表示响应结果,1表示成功;isSupportRecord字段表示是否支持录播,isSupportLive表示是否支持直播,1是支持,0是不支持。

成功响应示例

{

success: 1,

data: {

isSupportRecord: 1,

isSupportLive: 0

}

}

失败响应结构

{

"success":0,

"error":{

"id":XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

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

启动或停止录播

接口名称

WEB_RecordBroadAPI

功能描述

启动或停止录播。

应用场景

只有主席可以进行该操作,并且前提是多点会议支持录播。查询会议中是否支持录播的接口是WEB_IsSupportRecordAPI。启动或停止录播操作结果,是通过

MSG_RECORD_BROADCAST_STATUS_CHANGE消息上报的。

URL

POST/action.cgi?ActionID=WEB_RecordBroadAPI

请求参数结构

{

"action":"startRecord"

}

action表示操作,"startRecord"表示启动录播"stopRecord"表示停止录播。

请求参数示例

{"action":"startRecord"}

成功响应结构

{

"success":1,

"data":""

}

"success"字段表示响应结果,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_RecordActionAPI

功能描述

对单点录播实现启动,暂停,停止操作

应用场景

在正确配置了录播服务器(recSerAddr)的前提下进行单点录播操作。当前单点录播状态可通过WEB_QueryDirectBroadStateAPI查询。

URL

POST/action.cgi?ActionID=WEB_RecordActionAPI

请求参数结构

{

"action":"startRecord"

}

action表示操作,"startRecord"表示启动录播"stopRecord"表示停止录播,continueRecord表示继续录播,pauseRecord表示暂停录播。

请求参数示例

{"action":"startRecord"}

成功响应结构

{

"success":1,

"data":""

}

"success"字段表示响应结果,1表示成功。"data"字段表示响应数据,允许为空。

成功响应示例

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

失败响应结构

{

"success":0,

"error":{

"id":XXXXXX,

"code":YYYYYY,

"params":[]

}

}

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

失败响应示例

{"success":0,"error":{"id":100666766,"code":134250502,"params":[]}}

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

文档编号:EDOC1100044503

浏览量:4798

下载量:63

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