请求邮箱数据
接口名称
WEB_GetMailboxDataAPI
功能描述
Web前台向后台请求邮箱数据时调用该接口,包括常用的状态数据和消息数据。
应用场景
该接口用于请求消息数据,同时用于维持客户端和服务端之间的常连接。客户端向服务端发送该请求的时间间隔必须小于60秒。
URL
https://ip/action.cgi?ActionID=WEB_GetMailboxDataAPI
参数
无
返回值
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
success | int | [0, 1] | 响应结果 0:失败 1:成功 |
data | Object | 可选 | 成功返回数据。详细参考表2。 例如: {"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,\"bluetooth\":0,\"upgradeProc\":5640,\"shownew\":7,\"confNetType\":0,\"auditsite\":0,\"streamType\":0},\"msgStruct\":\"{\\\"iResult\\\":0,\\\"msg\\\":[\\\"{\\\\\\\"msgID\\\\\\\":4500,\\\\\\\"msgName\\\\\\\":\\\\\\\"MSG_SAVEBOOK_ADDR\\\\\\\",\\\\\\\"subMsgID\\\\\\\":31744,\\\\\\\"param1\\\\\\\":0,\\\\\\\"param2\\\\\\\":0,\\\\\\\"msgData\\\\\\\":\\\\\\\"\\\\\\\",\\\\\\\"sessionID\\\\\\\":\\\\\\\"\\\\\\\"}\\\"]}\"}"} |
error | Object | 可选 | 失败返回错误信息。详细参考表5。 例如:{"success":0,"error":"id":100666995,"code":33558532,"params":[]}} |
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
sitename | string | 可为空 | 会场名字 |
speaker | int | [0, 1] | 喇叭 0:关 1:开 |
mic | int | [0, 1] | 麦克风 0:关 1:开 |
gk | int | [0, 1] | 注册GK 0:失败 1:成功 |
sip | int | [0, 1] | 注册SIP 0:失败 1:成功 |
upgrade | int | [0, 1] | 升级状态 0:空闲中 1:升级中 |
callstate | int | [0, 2] | 呼叫状态 0:无呼叫 1:正在呼出 2:呼叫已经连接 |
calltype | int | [0, 10] | 呼叫线路类型 0:ISDN呼叫 1:V35呼叫 2:E1呼叫 3:H.323呼叫 4:电话(纯音频) 5:PSTN(窄带) 6:T1呼叫 7:4E1呼叫 8:SIP呼叫 9:SIP Phone呼叫 10:auto自动切换呼叫类型 |
conftype | int | [0, 4] | 会议类型 0:无呼叫 1:点对点呼叫 2:在远端多点会议 3:在本地多点会议 4:在级联会议中 |
confstate | int | [0, 7] | 会议状态 0:空闲 1:呼叫操作 2:接听呼叫 3:拒绝呼叫 4:主叫呼集 5:预约呼叫 6:查询预约 7:删除预约 |
sitecall | int | [0, 1] | 本端是否主叫呼集发起方 0:非本端发起 1:本端发起 |
chair | int | [0, 1] | 本端是否主席 0:非主席 1:主席 |
miniMcu | int | [0, 1] | 是否支持内置MCU 0:不支持 1:支持 |
isInConf | int | [0, 1] | 本端是否入会 0:本端未入会 1:本端已入会 |
pstnstate | int | [0, 5] | PSTN状态 1:未插卡 2:已插卡 3:已插卡已接线/挂机 4:已插卡已接线/振铃 5:已插卡已接线/摘机 |
t140cap | int | [0, 2] | T.140能力状态 0:无T.140能力 1:有T.140能力 2:非T.140 |
isHwGk | int | [0, 1] | 是否启用增强GK 0:禁用 1:启用 |
h239cap | int | [0, 1] | h239能力 0:未使用 1:使用 |
tv_H239_hd2 | int | [0, 1] | 是否启用双屏 0:未启用 1:启用 |
useminimcu | int | [0, 1] | 当前是否启用minimcu 0:未启用 1:启用 |
wifi | int | [0, 2] | Wifi状态 0:WIFI没有启用 1:WIFI启用,但是未连接 2:WIFI启用并连接上 |
RemoteMicStates | int | [0, 1] | 远端麦克风 0:关 1:开 |
cfgonebit | int | 32位整数 | 状态位1表示当前启用,0表示未启用或不支持。 bit 0: ldap bit 1: espace bit 2: mic1 bit 3: mic2 bit 4: line 1 bit 5: line 2 |
statebit | int | 32位整数 | 状态标识 |
speakerValue | int | 16位整数 | 喇叭音量 |
micValue | int | 16位整数 | 麦克风音量 |
statebit2 | int | 32位整数 | 拼接字段组合 |
bluetooth | int | [0, 1] | 是否支持蓝牙 0:不支持 1:支持 |
upgradeProc | int | 32位整数 | 升级进度 |
confNetType | int | [0, 1] | 终端呼叫状态 |
auditsite | int | [0, 1] | 旁听会场的媒体方向 |
streamType | int | [0, 2] | 0:传统会议 1:协作会议 2:多流会议 |
isSupportAI | int | [0, 1] | 是否支持AI 0:不支持 1:支持 |
curStatusCP | int | [0, 1] | 是否支持协作 0:不支持 1:支持 |
shareType | int | [0, 1] | - |
dontDisturb | int | [0, 1] | - |
camStateInConf | int | [0, 1] | - |
webExpiredTime | int | 32位整数 | - |
imageSwitch | int | [0, 1] | - |
参数 | 类型 | 取值范围 | 参数说明 |
|---|---|---|---|
id | int | 32位整数 | 错误id,用于转换。 |
code | int | 32位整数 | 错误码,跟错误id对应,具体含义参考错误码。 |
param | Object | param对象 | 失败响应的附带参数。 |

