Package com.foxinmy.weixin4j.qy.api

Class BatchApi

  • public class BatchApi
extends QyApi
    批量异步任务API

    异步任务接口用于大批量数据的处理，提交后接口即返回，企业号会在后台继续执行任务。执行完成后，通过任务事件通知企业获取结果

    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)
    See Also:
    批量任务

    • Constructor Detail

      • BatchApi

        public BatchApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • inviteUser

        public String inviteUser​(IdParameter parameter,
                         Callback callback,
                         String tips)
                  throws com.foxinmy.weixin4j.exception.WeixinException
        批量邀请成员关注
        Parameters:
        parameter - 成员ID,标签ID,部门ID
        callback - 接收任务执行结果的回调地址等信息
        tips - 推送到微信上的提示语（只有认证号可以使用）。当使用微信推送时，该字段默认为“请关注XXX企业号”，邮件邀请时，该字段无效。
        Returns:
        异步任务id，最大长度为64字符
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        IdParameter, Callback, 邀请成员关注

      • syncUser

        public String syncUser​(String mediaId,
                       Callback callback)
                throws com.foxinmy.weixin4j.exception.WeixinException
        批量更新成员,本接口以userid为主键，增量更新企业号通讯录成员。

        1.模板中的部门需填写部门ID，多个部门用分号分隔，部门ID必须为数字
        2.文件中存在、通讯录中也存在的成员，更新成员在文件中指定的字段值
        3.文件中存在、通讯录中不存在的成员，执行添加操作
        4.通讯录中存在、文件中不存在的成员，保持不变

        Parameters:
        mediaId - 带user信息的cvs文件上传后的media_id
        callback - 接收任务执行结果的回调地址等信息
        Returns:
        异步任务id，最大长度为64字符
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Callback, 批量更新成员

      • replaceUser

        public String replaceUser​(String mediaId,
                          Callback callback)
                   throws com.foxinmy.weixin4j.exception.WeixinException
        批量覆盖成员,本接口以userid为主键，全量覆盖企业号通讯录成员，任务完成后企业号通讯录成员与提交的文件完全保持一致。

        1.模板中的部门需填写部门ID，多个部门用分号分隔，部门ID必须为数字
        2.文件中存在、通讯录中也存在的成员，完全以文件为准
        3.文件中存在、通讯录中不存在的成员，执行添加操作
        4.通讯录中存在、文件中不存在的成员，执行删除操作。出于安全考虑，如果需要删除的成员多于50人， 且多于现有人数的20%以上，系统将中止导入并返回相应的错误码

        Parameters:
        mediaId - 带userid信息的cvs文件上传后的media_id
        callback - 接收任务执行结果的回调地址等信息
        Returns:
        异步任务id，最大长度为64字符
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Callback, 批量覆盖成员

      • replaceParty

        public String replaceParty​(String mediaId,
                           Callback callback)
                    throws com.foxinmy.weixin4j.exception.WeixinException
        批量覆盖部门,本接口以partyid为键，全量覆盖企业号通讯录组织架构，任务完成后企业号通讯录组织架构与提交的文件完全保持一致。

        1.文件中存在、通讯录中也存在的部门，执行修改操作
        2.文件中存在、通讯录中不存在的部门，执行添加操作
        3.文件中不存在、通讯录中存在的部门，当部门为空时，执行删除操作
        4.CSV文件中，部门名称、部门ID、父部门ID为必填字段，部门ID必须为数字；排序为可选字段，置空或填0不修改排序

        Parameters:
        mediaId - 带partyid信息的cvs文件上传后的media_id
        callback - 接收任务执行结果的回调地址等信息
        Returns:
        异步任务id，最大长度为64字符
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        Callback, 批量覆盖部门

      • getBatchResult

        public BatchResult getBatchResult​(String jobId)
                           throws com.foxinmy.weixin4j.exception.WeixinException
        获取异步任务执行的结果
        Parameters:
        jobId - 任务ID
        Returns:
        执行结果对象
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        BatchResult, 获取异步任务执行结果