手机号转外部联系人ID

POST

/cgi-bin/externalcontact/batch_to_external_userid

服务端API第三方应用开发

权限说明：
学校需要使用“家校沟通”secret所获取的accesstoken来调用（accesstoken如何获取？）；
第三方应用需拥有「家校沟通」使用权限。

文档ID: 19932
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/92506

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch_to_external_userid?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"mobiles":["10000000000","10000000001"]}'

响应示例

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

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

mobiles

array[string]

必需

家长手机号列表，最多支持100个

示例

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

fail_list

array [object {3}]

转换失败列表

可选

errcode

integer <int32>

返回码

可选

mobile

string

手机号

可选

errmsg

string

可选

对返回码的文本描述内容

success_list

array [object {3}]

转换成功列表

可选

external_userid

string

可选

外部联系人的userid(家长关注后才会返回该字段)

foreign_key

string

可选

由企业或服务商在导入家长时指定的关键字，也就是家校通讯录中的家长ID

mobile

string

手机号

可选

errmsg

string

可选

对返回码的文本描述内容

修改于 2022-12-07 02:34:27

外部联系人openid转换

管理「老师可查看班级」模式-设置「老师可查看班级」的模式