# 通过手机号或邮箱获取用户 ID
通过该接口,可使用手机号/邮箱获取用户的 ID 信息。
注意事项:
- 如果查询的手机号、邮箱不存在,或者无权限查看对应的用户,则返回空
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/contact/v2/users/batch_get_id |
HTTP Method | POST |
支持的应用类型 | 自建应用 商店应用 |
权限要求 | 通过手机号或邮箱获取用户 ID |
字段权限要求 | 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 获取用户 user_id(仅自建应用) |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
# 查询参数
名称 | 类型 | 描述 |
---|---|---|
user_id_type | string | 用户 ID 类型示例值:"open_id" 可选值有: open_id:用户的 open id union_id:用户的 union id user_id:用户的 user id 默认值:open_id 当值为 user_id,字段权限要求: 获取用户 user ID |
# 请求体
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
emails | string[] | 否 | 要查询的用户邮箱,最多 50 条。 示例值:zhangsan@a.com 数据校验规则: * 最大长度: 50 |
mobiles | string[] | 否 | 要查询的用户手机号,最多 50 条。 非中国大陆地区的手机号需要添加以 “+” 开头的国家 / 地区代码。 示例值:13812345678 数据校验规则: * 最大长度: 50 |
# 请求体示例
{
"emails": [
"zhangsan@z.com",
"lisi@a.com"
],
"mobiles": [
"13812345678",
"13812345679"
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | - | - |
∟user_id | string | 用户id、。如果查询的手机号、邮箱不存在,或者无权限查看对应的用户,则此项为空。需要权限: 获取用户 user_id |
∟mobile | string | 手机号,通过手机号查询时返回 |
string | 邮箱,通过邮箱查询时返回 |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"data": [
{
"user_id": "12196",
"mobile": "15312341234",
"email": "ajfk@abc.com"
}
],
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
← 获取通讯录授权范围 获取部门直属用户列表 →