更新时间:2022-08-25 GMT+08:00
分享

订阅邮箱消息数据

接口名称

WEB_SubscribeMsgAPI

功能描述

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

应用场景

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

URL

https://ip/action.cgi?ActionID=WEB_SubscribeMsgAPI

参数

表1 订阅邮箱消息数据参数

参数

类型

取值范围

参数说明

aszMsgIDs

Array

-

订阅消息的数组

MSG_CALL_RSP

MSG_DISCONNECT_CALL

MSG_RMCC_TEXT_INFO_IND

MSG_GK_TEXT_INFO_IND等

返回值

表2 订阅邮箱消息数据返回值

参数

类型

取值范围

参数说明

success

int

[0, 1]

响应结果

0:失败

1:成功

data

Object

可选, 空对象

成功返回数据。这里返回空。

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

error

Object

可选

失败返回错误信息。详细参考表3

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

表3 error

参数

类型

取值范围

参数说明

id

int

32位整数

错误id,用于转换。

code

int

32位整数

错误码,跟错误id对应,具体含义参考错误码

param

Object

param 对象

失败响应的附带参数。

相关文档