1. 固件管理
1.1 固件列表
请求方法
POST
请求地址
/v2/dm/listFirmwares
Body参数
参数
数据类型
是否必需
描述
skip
Long
否
跳过的记录数,默认为0
limit
Long
否
获取的最大记录数,默认为10,最大500
autoCount
Boolean
否
是否要响应总数量,建议在第一页查询时为true,后续翻页时传false
filter
Filter
否
搜索参数
Filter对象定义
参数
数据类型
是否必需
描述
modelId
String
否
固件型号ID
firmwareType
Integer
否
固件类型 0:主设备 1:配件
deviceType
Integer
否
设备类型 1: Phone Device
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
skip
Long
偏移量
limit
Long
返回最大数量
total
Long
总数量
data
Firmware[]
Firmware信息数组
Firmware对象定义
参数
数据类型
描述
id
String
固件id
name
String
固件名称
deviceType
Integer
设备类型 1: Phone Device
firmwareType
Integer
固件类型 0:主设备 1:配件
version
String
固件版本号
请求消息示例
POST /v2/dm/listFirmwares HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 10,
"autoCount": true,
"filter":{
"firmwareType":0,
"deviceType":1
}
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"skip": 0,
"limit": 10,
"total": 1,
"data":[{
"id": "01d7ae1897f7418dad2d26609329be38",
"name":"t54s firmware",
"deviceType":1,
"firmwareType":0,
"version":"108.85.3.19",
}]
}
1.2 固件详情
请求方法
GET
请求地址
/v2/dm/firmwares/{firmwareId}
Path参数
参数
数据类型
是否必需
描述
firmwareId
String
是
固件ID
HTTP状态码
返回值
描述
200
操作成功,详见响应参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
id
String
固件id
name
String
固件名称
filename
String
固件文件名称
deviceType
Integer
设备类型 1: Phone Device
firmwareType
Integer
固件类型 0:主设备 1:配件
downloadUrl
String
下载地址
version
String
固件版本号
supportModels
String[]
支持的型号列表
siteId
String
所属站点ID
description
String
固件描述
请求消息示例
GET /v2/dm/firmwares/01d7ae1897f7418dad2d26609329be38 HTTP/1.1
Host: api.ydmp.yealink.com
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "01d7ae1897f7418dad2d26609329be38",
"name":"t54s firmware",
"filename":"t54s.rom",
"deviceType":1,
"firmwareType":0,
"downloadUrl":"https://resources.yiot.yealink.com/yiot-manager/api/v1/terminal/resource/download/69847884d3be4327b86bffd0513c4572/1/T46S(T48S,T42S,T41S)-66.86.0.15.rom",
"version":"108.85.3.19",
"supportModels":["SIP-T54S"],
"siteId":"ee06cddee78948a298fc12565a35cdbe"
}
1.3 官方固件列表
请求方法
POST
请求地址
/v2/dm/listOfficalFirmwares
Body参数
参数
数据类型
是否必需
描述
skip
Long
否
跳过的记录数,默认为0
limit
Long
否
获取的最大记录数,默认为10,最大500
autoCount
Boolean
否
是否要响应总数量,建议在第一页查询时为true,后续翻页时传false
filter
Filter
是
搜索参数
Filter对象定义
参数
数据类型
是否必需
描述
modelId
String
是
固件型号ID
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
skip
Long
偏移量
limit
Long
返回最大数量
total
Long
总数量
data
Firmware[]
Firmware信息数组
Firmware对象定义
参数
数据类型
描述
id
String
固件id
name
String
固件名称
version
String
固件版本号
请求消息示例
POST /v2/dm/listOfficalFirmwares HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"skip": 0,
"limit": 10,
"autoCount": true,
"filter":{
"modelId":"BH76"
}
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"skip": 0,
"limit": 10,
"total": 1,
"data":[{
"id": "01d7ae1897f7418dad2d26609329be38",
"name":"t54s firmware",
"version":"108.85.3.19"
}]
}
1.4 推送固件
请求方法
POST
请求地址
/v2/dm/firmwares/{firmwareId}/push
PATH参数
参数
数据类型
是否必需
描述
firmwareId
String
是
固件ID
Body参数
参数
数据类型
是否必需
描述
deviceIds
String[]
是
设备ID列表,最大长度200
deviceType
Integer
是
设备类型 1: Phone Device
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
total
Integer
推送总数量
successCount
Integer
成功总数量
failureCount
Integer
失败总数量
errors
OpError[]
错误信息
OpError对象
参数
数据类型
描述
field
String
错误字段
msg
String
错误信息
请求消息示例
POST /v2/dm/firmwares/09972370b360461d868e3e02f9cdec77/push HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"deviceIds":["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"],
"deviceType":1
}
响应消息示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"total": 2,
"successCount":1,
"failureCount":1,
"errors":[{
"field":"00099642675e4d4bb5e91fd9ae5ce585",
"msg":"The resource does not exist or has been deleted"
}]
}
1.5 推送官方固件
请求方法
POST
请求地址
/v2/dm/officalFirmwares/{officalFirmwareId}/push
PATH参数
参数
数据类型
是否必需
描述
officalFirmwareId
String
是
官方固件ID
Body参数
参数
数据类型
是否必需
描述
deviceIds
String[]
是
设备ID列表,最大长度200
deviceType
Integer
是
设备类型 1: Phone Device
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
total
Integer
推送总数量
successCount
Integer
成功总数量
failureCount
Integer
失败总数量
errors
OpError[]
错误信息
OpError对象
参数
数据类型
描述
field
String
错误字段
msg
String
错误信息
请求消息示例
POST /v2/dm/officalFirmwares/09972370b360461d868e3e02f9cdec77/push HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"deviceIds":["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"],
"deviceType":1
}
响应消息示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"total": 2,
"successCount":1,
"failureCount":1,
"errors":[{
"field":"00099642675e4d4bb5e91fd9ae5ce585",
"msg":"The resource does not exist or has been deleted"
}]
}