文档帮助平台
首页服务端API参考 企业成员管理 获取Yealink的Access Key
获取Yealink的Access Key
更新时间：2024-11-10 18:14:01

获取Yealink的Access Key

请求方法

POST

请求地址

/yak

请求参数

参数 参数类型 数据类型 是否必需 描述
identity Body String 是 第三方用户身份，例如手机号或邮箱，长度小于128
identityType Body Integer 是 身份类型，可选值：0：手机号，1：邮箱
mobile Body String 是 手机号，若identityType表示手机号，则此处与identity值一致
email Body String 否 邮箱，若identityType表示邮箱，则此处与identity值一致
mobileCode Body String 否 手机区号，默认86
name Body String 否 姓名，未传递默认使用identity值，长度小于128
groupPath Body String 否 部门名称，上下级部门间用"/"隔开，且从最上级部门开始，例如"公司名称/分公司名称"。若部门未填写，账号将默认被分配至公司根目录下；若填写的部门不存在，系统将自动生成该部门
~~visiblePermission~~ Body VisiblePermission 否 可见权限请求参数，默认仅可见自己(D)，字段废弃

HTTP状态码

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

响应参数

参数 数据类型 描述
userId String 当前用户的标识
accessToken String 当前用户的访问令牌
expireIn Long 访问令牌有效时间，单位为秒

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/yak HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
    "identity": "test@yealink.com",
    "identityType": 1,
    "email": "test@yealink.com",
    "mobile": "17700000000",
    "mobileCode": "86",
    "name": "名称",
    "groupPath": "测试组/一部"
}

响应消息示例

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

{
  "userId": "97cd56ba863243fd9c2b3e528f01e1fe",
  "accessToken": "[YAK JWT TOKEN]",
  "expires_in": 600
}

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 '{"identity":"test@yealink.com","identityType":1,"email":"test@yealink.com","mobile":"17700000000","mobileCode": "86","name":"zd3","groupPath": "测试组/一部"}' 'https://api.yealink.com/v2/yak'
本页目录