添加硬件终端
更新时间:2025-04-18 07:15:54

添加硬件终端

请求方法

POST

请求地址

/devices

请求参数

参数 参数类型 数据类型 是否必需 描述
name Body String 名称,长度小于128
email Body String 邮箱,长度小于64
groupId Body String 分组id,长度32,默认添加至根分组下
extension Body String 分机号,必须符合企业号码段规则,默认4位数字
password Body String 密码,最小长度8,最大长度64
enableMeetNow Body Boolean 是否启用即时会议功能,默认为true
~~visiblePermission~~ Body VisiblePermission 可见权限请求参数,默认可见企业内全部联系人(A),字段废弃

HTTP状态码

返回值 描述
200 操作成功,详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
id String 主键id
number String 号码

VisiblePermission

参数 数据类型 是否必须 描述
code String 可见权限类型,详见可见权限类型
nodes VisiblePermissionNode[] 节点数据,code为E时必填

VisiblePermissionNode

参数 数据类型 是否必须 描述
dataId String 节点数据id,E权限时有效,其值为节点数据类型对应的实体id
dataType Integer 节点数据类型,E权限时有效,详见节点数据类型

可见权限类型

可见权限类型
可见企业内全部联系人 A
可见所在部门及同级部门的所有联系人 B
仅可见所在部门的所有联系人 C
仅可见自己 D
自定义 E

节点数据类型

节点数据类型
用户分组 1
用户 2
设备分组 3
设备 4
VMR分组 5
VMR 6
外部联系人分组 9
外部联系人 10

请求消息示例

POST /v2/devices HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
    "name":"终端VC200",
    "extension":"0026",
    "password":"v123456789",
    "enableMeetNow":true
}

响应消息示例

HTTP/1.1 200
Content-Type: application/json;charset=UTF-8

{
    "id":"cb4faa0e82b8445cad09e4ec05220f16",
    "number":"82209640026"
}

CURL命令示例

curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H "Content-type: application/json" -d '{"name":"终端VC200","extension":"0026","password":"v123456789","enableMeetNow":true}' 'https://api.yealink.com/v2/devices'
本页目录