2.3 任务联系人管理
2.3.1 任务联系人上传(文件方式)
基本信息
Path: /api/v1/config/openapi/contact/uploadDataSource/v2
Method: POST
接口描述:
任务联系人上传,可追加和覆盖。
1. 存在任务进行中,任务暂停,任务完成,只能追加不能覆盖
2. 任务新创建,若30min中内将要开始,只能追加不能覆盖
3. 每天凌晨0点到2点。不能操作上传
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | multipart/form-data | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
dataSourceFile | file | 是 | Csv文件,文件编码格式为GBK | |
companyId | text | 否 | 企业id | |
abbreviate | text | 是 | 企业缩写 | |
dataSourceName | text | 是 | 数据源名称 | |
operationType | text | 是 | 0:追加 1:覆盖 | |
dataSourceType | text | 否 | 数据源类型 0上传数据源(默认) | |
token | text | 是 | token |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.3.2 DNC联系人上传(文件方式)
基本信息
Path: /api/v1/config/openapi/contact/uploadDncDataSource/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | multipart/form-data | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
dataSourceFile | file | 是 | csv文件,GBK编码,只有uuid一列 | |
companyId | text | 否 | 企业id | |
abbreviate | text | 是 | 企业缩写 | |
dataSourceName | text | 是 | 数据源名称 | |
dataSourceType | text | 否 | 数据源类型 1:DNC数据源(默认) | |
token | text | 是 | token |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
调用范例:
- import com.alibaba.fastjson.JSON;
- import org.springframework.core.io.FileSystemResource;
- import org.springframework.http.HttpEntity;
- import org.springframework.http.HttpHeaders;
- import org.springframework.http.MediaType;
- import org.springframework.http.ResponseEntity;
- import org.springframework.util.LinkedMultiValueMap;
- import org.springframework.util.MultiValueMap;
- import org.springframework.web.client.RestTemplate;
- import java.io.File;
- import java.util.Map;
- /**
- * @author yangsl
- * @Description 上传联系人demo
- * @date 2021/6/17
- */
- public class Demo {
- public static void main(String[] args) {
- String url = "https://domain/api/v1/config/openapi/contact/uploadDataSource/v2"; //domain替换成对应环境url
- String filePath = "C:\\Users\\Mac\\Downloads\\template(1).csv";//上传文件的目录
- File file = new File(filePath);
- // 文件必须封装成FileSystemResource这个类型后端才能收到附件
- FileSystemResource resource = new FileSystemResource(file);
- RestTemplate restTemplate = new RestTemplate();
- HttpHeaders headers = new HttpHeaders();
- MultiValueMap<String, Object> map = new LinkedMultiValueMap<>();
- //接口参数 请替换成对应数据
- map.add("abbreviate", "yangsl");
- map.add("dataSourceFile", resource);
- map.add("dataSourceType", 0);
- map.add("dataSourceName", "123456");
- map.add("operationType", "123456");
- map.add("token", "123456");
- //头部类型
- headers.setContentType(MediaType.MULTIPART_FORM_DATA);
- //构造实体对象
- HttpEntity<MultiValueMap<String, Object>> param = new HttpEntity<>(map, headers);
- //发起请求,服务地址,请求参数,返回消息体的数据类型
- ResponseEntity<String> response = restTemplate.postForEntity(url, param, String.class);
- //body
- String body = response.getBody();
- System.out.println(body);
- //JSON格式转为Map类型
- Map result = JSON.parseObject(body, Map.class);
- System.out.println(result);
- }
- }
2.3.3 任务联系人上传(json追加方式)
基本信息
Path: /api/v1/config/openapi/contact/batch/json/upload
Method: POST
接口描述:
请求示例
- {
- "dataSourceName":"数据源名称",
- "dataList":[
- [
- "列1",
- "列2",
- "列3"
- ],
- [
- "列1",
- "列2",
- "列3"
- ]
- ],
- "abbreviate":"yangsl"
- }
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
companyId | integer | 非必须 | 企业id | ||
dataList | array [] | 必须 | 联系人数据 | item 类型: array | |
├─ | 非必须 | 数据行 | |||
├─ | 非必须 | 数据列 | |||
dataSourceName | string | 必须 | 数据源名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.3.4 联系人组字段信息查询
基本信息
Path: /api/v1/config/openapi/contact/contactGroupDetail
Method: GET
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
abbreviate | 是 | 企业缩写 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
msg | string | 必须 | 返回消息 | ||
code | integer | 必须 | 返回码 | ||
data | object [] | 非必须 | 返回结果 | item 类型: object | |
├─ companyId | integer | 非必须 | 企业id | ||
├─ abbreviate | string | 非必须 | 企业缩写 | ||
├─ id | integer | 非必须 | 联系人组id | ||
├─ type | integer | 必须 | 数据源类型 0:datasource数据源, 1:过滤号码数据源 | ||
├─ groupName | string | 非必须 | 联系人组名称 | ||
├─ total | integer | 非必须 | 联系人总数 | ||
├─ utime | integer | 非必须 | 更新时间 | ||
├─ dataSourceName | string | 非必须 | 数据源名称 | ||
├─ customFields | object [] | 非必须 | 联系人组字段列表 | item 类型: object | |
customFields├─ id | integer | 非必须 | 联系人组属性字段id | ||
customFields├─ name | string | 非必须 | 联系人组属性名称 | ||
customFields├─ type1 | integer | 非必须 | 是否必选 | ||
customFields├─ type2 | string | 非必须 | 联系人组类型 | ||
customFields├─ length | integer | 非必须 | 联系人组长度 |
2.3.5 DNC联系人上传(json方式)
基本信息
Path: /api/v1/config/openapi/dataSource/uploadDnc/json
Method: POST
接口描述:
请求示例
{
- "dataSourceName" : "JICHU-DNC" ,
- "dataList" : [
- "1" ,
- "2" ,
- "3"
- ],
- "abbreviate" : "yangsl"
- }
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
dataList | array [] | 必须 | 联系人UUID列表 | item 类型: string | |
dataSourceName | string | 必须 | 数据源名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |