1. 添加SIP账号 请求方法 POST 请求地址 /v2/dm/sipAccounts Body参数 参数 数据类型 是否必需 描述 registerName String 是 注册名称，最大长度128 username String 是 用户名，最大长度128 password String 是 密码，最大长度128 displayName String 否 显示名，最大长度128 label String 否 标签，最大长度128 sipServer1 SipServer 是 sip服务器1地址 sipServer2 SipServer 否 sip服务器2地址 remark String 否 备注，最大长度512 siteId String 否 要归属的站点ID SipServer对象定义 参数 数据类型 描述 host String 服务器地址,最大长度256 port Integer 服务器端口,0~65535 HTTP状态码 返回值 描述 201 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 id String 账号id username String 用户名 registerInfo String 注册信息 serverAddress String 服务器地址 accountType Integer 账号类型,0：SIP,1:H323 2:SFB remark String 备注 createTime Long 创建时间 请求消息示例 POST /v2/dm/sipAccounts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "registerName": "2552", "username": "2552", "password": "******", "label": "2552", "displayName": "2552", "sipServer1": { "host": "ume.yealink.com", "port":5061 }, "siteId":"0006d62003684754b11c09c5d94ea687", "remark":"test" } 响应消息示例 HTTP/1.1 201 Created Content-Type: application/json;charset=UTF-8 ​ { "id": "e33b8f25247e45de84dd4c74503b241a", "registerInfo": "2552", "username": "2552", "serverAddress": "ume.yealink.com", "accountType": 0, "createTime": 1698052518923 } 2. 编辑SIP账号 请求方法 PATCH 请求地址 /v2/dm/sipAccounts/{accountId} Path参数 参数 数据类型 是否必需 描述 accountId String 是 账号ID Body参数 参数 数据类型 是否必需 描述 registerName String 是 注册名称，最大长度128 username String 是 用户名，最大长度128 password String 是 密码，最大长度128 displayName String 否 显示名，最大长度128 label String 否 标签，最大长度128 sipServer1 SipServer 是 sip服务器1地址 sipServer2 SipServer 否 sip服务器2地址 remark String 否 备注，最大长度512 siteId String 否 要归属的站点ID SipServer对象定义 参数 数据类型 描述 host String 服务器地址，最大长度256 port Integer 服务器端口,0~65535 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 请求消息示例 PATCH /v2/dm/sipAccounts/e33b8f25247e45de84dd4c74503b241a HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "registerName": "2553", "username": "2552", "password": "******", "label": "2552", "displayName": "2552", "sipServer1": { "host": "ume.yealink.com", "port":5061 }, "siteId":"0006d62003684754b11c09c5d94ea687", "remark":"test" } 响应消息示例 HTTP/1.1 200 3. 账号列表 请求方法 POST 请求地址 /v2/dm/listAccounts Body参数 参数 数据类型 是否必需 描述 skip Long 否 跳过的记录数，默认为0 limit Long 否 获取的最大记录数，默认为10，最大500 autoCount Boolean 否 是否要响应总数量，建议在第一页查询时为true,后续翻页时传false filter Filter 否 搜索参数 Filter对象定义 参数 数据类型 是否必需 描述 username String 否 用户名模糊搜索关键字 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 skip Long 偏移量 limit Long 返回最大数量 total Long 总数量 data Account[] Account信息数组 Account对象定义 参数 数据类型 描述 id String 账号id username String 用户名 registerInfo String 注册信息 serverAddress String 服务器地址 accountType Integer 账号类型,0：SIP,1:H323 2:SFB remark String 备注 createTime Long 创建时间 请求消息示例 POST /v2/dm/listAccounts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "skip": 0, "limit": 20, "autoCount": true, "filter":{ "username":"2552" } } 响应消息示例 HTTP/1.1 200 Content-Type: application/json;charset=UTF-8 ​ { "skip": 0, "limit": 10, "total": 1, "data":[{ "id": "e33b8f25247e45de84dd4c74503b241a", "registerInfo": "2552", "username": "h323", "accountType": 1, "createTime": 1698052518923 }] } 4. 删除账号 请求方法 POST 请求地址 /v2/dm/delAccounts Body参数 参数 数据类型 是否必需 描述 accountIds String[] 是 账号ID列表,最大长度200 HTTP状态码 返回值 描述 200 操作成功 400 客户端传参异常 401 鉴权失败 500 服务端异常 响应参数 参数 数据类型 描述 total Integer 删除总条数 successCount Integer 成功删除总数量 failureCount Integer 失败总数量 errors OpError[] 错误信息 OpError对象 参数 数据类型 描述 field String 错误字段 msg String 错误信息 请求消息示例 POST /v2/dm/delAccounts HTTP/1.1 Host: api.ydmp.yealink.com Content-Type: application/json ​ { "accountIds":["e33b8f25247e45de84dd4c74503b241a","2d3e77b736e240eabf25aa1f5448aa0c"] } 响应消息示例 HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 ​ { "total": 2, "successCount":1, "failureCount":1, "errors":[{ "field":"2d3e77b736e240eabf25aa1f5448aa0c", "msg":"The resource does not exist or has been deleted" }] }