应用平台 APPSTAGE-企业微信:获取部门成员列表详情

时间:2024-06-07 17:54:49

获取部门成员列表详情

该接口用于获取部门成员列表详情信息。

  • 输入参数
    输入参数说明如表21所示。
    表21 获取部门成员列表详情输入参数说明

    参数

    必填

    说明

    调用接口凭证

    调用接口凭证。必须使用打卡应用的Secret获取access_token。

    获取的部门id

    获取的部门ID。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表22

    表22 获取部门成员列表详情输出参数说明

    参数

    说明

    返回码

    返回码。

    对返回码的文本描述内容

    对返回码的文本描述内容。

    成员详情列表

    成员详情列表。

    -userid

    成员UserID。对应管理端的账号。

    -name

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

    -department

    成员所属部门列表。仅返回该应用有查看权限的部门ID。对授权了“组织架构信息”的第三方应用,返回成员所属的全部部门ID列表。

    -order

    部门内的排序值,默认为0。数量必须和department一致,数值越大排序越前面。值范围是[0, 2^32]。

    -position

    职务信息,代开发自建应用需要管理员授权才返回。

    -mobile

    手机号码,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -gender

    性别。0表示未定义,1表示男性,2表示女性。第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。注:不可获取指返回值为0。

    -email

    邮箱,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -biz_mail

    企业邮箱 ,代开发自建应用不返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -is_leader_in_dept

    表示在所在的部门内是否为部门负责人。0表示否;1表示是。是一个列表,数量必须与department一致。第三方通讯录应用或者授权了“组织架构信息-应用可获取企业的部门组织架构信息-部门负责人”权限的第三方应用可获取;对于非第三方创建的成员,第三方通讯录应用不可获取;上游企业不可获取下游企业成员该字段。

    -direct_leader

    直属上级UserID,返回在应用可见范围内的直属上级列表,最多有五个直属上级;第三方通讯录应用或者授权了“组织架构信息-应用可获取可见范围内成员组织架构信息-直属上级”权限的第三方应用可获取;对于非第三方创建的成员,第三方通讯录应用不可获取;上游企业不可获取下游企业成员该字段。

    -avatar

    头像url。 第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -thumb_avatar

    头像缩略图url。第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -telephone

    座机。代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -alias

    别名;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -status

    激活状态: 1=已激活,2=已禁用,4=未激活,5=退出企业。已激活代表已激活企业微信或已关注微信插件(原企业号)。未激活代表既未激活企业微信又未关注微信插件(原企业号)。

    -address

    地址。代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -hide_mobile

    隐藏手机。

    -english_name

    英文名字。

    -open_userid

    扩展属性,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -main_department

    扩展属性,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -extattr

    扩展属性,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

    -qr_code

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

    -external_position

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

    -external_profile

    成员对外属性,字段详情见对外属性;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。

support.huaweicloud.com/usermanual-appstage/appstage_04_1014.html