读取成员

GET

http://127.0.0.1/cgi-bin/user/get

智慧硬件开发/通讯录管理/成员管理

最后修改时间：2022-08-30 03:03:36

责任人：未设置

权限说明：应用须拥有指定成员的查看权限。

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

userid

string

必需

成员UserID。对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字节

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'http://127.0.0.1/cgi-bin/user/get?access_token={{access_token}}&userid={{userid}}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

address

string

可选

地址。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

gender

string

可选

性别。0表示未定义，1表示男性，2表示女性

external_position

string

可选

对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

mobile

string

可选

手机号码，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

errmsg

string

可选

对返回码的文本描述内容

is_leader_in_dept

array[string]

可选

表示在所在的部门内是否为上级。；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

telephone

string

可选

座机。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

avatar

string

可选

头像url。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

main_department

integer <int32>

主部门

可选

userid

string

可选

成员UserID。对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字节

thumb_avatar

string

可选

头像缩略图url。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

name

string

可选

成员名称；第三方不可获取，调用时返回userid以代替name；代开发自建应用需要管理员授权才返回；对于非第三方创建的成员，第三方通讯录应用也不可获取；未返回name的情况需要通过通讯录展示组件来展示名字

alias

string

可选

别名；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

extattr

object

可选

扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

qr_code

string

可选

员工个人二维码，扫描可添加为外部联系人(注意返回的是一个url，可在浏览器上打开该url以展示二维码)；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

position

string

可选

职务信息；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

department

array[string]

可选

成员所属部门id列表，仅返回该应用有查看权限的部门id；成员授权模式下，固定返回根部门id，即固定为1

open_userid

string

可选

全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取

external_profile

object

可选

成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

string

可选

邮箱，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

order

array[string]

可选

部门内的排序值，默认为0。数量必须和department一致，数值越大排序越前面。值范围是[0, 2^32)。成员授权模式下不返回该字段

status

integer <int32>

可选

对外展示视频号状态。0表示企业视频号已被确认，可正常使用，1表示企业视频号待确认。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取

示例

{
  "errcode": 0,
  "address": "string",
  "gender": "string",
  "external_position": "string",
  "mobile": "string",
  "errmsg": "string",
  "is_leader_in_dept": [
    "string"
  ],
  "telephone": "string",
  "avatar": "string",
  "main_department": 0,
  "userid": "string",
  "thumb_avatar": "string",
  "name": "string",
  "alias": "string",
  "extattr": {},
  "qr_code": "string",
  "position": "string",
  "department": [
    "string"
  ],
  "open_userid": "string",
  "external_profile": {},
  "email": "string",
  "order": [
    "string"
  ],
  "status": 0
}

修改于 2022-08-30 03:03:36

创建成员

更新成员