跳到主要内容

获取外部用户

该接口用于获取在通讯录中的外部用户。


权限说明

限专有轻流可用。「超管accessToken」和「权限组accessToken」都可以调用,「权限组accessToken」须具有通讯录的权限。

路径参数

请求

请求方式:GET

请求地址:https://自有域名/openApi/external/user/get/{userId}

请求头(header)

参数类型是否必须说明
accessTokenstring可在【插件中心】-【openAPI】查询每个工作区的accessToken,token没有时限,除非手动重置

REST参数

参数类型是否必须说明
userId​
string

返回

**返回体 **

参数类型是否必含说明
errCodeint错误代码
errMsgobject错误信息对象
errMsg.messagestring具体错误描述
resultobject返回对象信息
userIdstring用户的外部id
nickNamestring用户名字
emailstring邮箱地址
headImgstring头像URL地址
mobileNumstring手机号和邮箱二选一必填
areaCodestring手机区号(不带+号,如86)
beingDisabledboolean是否禁用(true/false)
beingCollaboratorboolean是否开启协同(true/false)
deptInfoobject部门信息
namestring-外部部门名称
deptIdlong外部部门ID