me.chanjar.weixin.cp.api.WxCpExportService Maven / Gradle / Ivy
package me.chanjar.weixin.cp.api;
import me.chanjar.weixin.common.error.WxErrorException;
import me.chanjar.weixin.cp.bean.export.WxCpExportRequest;
import me.chanjar.weixin.cp.bean.export.WxCpExportResult;
/**
* 异步导出接口
*
* @author zhongjun created on 2022/4/21
*/
public interface WxCpExportService {
/**
*
*
* 导出成员
*
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/export/simple_user?access_token=ACCESS_TOKEN
*
* 文档地址：https://developer.work.weixin.qq.com/document/path/94849
*
*
* @param params 导出参数
* @return jobId 异步任务id
* @throws WxErrorException .
*/
String simpleUser(WxCpExportRequest params) throws WxErrorException;
/**
*
*
* 导出成员详情
*
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/export/user?access_token=ACCESS_TOKEN
*
* 文档地址：https://developer.work.weixin.qq.com/document/path/94851
*
*
* @param params 导出参数
* @return jobId 异步任务id
* @throws WxErrorException .
*/
String user(WxCpExportRequest params) throws WxErrorException;
/**
*
*
* 导出部门
*
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/export/department?access_token=ACCESS_TOKEN
*
* 文档地址：https://developer.work.weixin.qq.com/document/path/94852
*
*
* @param params 导出参数
* @return jobId 异步任务id
* @throws WxErrorException .
*/
String department(WxCpExportRequest params) throws WxErrorException;
/**
*
*
* 导出标签成员
*
* 请求方式：POST（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/export/taguser?access_token=ACCESS_TOKEN
*
* 文档地址：https://developer.work.weixin.qq.com/document/path/94853
*
*
* @param params 导出参数
* @return jobId 异步任务id
* @throws WxErrorException .
*/
String tagUser(WxCpExportRequest params) throws WxErrorException;
/**
*
*
* 获取导出结果
*
* 请求方式：GET（HTTPS）
* 请求地址：https://qyapi.weixin.qq.com/cgi-bin/export/get_result?access_token=ACCESS_TOKEN&jobid=jobid_xxxxxxxxxxxxxxx
*
* 文档地址：https://developer.work.weixin.qq.com/document/path/94854
* 返回的url文件下载解密可参考 CSDN
*
*
* @param jobId 异步任务id
* @return 导出结果 result
* @throws WxErrorException .
*/
WxCpExportResult getResult(String jobId) throws WxErrorException;
}