1. 订阅事件
请求方法
POST
请求地址
/v2/dm/subscribe
Body参数
参数
数据类型
是否必需
描述
topic
String
是
事件类型,可选ALARM、ALARM_RECOVERY
channel
String
否
webhook通道ID,会将其拼接在webhook地址后当做uri的部分
endTime
Long
否
订阅截止时间,单位为毫秒的时间戳
HTTP状态码
返回值
描述
200
操作成功,详见响应参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
id
String
订阅ID
topic
String
事件类型
channel
String
webhook通道ID,会将其拼接在webhook地址后当做uri的部分
endTime
Long
订阅截止时间戳
请求消息示例
POST /v2/dm/subscribe HTTP/1.1
Host: api.ydmp.yealink.com
{
"channel": "event/subscribe",
"topic": "ALARM",
"endTime": 1727452800000
}
响应消息示例
POST /v2/dm/subscribe HTTP/1.1
Host: api.ydmp.yealink.com
{
"channel": "event/subscribe",
"topic": "ALARM",
"endTime": 1727452800000
}
2. 取消订阅
请求方法
POST
请求地址
/v2/dm/unSubscribe
Body参数
参数
数据类型
是否必需
描述
ids
String[]
是
订阅ID数组
HTTP状态码
返回值
描述
200
操作成功,详见响应参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
无
请求消息示例
POST /v2/dm/unSubscribe HTTP/1.1
Host: api.ydmp.yealink.com
{
"ids": [
"67039bd6859e4c4d83da659995fae415",
"8cf994c216a24469bcd5d92422aaa839"
]
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
3. 订阅列表
请求方法
POST
请求地址
/v2/dm/listSubscribes
Body参数
参数
数据类型
是否必需
描述
skip
Long
否
跳过的记录数,默认为0
limit
Long
否
获取的最大记录数,默认为10,最大500
autoCount
Boolean
否
是否要响应总数量,建议在第一页查询时为true,后续翻页时传false
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
skip
Long
偏移量
limit
Long
返回最大数量
total
Long
总数量
data
SubscribeInfo[]
SubscribeInfo信息数组
SubscribeInfo对象定义
参数
数据类型
描述
id
String
订阅ID
topic
String
事件类型
channel
String
webhook通道ID,会将其拼接在webhook地址后当做uri的部分
endTime
Long
订阅截止时间戳
请求消息示例
POST /v2/dm/listSubscribes HTTP/1.1
Host: api.ydmp.yealink.com
{
"skip": 0,
"limit": 10,
"autoCount": true
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"skip": 0,
"limit": 10,
"total": 1,
"data": [
{
"id": "5e81546c38f545bfa11be4e86b0adfe0",
"topic": "ALARM",
"channel": "event/subscribe",
"endTime": 1727452800000,
"createTime": 1725240191738,
"modifyTime": 1725240191738
}
]
}
4. 查询订阅详情
请求方法
GET
请求地址
/v2/dm/subscribes/{subscribeId}
Path参数
参数
数据类型
是否必需
描述
subscribeId
String
是
订阅ID
HTTP状态码
返回值
描述
200
操作成功,详见响应参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
id
String
订阅ID
topic
String
事件类型
channel
String
webhook通道ID,会将其拼接在webhook地址后当做uri的部分
endTime
Long
订阅截止时间戳
请求消息示例
GET /v2/dm/subscribes/0e7ca0a3f9f540fb999afe54c345a675 HTTP/1.1
Host: api.ydmp.yealink.com
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "5e81546c38f545bfa11be4e86b0adfe0",
"topic": "ALARM",
"channel": "event/subscribe",
"endTime": 1727452800000,
"createTime": 1725240191738,
"modifyTime": 1725240191738
}