1. 设备基础信息管理 1.1 批量添加设备 说明 每次最多100条。 请求方法 POST 请求地址 /v2/dm/addDevices Body参数 参数 数据类型 是否必须 描述 mac String 是 设备MAC，最小长度12，最大长度17 sn String 是 SN码，最大长度128 deviceType Integer 是 设备类型 1: Phone Device 3: Room Device modelId String 是 型号ID name String 否 设备名称，最大长度128 siteId String 否 站点ID HTTP状态码 返回值 描述 200 操作成功。 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 批量添加总条数 successCount Integer 成功添加总数量 failureCount Integer 失败总数量 errors AddError[] 错误信息 AddError对象 参数 数据类型 描述 mac String 设备MAC sn String 设备SN errorInfo String 错误信息 请求消息示例 POST /v2/dm/addDevices HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ [{ "mac":"3a1565bbb1a9", "sn":"1106312113402006", "name":"my t54s", "modelId":"SIP-T54S", "deviceType":1 }] 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 1, "successCount":0, "failureCount":1, "errors":[{ "mac":"3a1565bbb1a9", "sn":"1106312113402006", "errorInfo":"device.mac.invalid" }] } 1.2 删除设备 请求方法 DELETE 请求地址 /v2/dm/devices/{deviceId} PATH参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 DELETE /v2/dm/devices/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 1.3 批量删除设备 请求方法 POST 请求地址 /v2/dm/delDevices Body参数 参数 数据类型 是否必需 描述 deviceType Integer 是 设备类型 1: Phone Device 3：Room Device deviceIdType String 否 表示设备标识的类型，默认id，可选mac、id deviceIds String[] 是 设备标识，最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/delDevices HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "deviceType":1, "deviceIds":["001565bbb1a9","001567"], "deviceIdType":"mac" } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"001567", "msg":"Invalid MAC" }] } 1.4 设备列表 请求方法 POST 请求地址 /v2/dm/listDevices Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大100 autoCount Boolean 否 是否要响应总数量，建议在第一页查询时为true,后续翻页时传false filter Filter 否 搜索参数 Filter对象定义 参数 数据类型 是否必需 描述 mac String 否 设备MAC模糊搜索关键字,最大长度17,支持带:或-,如00:15:65:bb:b1:a9 modelId String 否 型号ID deviceStatus Integer 否 设备状态，1:在线， 0:离线，-1:未上报 accountStatus Integer 否 账号状态, 1: 已注册 2:dnd 3: 未注册 deviceType Integer 否 设备类型状态, 1: Phone Device 3: Room Device ，不填写时为全部 siteId String 否 站点ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数量 data Device[] Device信息数组 Device对象定义 参数 数据类型 描述 id String 设备id mac String 设备MAC sn String 设备SN name String 设备名称 modelId String 型号ID siteId String 站点ID programVersion String 设备固件版本号 deviceStatus String 设备状态，online:在线， offline:离线，pending:未上报 请求消息示例 POST /v2/dm/listDevices HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "skip": 0, "limit": 20, "autoCount": true, "filter":{ "deviceStatus":1, "siteId":"a624453e1cbb44ecb9bb6ee31731a856" } } 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "8d07a56207074d26b61026099625b9e2", "mac":"001565bbb1a9", "sn":"1106312113402006", "name":"my t54s", "modelId":"SIP-T54S", "siteId":"a624453e1cbb44ecb9bb6ee31731a856", "programVersion":"70.83.0.68", "deviceStatus":"online" }] } 1.5 编辑设备 请求方法 PATCH 请求地址 /v2/dm/devices/{deviceId} Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备ID Body参数 参数 数据类型 是否必需 描述 name String 否 设备名称，最大长度128 siteId String 否 站点ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 PATCH /v2/dm/devices/8d07a56207074d26b61026099625b9e2 HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name":"my t54s2" } 响应消息示例 HTTP/1.1 200 1.6 设备详情 请求方法 GET 请求地址 /v2/dm/devices/{deviceId} Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 设备id mac String 设备MAC sn String 设备SN name String 设备名称 modelId String 型号ID modelName String 型号名称 siteId String 站点ID siteName String 站点名称 lanIp String 内网IP deviceStatus String 设备状态，online:在线， offline:离线，pending:未上报 programVersion String 固件版本 lastReportTime long 最后上报时间 accounts ReportAccount[] 上报的账号信息 ReportAccount对象定义 参数 数据类型 描述 accountId String 账号ID(平台随机生成，该字段不适用) lineId Integer 账号线路,从1开始 accountType Integer 账号类型: 0：SIP,1:H323 2:SFB accountServer String 账号服务器地址 registerName String 注册名称 username String 用户名称 status Integer 账号状态:1:已注册 2:dnd 3:未注册4:未知 请求消息示例 GET /v2/dm/devices/8d07a56207074d26b61026099625b9e2 HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "id": "8d07a56207074d26b61026099625b9e2", "mac":"001565bbb1a9", "sn":"1106312113402006", "name":"my t54s", "modelId":"SIP-T54S", "modelName":"SIP-T54S", "siteId":"a624453e1cbb44ecb9bb6ee31731a856", "siteName":"mysite", "lanIp":"10.50.198.6", "deviceStatus":"online", "programVersion":"70.83.0.68", "lastReportTime":1711093807136, "accounts":[{ "accountId":"604e67944c7c43fe8b66099254ec3439" "lineId":1, "accountType":0, "accountServer":"10.200.108.48", "registerName":"1000", "username":"1000", "status":0 },{ "accountId":"a45a6b4a7e0447b8a6c3f2839d902acd" "lineId":2, "accountType":0, "accountServer":"10.200.108.48", "registerName":"2000", "username":"2000", "status":0 }] } 1.7 设备组合配置查询 请求方法 GET 请求地址 /v2/dm/devices/{deviceId}/configs Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 deviceConfig String 设备MAC配置 siteConfig String 设备站点配置 globalConfig String 企业全局配置 enforceConfig String 站点强制继承配置 请求消息示例 GET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/configs HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "deviceConfig": "account.1.auth_name = test1101", "siteConfig":"lang.gui=English", "globalConfig":"auto_provision.server.url=\r\nlang.gui=English", "enforceConfig":"security.user_password=user2" } 2. 设备分组管理 2.1 添加分组 请求方法 POST 请求地址 /v2/dm/deviceGroups Body参数 参数 数据类型 是否必需 描述 name String 是 分组名称，长度64 deviceType Integer 是 设备类型 1: Phone Device 3: Room Device description String 否 分组描述信息,长度256 HTTP状态码 返回值 描述 201 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 分组id name String 分组名称 deviceType Integer 设备类型 description String 分组描述信息 请求消息示例 POST /v2/dm/deviceGroups HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name":"t54sgroup", "deviceType":1, "description":"test" } 响应消息示例 HTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8 ​ { "id": "00884cef841e48f4acd213c084e65f67", "name":"t54sgroup", "deviceType":1, "description":"test" } 2.2 编辑分组 请求方法 PATCH 请求地址 /v2/dm/deviceGroups/{deviceGroupId} Path参数 参数 数据类型 是否必需 描述 deviceGroupId String 是 设备分组ID Body参数 参数 数据类型 是否必需 描述 name String 是 分组名称，长度64 deviceType Integer 是 设备类型 1: Phone Device 3: Room Device description String 否 分组描述信息,长度256 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 PATCH /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "name":"t54sgroup2", "deviceType":1, "description":"test2" } 响应消息示例 HTTP/1.1 200 2.3 分组列表 请求方法 POST 请求地址 /v2/dm/listDeviceGroups Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要响应总数量，建议在第一页查询时为true,后续翻页时传false deviceType Integer 是 设备类型 1: Phone Device 3: Room Device HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数量 data DeviceGroup[] DeviceGroup信息数组 DeviceGroup对象定义 参数 数据类型 描述 id String 分组ID name String 分组名称，长度64 deviceType Integer 设备类型 1: Phone Device 3: Room Device description String 分组描述信息,长度256 请求消息示例 POST /v2/dm/listDeviceGroups 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": "00884cef841e48f4acd213c084e65f67", "name":"t54sgroup", "deviceType":1, "description":"test" }] } 2.4 删除分组 请求方法 DELETE 请求地址 /v2/dm/deviceGroups/{deviceGroupId} PATH参数 参数 数据类型 是否必需 描述 deviceGroupId String 是 设备分组id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 DELETE /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67 HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 2.5 添加设备到分组 请求方法 POST 请求地址 /v2/dm/deviceGroups/{deviceGroupId}/addDevices PATH参数 参数 数据类型 是否必需 描述 deviceGroupId String 是 设备分组id Body参数 参数 数据类型 是否必需 描述 deviceIds String[] 是 设备ID列表，限制200个 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 添加总条数 successCount Integer 成功总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67/addDevices HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "deviceIds":["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"] } 响应消息示例 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" }] } 2.6 从分组中删除设备 请求方法 POST 请求地址 /v2/dm/deviceGroups/{deviceGroupId}/delDevices PATH参数 参数 数据类型 是否必需 描述 deviceGroupId String 是 设备分组id Body参数 参数 数据类型 是否必需 描述 deviceIds String[] 是 设备ID列表,最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/deviceGroups/00884cef841e48f4acd213c084e65f67/delDevices HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "deviceIds":["0006572538f74e8683716cf961caa95b","00099642675e4d4bb5e91fd9ae5ce585"] } 响应消息示例 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" }] } 3. 设备控制 3.1 设备重启 请求方法 POST 请求地址 /v2/dm/device/reboot Body参数 参数 数据类型 是否必需 描述 deviceIds String[] 是 设备ID列表，最大长度200 deviceType Integer 是 设备类型 1: Phone Device 3:Room Device HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 重启总设备数 successCount Integer 重启成功数量 failureCount Integer 重启失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/device/reboot 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":"0006572538f74e8683716cf961caa95b", "msg":"The resource does not exist or has been deleted" }] } 3.2 设备恢复出厂 请求方法 POST 请求地址 /v2/dm/device/reset Body参数 参数 数据类型 是否必需 描述 deviceIds String[] 是 设备ID列表 deviceType Integer 是 设备类型 1: Phone Device 3:Room Device HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 恢复出厂总设备数 successCount Integer 恢复出厂成功数量 failureCount Integer 恢复出厂失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/device/reset 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":"0006572538f74e8683716cf961caa95b", "msg":"The resource does not exist or has been deleted" }] } 4. 设备标识管理 4.1 获取设备ID 请求方法 POST 请求地址 /v2/dm/deviceId Body参数 参数 数据类型 是否必需 描述 deviceType Integer 是 设备类型 1: Phone Device 3:Room Device deviceIdType String 否 表示设备标识的类型，默认mac，可选mac deviceIds String[] 是 设备标识,限制200个 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 key String 设备标识 deviceId String 设备ID 请求消息示例 POST /v2/dm/deviceId HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "deviceType":1, "deviceIds":["001565bbb1a9"], "deviceIdType":"mac" } 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ [{ "key":"001565bbb1a9", "deviceId":"8d07a56207074d26b61026099625b9e2" }] 5. 设备配件管理 5.1 配件列表 请求方法 POST 请求地址 /v2/dm/devices/{deviceId}/listParts Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备ID Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要响应总数量，建议在第一页查询时为true,后续翻页时传false HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 配件id mac String 配件MAC sn String 配件SN modelId String 型号ID connectWay String 配件连接方式，包括USB,BT等 connStatus Integer 状态，1:在线， 0:离线 lanIp String 内网IP programVersion String 固件版本号 lastReportTime Long 最后上报时间 请求消息示例 POST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/listParts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "skip": 0, "limit": 20, "autoCount": true } ​ 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 { "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "5d6017f6fe004eb7ac1107c80c1c44b7", "mac":"001565bbb1a9", "sn":"1106312113402006", "modelId":"CP700", "modelName": "CP700", "connectWay":"USB", "connStatus":1, "lanIp":"10.60.50.22", "programVersion":"153.433.0.5", "lastReportTime":1709577211630 }] } 5.2 配件详情 请求方法 GET 请求地址 /v2/dm/devices/{deviceId}/parts/{partId} Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备ID partId String 是 配件ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 配件id mac String 配件MAC sn String 配件SN modelId String 型号ID connectWay String 配件连接方式，包括USB,BT等 connStatus Integer 状态，1:在线， 0:离线 lanIp String 内网IP programVersion String 固件版本号 lastReportTime Long 最后上报时间 extraInfo ExtraInfo 额外信息，与型号有关，当型号为传感器时，响应的内容包括温度，电量等内容 ExtraInfo对象定义 当型号为传感器时，内容如下 参数 数据类型 描述 batteryLevel Integer 电量 humidity Integer 湿度 irradiance Integer 辐照度 temperature Integer 温度 numPeople Integer 人数统计 请求消息示例 GET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/parts/104aa43ca9994de0825ec8d32f3a8c60 HTTP/1.1 Host: api.ydmp.yealink.com 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "id": "104aa43ca9994de0825ec8d32f3a8c60", "mac":"84fd27df8045", "sn":"803111D070000358", "modelId":"RoomSensor", "modelName":"RoomSensor", "connectWay":"BT", "connStatus":1, "lanIp":"10.60.50.21", "programVersion":"153.433.0.5", "lastReportTime":1709577211630, "extraInfo":{ "batteryLevel":100, "humidity":55, "irradiance":27, "temperature":31, "numPeople":2 } } 5.3 配件重启 请求方法 POST 请求地址 /v2/dm/devices/{deviceId}/parts/reboot Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id Body参数 参数 数据类型 是否必需 描述 partIds String[] 否 配件ID列表，最大长度200，不传时表示此设备下的所有配件重启 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 重启总设备数 successCount Integer 重启成功数量 failureCount Integer 重启失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/device/0006572538f74e8683716cf961caa95b/parts/reboot HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "partIds":["00ab7c8da8ff4345af3857feb68aedef","0299d1254f7042068c4ef1c5895b7e5a"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"00ab7c8da8ff4345af3857feb68aedef", "msg":"The resource does not exist or has been deleted" }] } 5.4 配件恢复出厂 请求方法 POST 请求地址 /v2/dm/devices/{deviceId}/parts/reset Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id Body参数 参数 数据类型 是否必需 描述 partIds String[] 否 配件ID列表，最大长度200个，不传时表示此设备下的所有配件恢复出厂 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 恢复出厂总设备数 successCount Integer 恢复出厂成功数量 failureCount Integer 恢复出厂失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/device/0006572538f74e8683716cf961caa95b/parts/reset HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "partIds":["00ab7c8da8ff4345af3857feb68aedef","0299d1254f7042068c4ef1c5895b7e5a"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"00ab7c8da8ff4345af3857feb68aedef", "msg":"The resource does not exist or has been deleted" }] } 6. 设备账号管理 6.1 设备绑定账号 请求方法 POST 请求地址 /v2/dm/devices/{deviceId}/bindAccounts Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id Body参数 参数 数据类型 是否必需 描述 accounts BindAccount[] 是 要绑定的账号信息列表 BindAccount对象定义 参数 数据类型 描述 lineId integer 账号线路,从1开始 accountType Integer 账号类型: 0：SIP,1:H323 2:SFB accountId String 账号ID HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 绑定总数量 successCount Integer 绑定成功数量 failureCount Integer 绑定失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/bindAccounts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ [{ "lineId":1, "accountType":0, "accountId":"604e67944c7c43fe8b66099254ec3439" },{ "lineId":2, "accountType":0, "accountId":"a45a6b4a7e0447b8a6c3f2839d902acd" }] 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"604e67944c7c43fe8b66099254ec3439", "msg":"The resource does not exist or has been deleted" }] } 6.2 设备解绑账号 请求方法 POST 请求地址 /v2/dm/devices/{deviceId}/unbindAccounts Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id Body参数 参数 数据类型 是否必需 描述 accountIds String[] 是 要解绑的账号ID列表 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 解绑总数量 successCount Integer 解绑成功数量 failureCount Integer 解绑失败数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/devices/8d07a56207074d26b61026099625b9e2/unbindAccounts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "accountIds":["604e67944c7c43fe8b66099254ec3439","a45a6b4a7e0447b8a6c3f2839d902acd"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"604e67944c7c43fe8b66099254ec3439", "msg":"The resource does not exist or has been deleted" }] } 6.3 设备绑定的账号列表 请求方法 GET 请求地址 /v2/dm/devices/{deviceId}/boundAccounts Path参数 参数 数据类型 是否必需 描述 deviceId String 是 设备id HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 data BindAccount[] 绑定的账号信息数组 BindAccount对象定义 参数 数据类型 描述 accountId String 账号ID lineId Integer 账号线路,从1开始 accountType Integer 账号类型: 0：SIP,1:H323 2:SFB accountServer String 账号服务器地址 registerName String 注册名称 username String 用户名称 请求消息示例 GET /v2/dm/devices/8d07a56207074d26b61026099625b9e2/boundAccounts HTTP/1.1 Host: api.ydmp.yealink.com ​ 响应消息示例 HTTP/1.1 200 Content-Type: application/json ​ [{ "accountId":"604e67944c7c43fe8b66099254ec3439" "lineId":1, "accountType":0, "accountServer":"10.200.108.48", "registerName":"1000", "username":"1000" },{ "accountId":"a45a6b4a7e0447b8a6c3f2839d902acd" "lineId":2, "accountType":0, "accountServer":"10.200.108.48", "registerName":"2000", "username":"2000" }]