第三方应用开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
第三方应用开发
服务端API
通讯录管理
异步导入接口
全量覆盖成员
全量覆盖成员
最后更新:2024/05/15

本接口以userid为主键,全量覆盖企业的通讯录成员,任务完成后企业的通讯录成员与提交的文件完全保持一致。请先下载CSV文件(下载全量覆盖成员模版),根据需求填写文件内容。

注意事项:

  • 模板中的部门需填写部门ID,多个部门用分号分隔,部门ID必须为数字,根部门的部门id默认为1。当填写的部门ID不存在时,会在其他(待设置部门下)新建此部门。
  • 文件中存在、通讯录中也存在的成员,完全以文件为准
  • 文件中存在、通讯录中不存在的成员,执行添加操作
  • 通讯录中存在、文件中不存在的成员,执行删除操作。出于安全考虑,下面两种情形系统将中止导入并返回相应的错误码。
    • 需要删除的成员多于50人,且多于现有人数的20%以上
    • 需要删除的成员少于50人,且多于现有人数的80%以上
  • 成员字段更新规则:可自行添加扩展字段。文件中有指定的字段,以指定的字段值为准;文件中没指定的字段,不更新

请求方式:POST(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/batch/replaceuser?access_token=ACCESS_TOKEN

请求包体:

{
	"media_id":"xxxxxx",
	"to_invite": true,
	"callback":
	{
	 	"url": "xxx",
	 	"token": "xxx",
	 	"encodingaeskey": "xxx"
	}
}

参数说明:

参数必须说明
media_id上传的csv文件的media_id
to_invite是否邀请新建的成员使用企业微信(将通过微信服务通知或短信或邮件下发邀请,每天自动下发一次,最多持续3个工作日),默认值为true。
callback回调信息。如填写该项则任务完成后,通过callback推送事件给企业。具体请参考应用回调模式中的相应选项
url企业应用接收企业微信推送请求的访问协议和地址,支持http或https协议
token用于生成签名
encodingaeskey用于消息体的加密,是AES密钥的Base64编码

权限说明:
须拥有通讯录的写权限。

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"jobid": "xxxxx"
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
jobid异步任务id,最大长度为64字节
上一篇增量更新成员
下一篇全量覆盖部门
    本节内容
服务端API
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们