更新短信任务接口
更新时间:2025-11-07
URL
https: /api/v4/console/apitask/smsTask/update
HTTP Method
POST
请求参数
Header
| 参数名称 | 是否必须 | 说明 | 示例 |
|---|---|---|---|
| Content-Type | 是 | application/json | application/json |
| Authorization | 是 | 参考「生成认证Token」文档 | cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33 |
Body
| 参数名称 | 类型 | 是否必须 | 说明 | 示例 | |
|---|---|---|---|---|---|
| taskId | string | 是 | 任务id | 5101673456336896 | |
| taskName | string | 是 | 任务名称 | “呼叫任务123_测试” | |
| isOpenBlackList | boolean | 否 | 是否开启黑名单过滤 | false | |
| dialStartDate | string | 是 | 任务呼叫开始日期 | “2020-10-12” | |
| dialEndDate | string | 否 | 任务呼叫结束日期,如:XXXXX,默认为空,表示不限制终止时间 | “2020-10-12” | |
| dialTimeType | int | 否 | 0:选项型,1:自定义呼叫 | 0 | “09:00” |
| dialTimeInDay | int | 否 | 0:早九晚六,1:早就晚五,2:早十晚六,3:早十晚五 | 0 | “21:00” |
| dialWeeklyInfo | array | 否 | array.size 必须等于 7 对应一周7天按照下标对应星期几示例中拨打策略为周一8:00-12:00,14:00-18:00,周二9:00-17:00,周六7:00-8:00,12:00-13:00,周三到周五、周日传空,不拨打 | [ [["8:00","12:00"],["14:00","18:00"]], [["9:00","17:00"]], [], [], [], [["7:00","8:00"],["12:00","13:00"]], []] | [1,2,3] |
| taskSmsParam | object | 是 | 短信配置相关参数 | { "templateId": "4689722540654592","signatureId": "4689723446624256"} | |
| sendFrequencyLimit | object | 是 | 发送频次相关配置 | // 代表 30 天内 4次{ "enabled" : true, "limitCount": 4, "periodValue": 30, "periodUnit": "DAY"} |
注:任务名称不可重复,格式:支持中英文、数字以及下划线,且不能以下划线开头,不超过40字
响应参数
| 名称 | 类型 | 备注 |
|---|---|---|
| code | int | http响应码,比如200 |
| msg | string | 响应信息,成功为success,失败时为具体原因 |
| data | obj | null |
请求示例
Plain Text
1{
2 "taskId": "5101673456336896",
3 "taskName": "开放接口测试",
4 "isOpenBlackList": true, // 黑名单开关
5 "taskSmsParam": { // 短信参数
6 "templateId": 4689722540654592, // 短信模板 id
7 "signatureId": 4689723446624256 // 短信签名 id
8 },
9 "sendFrequencyLimit": { // 发送频次限制
10 "enabled" : true,
11 "limitCount": 21, // 代表 30 天内 4次
12 "periodValue": 28, // 周期
13 "periodUnit": "DAY"
14 },
15 "numTypeFilterList": [ // 号码过滤的策略,和之前一样 400 啥的
16 1,
17 2,
18 5,
19 6,
20 7
21 ],
22 "isOpenRepeatFilter": 1, // 重复过滤开关
23 "isOpenNumTypeFilter": true, // 开启号码类型过滤
24 "numFilterTotalFlag": true, // 号码过滤大开关
25 "taskRobotType": 2, // 短信任务必须传递
26 "dialTimeType": 0, // 时间和外呼一致
27 "dialTimeInDay": 0, // 时间和外呼一致
28 "dialDayInWeek": 0, // 时间和外呼一致
29 "dialNoonBreak": 2, // 时间和外呼一致
30 "dialWeeklyInfo": [ // 时间和外呼一致
31 [
32 [
33 "00:00",
34 "23:30"
35 ]
36 ],
37 [
38 [
39 "00:00",
40 "23:30"
41 ]
42 ],
43 [
44 [
45 "00:00",
46 "23:30"
47 ]
48 ],
49 [
50 [
51 "00:00",
52 "23:30"
53 ]
54 ],
55 [
56 [
57 "00:00",
58 "23:30"
59 ]
60 ],
61 [
62 [
63 "00:00",
64 "23:30"
65 ]
66 ],
67 [
68 [
69 "00:00",
70 "23:30"
71 ]
72 ]
73 ],
74 "dialStartDate": "2025-10-26", // 时间和外呼一致
75 "dialEndDate": "2025-10-27" // 时间和外呼一致
76}
返回结果
Plain Text
1{
2 "code": 200,
3 "msg": "success",
4 "data": {
5 "taskId": "731346584781056" //任务ID
6 }
7}
