获取成员手机号
使用场景: 根据userid来查询用户手机号。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/phone/get?access_token=ACCESS_TOKEN&userid=USERID
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
userid | 是 | 要查询用户的userid |
注意:access_token,可以使用用户票据access_token代替(由/open/access_token获得。) 此时userid可以不传,由用户本身userid确定。
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"phone": "18888888888"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
phone | 用户对应手机号,2024-01-05日起新建的应用返回值为加密数据(解密参考附录参数加解密说明 里开放接口参数加解密章节) |
修改成员手机号
使用场景: 更新一个用户的手机号,用于用户换绑手机,或者收集到手机号发生变化。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/common/user/update_mobile
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证-机构token |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
userid | string | 是 | 用户id |
mobile | string | 是 | 新的手机号 |
single_identity | bool | 否 | 只修改单个角色手机号,默认为false |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
请求示例
POST https://test-oapi.epaas.qq.com/common/user/update_mobile?access_token=ACCESS_TOKEN
请求包体:
{
"userid": "3",
"mobile": "18888888888",
"single_identity": true
}
返回示例:
{
"errcode":0,
"errmsg":"ok"
}
批量获取成员手机号
使用场景: 根据userid来批量查询用户手机号。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求方式: GET, POST (HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/phone/batch_get?access_token=ACCESS_TOKEN
请求包体:
{
"userids": [
"123",
"456"
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
userids | 是 | 要查询用户的userid 列表,最大限制数量:100 |
fetch_child | 否 | 是否查询下属机构用户的手机号码 |
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"userlist": [
{
"userid": "30009907",
"phone": ""
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
userlist | 数据列表 |
userlist.userid | 用户id,在机构内唯一 |
userlist.phone | 用户手机号码 |
按手机号检索成员
使用场景: 根据phone来查询用户。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求地址: https://test-oapi.epaas.qq.com/common/user/search_by_phone
请求方法: POST
请求包体:
{
"phone":"18682451723",
"role_ids":[12,13],
"fetch_child":0,
"sub_corpids":[1004820,1086786]
}
请求参数:
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 调用接口凭证 |
phone | 是 | string | 用于精确搜索的完整手机号 |
role_ids | 否 | int数组 | 用于过滤返回用户列表,返回指定角色, 参考角色类型 ) |
fetch_child | 否 | int | 是否查询下属机构 0:不查询(默认) 1:查询子孙机构 |
sub_corpids | 否 | int数组 | 指定下属机构id列表 (该参数有值,则会忽略字段fetch_child) |
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"user_list": [
{
"userid": "3723911489",
"name": "张三",
"role_id": 12,
"corp_id": 1086786,
"corp_name": "测试学校",
"corp_type": 4
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
user_list | 手机号码匹配的用户列表 |
user_list.userid | 用户id,在机构内唯一 |
user_list.name | 用户姓名 |
user_list.role_id | 角色id, 参考角色类型 |
user_list.corp_id | 机构id |
user_list.corp_name | 机构名称 |
user_list.corp_type | 机构类型 2:教育局 4:学校 |
批量按手机号检索成员
使用场景: 批量按手机号检索成员。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求地址: https://test-oapi.epaas.qq.com/common/user/batch_search_by_phone
请求方法: POST
请求包体:
{
"phone": ["18682451723"],
"role_ids": [12],
"fetch_child":0,
"sub_corpids":[1004820,1086786]
}
请求参数:
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 调用接口凭证 |
phone | 是 | string数组 | 用于精确搜索的完整手机号列表 |
role_ids | 否 | int数组 | 用于过滤返回用户列表,返回指定角色, 参考角色类型 ) |
fetch_child | 否 | int | 是否查询下属机构 0:不查询(默认) 1:查询子孙机构 |
sub_corpids | 否 | int数组 | 指定下属机构id列表 (该参数有值,则会忽略字段fetch_child) |
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"user_list": [
{
"phone": "18682451723",
"userid": "3723911489",
"name": "张三",
"role_id": 12,
"corp_id": 1086786,
"corp_name": "测试学校",
"corp_type": 4
},
{
"phone": "18682451723",
"userid": "3723911489",
"name": "张三",
"role_id": 13,
"corp_id": 1086786,
"corp_name": "测试学校",
"corp_type": 4
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
user_list | 手机号码匹配的用户列表 |
user_list.phone | 手机号码,注意同机构内一个号码可能对应多个用户 |
user_list.userid | 用户id,在机构内唯一 |
user_list.name | 用户姓名 |
user_list.role_id | 角色id, 参考角色类型 |
user_list.corp_id | 机构id |
user_list.corp_name | 机构名称 |
user_list.corp_type | 机构类型 2:教育局 4:学校 |
批量设置手机号
使用场景: 使用userid批量设置手机号。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求方式: POST (HTTPS)
请求地址: https://test-oapi.epaas.qq.com/common/user/batch_set_phone?access_token=ACCESS_TOKEN
请求包体:
{
"set_phones": [
{
"userid": "3724690177",
"phone": "18682451723"
}
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
set_phones.userid | 是 | 用户ID |
set_phones.phone | 否 | 手机号,如需抹掉手机号该字段不要填 |
返回示例:
{
"errcode": 0,
"errmsg": ""
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |