1. 添加站点
请求方法
POST
请求地址
/v2/dm/sites
Body参数
参数
数据类型
是否必需
描述
name
String
是
站点名称,最大长度128
parentId
String
是
上级站点ID
description
String
否
描述,最大长度1024
HTTP状态码
返回值
描述
201
操作成功,详见响应参数
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应参数
参数
数据类型
描述
id
String
站点id
name
String
站点名称
parentId
String
上级站点ID
siteNumber
String
站点编码
请求消息示例
POST /v2/dm/sites HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"name":"site1",
"parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
"description":"site1"
}
响应消息示例
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
{
"id": "0006d62003684754b11c09c5d94ea687",
"name":"site1",
"parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
"siteNumber":"ofpb5gvg"
}
2. 编辑站点
请求方法
PATCH
请求地址
/v2/dm/sites/{siteId}
Path参数
参数
数据类型
是否必需
描述
siteId
String
是
站点ID
Body参数
参数
数据类型
是否必需
描述
name
String
否
站点名称
parentId
String
否
上级站点ID
description
String
否
描述,最大长度1024
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
请求消息示例
PATCH /v2/dm/sites/0006d62003684754b11c09c5d94ea687 HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"name":"site11",
"description":"site11",
"parentId":"d3a6ff43f2154b868ba1157eb3677c1e"
}
响应消息示例
HTTP/1.1 200
3. 删除站点
请求方法
DELETE
请求地址
/v2/dm/sites/{siteId}
PATH参数
参数
数据类型
是否必需
描述
siteId
String
是
站点id
请求消息示例
DELETE /v2/dm/sites/e33b8f25247e45de84dd4c74503b241a HTTP/1.1
Host: api.ydmp.yealink.com
响应消息示例
HTTP/1.1 200
4. 站点列表
请求方法
POST
请求地址
/v2/dm/listSites
Body参数
参数名称
数据类型
是否必须
参数说明
skip
Long
否
跳过的记录数,默认为0
limit
Long
否
获取的最大记录数,默认为10,最大500
autoCount
Boolean
否
是否要返回记录总数据量
filter
Filter
否
搜索参数
Filter对象定义
参数
数据类型
是否必需
描述
name
String
否
站点名称
响应参数
参数
数据类型
描述
data
Site[]
Site信息数组
Site对象定义
参数
数据类型
描述
id
String
站点id
parentId
String
上级站点ID
name
String
站点名称
level
Integer
站点层级,0表示根站点
sequence
Integer
站点在层级中的序号
请求消息示例
POST /v2/dm/listSites HTTP/1.1
Host: api.ydmp.yealink.com
Content-Type: application/json
{
"skip":0,
"limit":10,
"filter":{
"name":"test"
}
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"skip": 0,
"limit": 10,
"total": 1,
"data":[{
"id":"1e876bc0fca24b728eeb3e52bbfebf5e",
"parentId":"23b63cac1f6d4134b5459a4face901c3",
"name":"test",
"level":2,
"sequence":1,
}]
}
5. 站点详情
请求方法
GET
请求地址
/v2/dm/sites/{siteId}
Path参数
参数
数据类型
是否必需
描述
siteId
String
是
站点ID
响应参数
参数
数据类型
描述
id
String
站点id
parentId
String
上级站点id
name
String
站点名称
siteNumber
String
站点编码
description
String
描述信息
请求消息示例
GET /v2/dm/sites/288ff0d0bd4948b0a95785ba7bc72a8e HTTP/1.1
Host: api.ydmp.yealink.com
HTTP状态码
返回值
描述
200
操作成功
400
客户端传参异常
401
鉴权失败
500
服务端异常
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "288ff0d0bd4948b0a95785ba7bc72a8e",
"name":"site1",
"parentId":"d3a6ff43f2154b868ba1157eb3677c1e",
"siteNumber":"ofpb5gvg",
"description":"site1"
}