通过手机号或邮箱获取用户 ID

POST

/open-apis/contact/v3/users/batch_get_id

自建应用商店应用

通过该接口，可使用手机号/邮箱获取用户的 ID 信息，具体获取支持的 ID 类型包括 open_id、user_id、union_id，可通过查询参数指定。
如果查询的手机号、邮箱不存在，或者无权限查看对应的用户，则返回的用户ID列表为空。

权限要求：
通过手机号或邮箱获取用户 ID
字段权限要求：
该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请

获取用户 user ID

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/contact/v3/users/batch_get_id' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "emails": [
"zhangsan@z.com","lisi@a.com"
    ],
    "mobiles": [
"13812345678","13812345679"
    ]
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "user_list": [
      {
        "user_id": "ou_979112345678741d29069abcdef089d4",
        "email": "zhangsan@a.com"
      },
      {
        "user_id": "ou_919112245678741d29069abcdef096af",
        "email": "lisi@a.com"
      },
      {
        "user_id": "ou_46a087654321a1dc920ffab8fedc823f",
        "mobile": "13812345678"
      },
      {
        "user_id": "ou_01b081675121a1dc920ffab97cdc017a",
        "mobile": "13812345679"
      }
    ]
  }
}

请求参数

Query 参数

user_id_type

string

可选

用户 ID 类型示例值："open_id" 可选值有： open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

emails

array[string]

可选

要查询的用户邮箱，最多 50 条。示例值：zhangsan@a.com 数据校验规则：最大长度：50

mobiles

array[string]

可选

要查询的用户手机号，最多 50 条。非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。示例值：13812345678 数据校验规则：最大长度：50

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

user_list

array [object {3}]

必需

手机号或者邮箱对应的用户id信息

修改于 2023-01-12 03:48:58

获取部门直属用户列表

资源介绍