应用平台 APPSTAGE-企业微信:获取成员信息

时间:2024-06-11 14:30:40

获取成员信息

在通讯录同步助手中此接口可以读取企业通讯录的所有成员的信息,而自建应用可以读取该应用设置的可见范围内的成员信息。

  • 输入参数
    输入参数说明如表41所示。
    表41 获取成员信息输入参数说明

    参数

    必填

    说明

    调用接口凭证

    调用接口凭证。

    成员UserID

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

  • 输出参数

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

    表42 获取成员信息输出参数说明

    参数

    说明

    返回码

    返回码。

    对返回码的文本描述内容

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

    成员UserID

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

    成员名称

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

    手机号码

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

    成员所属部门id列表

    成员所属部门ID列表,仅返回该应用有查看权限的部门ID;成员授权模式下,固定返回根部门ID,即固定为1。对授权了“组织架构信息”权限的第三方应用,返回成员所属的全部部门ID。

    部门内的排序值

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

    职务信息

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

    性别

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

    邮箱

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

    企业邮箱

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

    表示在所在的部门内是否为部门负责人

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

    直属上级UserID

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

    头像url

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

    头像缩略图url

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

    座机

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

    别名

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

    地址

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

    全局唯一

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

    主部门

    主部门,仅当应用对主部门有查看权限时返回。

    扩展属性

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

    激活状态

    激活状态。

    1:已激活

    2:已禁用

    4:未激活

    5:退出企业

    已激活代表已激活企业微信或已关注微信插件(原企业号)。未激活代表既未激活企业微信又未关注微信插件(原企业号)。

    员工个人二维码

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

    对外职务

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

    成员对外属性

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

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