请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch_to_external_userid?access_token=ACCESS_TOKEN
请求示例
{
"mobiles": [
"10000000000",
"10000000001"
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
mobiles | 是 | 家长手机号列表,最多支持100个 |
权限说明:
调用的应用需要满足如下的权限
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「 家校沟通- 读取和编辑家校通讯录的应用」中 |
第三方应用 | 需拥有「家校沟通」使用和编辑 权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"success_list": [
{
"mobile": "18900000000",
"external_userid": "aaabbbcccc"
}
],
"fail_list": [
{
"errcode": 60136,
"errmsg": "record not found",
"mobile": "10000000001"
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
success_list | 转换成功列表 |
success_list.mobile | 手机号 |
success_list.external_userid | 外部联系人的userid(家长关注后才会返回该字段) |
fail_list | 转换失败列表 |
fail_list.errcode | 返回码 |
fail_list.errmsg | 对返回码的文本描述内容 |
fail_list.mobile | 手机号 |