第三方应用开发 服务端API 家校沟通 基础接口 手机号转外部联系人ID
手机号转外部联系人ID

请求方式: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个

权限说明:
学校需要使用“家校沟通”secret所获取的accesstoken来调用(accesstoken如何获取?);
第三方应用需拥有「家校沟通」使用权限。

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "success_list": [
        {
            "mobile": "18900000000",
            "external_userid": "aaabbbcccc",
            "foreign_key": "zhangsan"
        }
    ],
    "fail_list": [
        {
            "errcode": 60136,
            "errmsg": "record not found",
            "mobile": "10000000001"
        }
    ]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
success_list转换成功列表
success_list.mobile手机号
success_list.external_userid外部联系人的userid(家长关注后才会返回该字段)
success_list.foreign_key由企业或服务商在导入家长时指定的关键字,也就是家校通讯录中的家长ID
fail_list转换失败列表
fail_list.errcode返回码
fail_list.errmsg对返回码的文本描述内容
fail_list.mobile手机号
上一篇
外部联系人openid转换
下一篇
管理「老师可查看班级」模式