1. 设备配置管理 1.1 设备配置列表 请求方法 POST 请求地址 /v2/dm/listDeviceConfigs Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要返回记录总数据量 filter Filter 否 搜索参数 Filter对象定义 参数 数据类型 是否必需 描述 mac String 否 设备MAC,最大长度17,支持带:或-,如00:15:65:bb:b1:a9 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数据量 data Config[] Config信息数组 Config对象定义 参数 数据类型 描述 id String 主键id name String 配置名称 modelId String 型号ID description String 配置描述 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/listDeviceConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "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": "8d07a56207074d26b61026099625b9e2", "name":"my config", "modelId":"SIP-T54S", "description":"my t54s config" }] } 1.2 添加设备配置 请求方法 POST 请求地址 /v2/dm/deviceConfigs Body参数 参数 数据类型 是否必需 描述 deviceId String 是 设备ID content String 是 cfg文件内容 HTTP状态码 返回值 描述 201 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 设备配置id 请求消息示例 POST /v2/dm/deviceConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "deviceId": "8d07a56207074d26b61026099625b9e2", "content": "lang.wui=English\nlang.gui=English" } 响应消息示例 HTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8 ​ { "id": "d916a46b4557464c87c278cb37477bef" } 1.3 删除设备配置 请求方法 POST 请求地址 /v2/dm/delDeviceConfigs Body参数 参数 数据类型 是否必需 描述 configIds String[] 是 设备配置ID列表，最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/delDeviceConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "configIds":["e33b8f25247e45de84dd4c74503b241a","8d07a56207074d26b61026099625b9e2"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"e33b8f25247e45de84dd4c74503b241a", "msg":"The resource does not exist or has been deleted" }] } 1.4 设备配置详情 请求方法 GET 请求地址 /v2/dm/deviceConfigs/{configId} Path参数 参数 数据类型 是否必需 描述 configId String 是 设备配置id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 设备配置id name String 配置名称 modelId String 型号ID content String 配置内容 description String 配置描述 请求消息示例 GET /v2/dm/deviceConfigs/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "id": "8d07a56207074d26b61026099625b9e2", "name":"my config", "modelId":"SIP-T54S", "content":"#!version:1.0.0.1\naccount.1.codec.g722.enable=1" "description":"my t54s config" } 1.5 推送设备配置 请求方法 POST 请求地址 /v2/dm/deviceConfigs/{configId}/push Path参数 参数 数据类型 是否必需 描述 configId String 是 配置ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/deviceConfigs/e33b8f25247e45de84dd4c74503b241a/push HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 2. 分站点配置管理 2.1 添加分站点配置 请求方法 POST 请求地址 /v2/dm/siteConfigs Body参数 参数 数据类型 是否必需 描述 name String 是 分站点配置名称,长度64 siteId String 是 站点ID deviceType Integer 是 设备类型 1: Phone Device modelId String 否 型号ID,不填写时表示全部型号 content String 否 配置文件内容 description String 否 描述，长度256 HTTP状态码 返回值 描述 201 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 设备配置id 请求消息示例 POST /v2/dm/siteConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name": "site1 config", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"MP56(Teams)", "content": "lang.wui=English\nlang.gui=English", "description":"test" } 响应消息示例 HTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8 ​ { "id": "8b7f1739ad6d4a578267d09b53a262a3" } 2.2编辑分站点配置 请求方法 PATCH 请求地址 /v2/dm/siteConfigs/{configId} Path参数 参数 数据类型 是否必需 描述 configId String 是 分站点配置ID Body参数 参数 数据类型 是否必需 描述 name String 是 分站点配置名称,长度64 siteId String 是 站点ID deviceType Integer 是 设备类型 1: Phone Device content String 否 配置文件内容 description String 否 描述，长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 PATCH /v2/dm/siteConfigs/8b7f1739ad6d4a578267d09b53a262a3 HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "content": "lang.wui=English\nlang.gui=English", "description":"test2" } 响应消息示例 HTTP/1.1 200 2.3 删除分站点配置 请求方法 POST 请求地址 /v2/dm/delSiteConfigs Body参数 参数 数据类型 是否必需 描述 configIds String[] 是 分站点配置ID列表，最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/delSiteConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "configIds":["8b7f1739ad6d4a578267d09b53a262a3","e33b8f25247e45de84dd4c74503b241a"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"e33b8f25247e45de84dd4c74503b241a", "msg":"The resource does not exist or has been deleted" }] } 2.4 分站点配置详情 请求方法 GET 请求地址 /v2/dm/siteConfigs/{configId} Path参数 参数 数据类型 是否必需 描述 configId String 是 分站点配置id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 分站点配置ID name String 分站点配置名称,长度64 siteId String 站点ID deviceType Integer 设备类型 1: Phone Device modelId String 型号ID content String 配置文件内容 description String 描述，长度256 请求消息示例 GET /v2/dm/siteConfigs/8b7f1739ad6d4a578267d09b53a262a3 HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "id": "8b7f1739ad6d4a578267d09b53a262a3", "name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"MP56(Teams)", "content": "lang.wui=English\nlang.gui=English", "description":"test2" } 2.5 分站点配置列表 请求方法 POST 请求地址 /v2/dm/listSiteConfigs Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要返回记录总数据量 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数据量 data Config[] Config信息数组 Config定义 参数 数据类型 描述 id String 分站点配置ID name String 分站点配置名称,长度64 siteId String 站点ID deviceType Integer 设备类型 1: Phone Device modelId String 型号ID description String 描述，长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/listSiteConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "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": "8b7f1739ad6d4a578267d09b53a262a3", "name": "site1 config2", "siteId":"048a97f00ece46bd8d8bf97f5002992a", "deviceType":1, "modelId":"MP56(Teams)", "description":"test2" }] } 2.6 推送分站点配置 请求方法 POST 请求地址 /v2/dm/siteConfigs/{configId}/push Path参数 参数 数据类型 是否必需 描述 configId String 是 配置ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/siteConfigs/8b7f1739ad6d4a578267d09b53a262a3/push HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 3. 分组配置管理 3.1 添加分组配置 请求方法 POST 请求地址 /v2/dm/groupConfigs Body参数 参数 数据类型 是否必需 描述 name String 是 分组配置名称,长度64 deviceGroupId String 是 设备分组ID deviceType Integer 是 设备类型 1: Phone Device 3: Room Device modelId String 否 型号ID,不填写时表示全部型号 content String 否 配置文件内容 description String 否 描述，长度256 响应参数 参数 数据类型 描述 id String 分组配置id HTTP状态码 返回值 描述 201 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/groupConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name": "group config", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"MP56(Teams)", "content": "lang.wui=English\nlang.gui=English", "description":"test" } 响应消息示例 HTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8 ​ { "id": "8faa39e34929425f85b4cd9925a2bbcb" } 3.2 编辑分组配置 请求方法 PATCH 请求地址 /v2/dm/groupConfigs/{configId} Path参数 参数 数据类型 是否必需 描述 configId String 是 分组配置ID Body参数 参数 数据类型 是否必需 描述 name String 是 分组配置名称,长度64 deviceGroupId String 是 设备分组ID deviceType Integer 是 设备类型 1: Phone Device 3: Room Device modelId String 否 型号ID,不填写时表示全部型号 content String 否 配置文件内容 description String 否 描述，长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 PATCH /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"MP56(Teams)", "content": "lang.wui=English\nlang.gui=English", "description":"test2" } 响应消息示例 HTTP/1.1 200 3.3 删除分组配置 请求方法 POST 请求地址 /v2/dm/delGroupConfigs Body参数 参数 数据类型 是否必需 描述 configIds String[] 是 分组配置ID列表，最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 DELETE /v2/dm/delGroupConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "configIds":["8faa39e34929425f85b4cd9925a2bbcb","e33b8f25247e45de84dd4c74503b241a"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"e33b8f25247e45de84dd4c74503b241a", "msg":"The resource does not exist or has been deleted" }] } 3.4 分组配置详情 请求方法 GET 请求地址 /v2/dm/groupConfigs/{configId} Path参数 参数 数据类型 是否必需 描述 configId String 是 分组配置id 响应参数 参数 数据类型 描述 id String 分组配置ID name String 分组配置名称,长度64 deviceGroupId String 分组ID deviceType Integer 设备类型 1: Phone Device modelId String 型号ID content String 配置文件内容 description String 描述，长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 GET /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "id": "8faa39e34929425f85b4cd9925a2bbcb", "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"MP56(Teams)", "content": "lang.wui=English\nlang.gui=English", "description":"test2" } 3.5 分组配置列表 请求方法 POST 请求地址 /v2/dm/listGroupConfigs Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要返回记录总数据量 deviceType Integer 是 设备类型 1: Phone Device 3: Room Device 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数据量 data Config[] Config信息数组 Config定义 参数 数据类型 描述 id String 分组配置ID name String 分组配置名称,长度64 deviceGroupId String 分组ID deviceType Integer 设备类型 1: Phone Device modelId String 型号ID description String 描述，长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/listGroupConfigs HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "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": "8faa39e34929425f85b4cd9925a2bbcb", "name": "group config2", "deviceGroupId":"1185861ed00840ea99a7b07aa0f28f88", "deviceType":1, "modelId":"MP56(Teams)", "description":"test2" }] } 3.6 推送分组配置 请求方法 POST 请求地址 /v2/dm/groupConfigs/{configId}/push Path参数 参数 数据类型 是否必需 描述 configId String 是 配置ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 POST /v2/dm/groupConfigs/8faa39e34929425f85b4cd9925a2bbcb/push HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200