tencentcloud-sdk-nodejs 4.1.48 → 4.1.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/cynosdb/v20190107/cynosdb_client.js +22 -4
  3. package/es/services/mqtt/v20240516/mqtt_client.js +5 -2
  4. package/es/services/ses/v20201002/ses_client.js +12 -3
  5. package/package.json +1 -1
  6. package/tencentcloud/common/sdk_version.d.ts +1 -1
  7. package/tencentcloud/common/sdk_version.js +1 -1
  8. package/tencentcloud/services/as/v20180419/as_models.d.ts +2 -2
  9. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +5 -3
  10. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +2 -2
  11. package/tencentcloud/services/cfs/v20190719/cfs_client.js +2 -2
  12. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +38 -51
  13. package/tencentcloud/services/cloudaudit/v20190319/cloudaudit_models.d.ts +0 -2
  14. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +1 -1
  15. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +12 -10
  16. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +29 -5
  17. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +42 -6
  18. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +449 -180
  19. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +6 -2
  20. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -2
  21. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +3 -1
  22. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +3 -1
  23. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +1 -1
  24. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +1 -0
  25. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +5 -0
  26. package/tencentcloud/services/lkeap/v20240522/lkeap_client.js +5 -0
  27. package/tencentcloud/services/mqtt/v20240516/mqtt_client.d.ts +10 -6
  28. package/tencentcloud/services/mqtt/v20240516/mqtt_client.js +12 -6
  29. package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts +195 -101
  30. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +26 -1
  31. package/tencentcloud/services/ocr/v20181119/ocr_client.js +25 -0
  32. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +193 -90
  33. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +17 -5
  34. package/tencentcloud/services/ses/v20201002/ses_client.js +24 -6
  35. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +858 -788
  36. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +3 -3
  37. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +2 -1
@@ -1,422 +1,423 @@
1
1
  /**
2
- * BatchSendEmail请求参数结构体
2
+ * 发送任务数据
3
3
  */
4
- export interface BatchSendEmailRequest {
4
+ export interface SendTaskData {
5
5
  /**
6
- * 发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
7
- 发信人 <邮件地址> 的方式填写,例如:
8
- 腾讯云团队 <noreply@mail.qcloud.com>
6
+ * 任务id
9
7
  */
10
- FromEmailAddress: string;
8
+ TaskId?: number;
11
9
  /**
12
- * 收件人列表ID
10
+ * 发信地址
13
11
  */
14
- ReceiverId: number;
12
+ FromEmailAddress?: string;
15
13
  /**
16
- * 邮件主题
14
+ * 收件人列表Id
17
15
  */
18
- Subject: string;
16
+ ReceiverId?: number;
19
17
  /**
20
- * 任务类型 1: 立即发送 2: 定时发送 3: 周期(频率)发送
18
+ * 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成
21
19
  */
22
- TaskType: number;
20
+ TaskStatus?: number;
23
21
  /**
24
- * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
22
+ * 任务类型 1 即时 2 定时 3 周期
25
23
  */
26
- ReplyToAddresses?: string;
24
+ TaskType?: number;
27
25
  /**
28
- * 使用模板发送时,填写的模板相关参数
29
- <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置,则该字段为必填 </dx-alert>
26
+ * 任务请求发信数量
30
27
  */
31
- Template?: Template;
28
+ RequestCount?: number;
32
29
  /**
33
- * 已废弃<dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。</dx-alert>
30
+ * 已经发送数量
34
31
  */
35
- Simple?: Simple;
32
+ SendCount?: number;
36
33
  /**
37
- * 需要发送附件时,填写附件相关参数(暂未支持)
34
+ * 缓存数量
38
35
  */
39
- Attachments?: Array<Attachment>;
36
+ CacheCount?: number;
40
37
  /**
41
- * 周期发送任务的必要参数
38
+ * 任务创建时间
39
+ */
40
+ CreateTime?: string;
41
+ /**
42
+ * 任务更新时间
43
+ */
44
+ UpdateTime?: string;
45
+ /**
46
+ * 邮件主题
47
+ */
48
+ Subject?: string;
49
+ /**
50
+ * 模板和模板数据
51
+ 注意:此字段可能返回 null,表示取不到有效值。
52
+ */
53
+ Template?: Template;
54
+ /**
55
+ * 周期任务参数
56
+ 注意:此字段可能返回 null,表示取不到有效值。
42
57
  */
43
58
  CycleParam?: CycleEmailParam;
44
59
  /**
45
- * 定时发送任务的必要参数
60
+ * 定时任务参数
61
+ 注意:此字段可能返回 null,表示取不到有效值。
46
62
  */
47
63
  TimedParam?: TimedEmailParam;
48
64
  /**
49
- * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
65
+ * 任务异常信息
66
+ 注意:此字段可能返回 null,表示取不到有效值。
50
67
  */
51
- Unsubscribe?: string;
68
+ ErrMsg?: string;
52
69
  /**
53
- * 是否添加广告标识 0:不添加 1:添加到subject前面,2:添加到subject后面
70
+ * 收件人列表名称
54
71
  */
55
- ADLocation?: number;
72
+ ReceiversName?: string;
56
73
  }
57
74
  /**
58
- * GetEmailTemplate请求参数结构体
75
+ * 模板发送相关信息,包含模板ID,模板变量参数等信息
59
76
  */
60
- export interface GetEmailTemplateRequest {
77
+ export interface Template {
61
78
  /**
62
- * 模板ID
79
+ * 模板ID。如果没有模板,请先新建一个
63
80
  */
64
81
  TemplateID: number;
82
+ /**
83
+ * 模板中的变量参数,请使用json.dump将json对象格式化为string类型。该对象是一组键值对,每个Key代表模板中的一个变量,模板中的变量使用{{键}}表示,相应的值在发送时会被替换为{{值}}。
84
+ 注意:参数值不能是html等复杂类型的数据。
85
+ 示例:{"name":"xxx","age":"xx"}
86
+ */
87
+ TemplateData: string;
65
88
  }
66
89
  /**
67
- * ListSendTasks返回参数结构体
90
+ * ListAddressUnsubscribeConfig请求参数结构体
68
91
  */
69
- export interface ListSendTasksResponse {
70
- /**
71
- * 总数
72
- */
73
- TotalCount?: number;
92
+ export interface ListAddressUnsubscribeConfigRequest {
74
93
  /**
75
- * 数据记录
94
+ * 偏移量
76
95
  */
77
- Data?: Array<SendTaskData>;
96
+ Offset?: number;
78
97
  /**
79
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
98
+ * 拉取最大条数,不超过100
80
99
  */
81
- RequestId?: string;
100
+ Limit?: string;
82
101
  }
83
102
  /**
84
- * CreateReceiver返回参数结构体
103
+ * 用于描述发件人相关信息
85
104
  */
86
- export interface CreateReceiverResponse {
105
+ export interface EmailSender {
87
106
  /**
88
- * 收件人列表id,后续根据收件人列表id上传收件人地址
107
+ * 发信地址
89
108
  */
90
- ReceiverId?: number;
109
+ EmailAddress?: string;
91
110
  /**
92
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
111
+ * 发信人别名
93
112
  */
94
- RequestId?: string;
95
- }
96
- /**
97
- * CreateCustomBlacklist请求参数结构体
98
- */
99
- export interface CreateCustomBlacklistRequest {
113
+ EmailSenderName?: string;
100
114
  /**
101
- * 添加到黑名单的邮件地址
115
+ * 创建时间
102
116
  */
103
- Emails: Array<string>;
117
+ CreatedTimestamp?: number;
104
118
  /**
105
- * 过期日期
119
+ * smtp密码类型,0=没有设置密码,1=已经设置了密码
106
120
  */
107
- ExpireDate?: string;
121
+ SmtpPwdType?: number;
108
122
  }
109
123
  /**
110
- * ListEmailAddress返回参数结构体
124
+ * BatchSendEmail返回参数结构体
111
125
  */
112
- export interface ListEmailAddressResponse {
126
+ export interface BatchSendEmailResponse {
113
127
  /**
114
- * 发信地址列表详情
128
+ * 发送任务ID
115
129
  */
116
- EmailSenders?: Array<EmailSender>;
130
+ TaskId?: number;
117
131
  /**
118
132
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
119
133
  */
120
134
  RequestId?: string;
121
135
  }
122
136
  /**
123
- * ListEmailAddress请求参数结构体
137
+ * DeleteEmailIdentity请求参数结构体
124
138
  */
125
- export declare type ListEmailAddressRequest = null;
139
+ export interface DeleteEmailIdentityRequest {
140
+ /**
141
+ * 发信域名
142
+ */
143
+ EmailIdentity: string;
144
+ }
126
145
  /**
127
- * UpdateCustomBlackList返回参数结构体
146
+ * CreateCustomBlacklist返回参数结构体
128
147
  */
129
- export interface UpdateCustomBlackListResponse {
148
+ export interface CreateCustomBlacklistResponse {
149
+ /**
150
+ * 收件人总数
151
+ */
152
+ TotalCount?: number;
153
+ /**
154
+ * 实际上传数量
155
+ */
156
+ ValidCount?: number;
157
+ /**
158
+ * 数据过长数量
159
+ */
160
+ TooLongCount?: number;
161
+ /**
162
+ * 重复数量
163
+ */
164
+ RepeatCount?: number;
165
+ /**
166
+ * 格式不正确数量
167
+ */
168
+ InvalidCount?: number;
130
169
  /**
131
170
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
132
171
  */
133
172
  RequestId?: string;
134
173
  }
135
174
  /**
136
- * UpdateEmailSmtpPassWord返回参数结构体
175
+ * UpdateAddressUnsubscribeConfig返回参数结构体
137
176
  */
138
- export interface UpdateEmailSmtpPassWordResponse {
177
+ export interface UpdateAddressUnsubscribeConfigResponse {
139
178
  /**
140
179
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
141
180
  */
142
181
  RequestId?: string;
143
182
  }
144
183
  /**
145
- * ListReceivers请求参数结构体
184
+ * CreateReceiver请求参数结构体
146
185
  */
147
- export interface ListReceiversRequest {
186
+ export interface CreateReceiverRequest {
148
187
  /**
149
- * 偏移量,整型,从0开始
188
+ * 收件人列表名称
150
189
  */
151
- Offset: number;
190
+ ReceiversName: string;
152
191
  /**
153
- * 限制数目,整型,不超过100
192
+ * 收件人列表描述
154
193
  */
155
- Limit: number;
194
+ Desc?: string;
195
+ }
196
+ /**
197
+ * 模板内容,TEXT和HTML必须至少存在一项,建议使用TEXT和HTML的组合
198
+ */
199
+ export interface TemplateContent {
156
200
  /**
157
- * 列表状态(1 待上传 2 上传中 3传完成),若查询所有就不传这个字段
201
+ * base64之后的Html代码
158
202
  */
159
- Status?: number;
203
+ Html?: string;
160
204
  /**
161
- * 列表名称的关键字,模糊查询
205
+ * base64之后的文本内容
162
206
  */
163
- KeyWord?: string;
207
+ Text?: string;
164
208
  }
165
209
  /**
166
- * GetEmailIdentity返回参数结构体
210
+ * 邮箱黑名单结构,包含被拉黑的邮箱地址和被拉黑时间,以及被拉黑的理由
167
211
  */
168
- export interface GetEmailIdentityResponse {
169
- /**
170
- * 验证类型。固定值:DOMAIN
171
- */
172
- IdentityType?: string;
212
+ export interface BlackEmailAddress {
173
213
  /**
174
- * 是否已通过验证
214
+ * 邮箱被拉黑时间
175
215
  */
176
- VerifiedForSendingStatus?: boolean;
216
+ BounceTime?: string;
177
217
  /**
178
- * DNS配置详情
218
+ * 被拉黑的邮箱地址
179
219
  */
180
- Attributes?: Array<DNSAttributes>;
220
+ EmailAddress?: string;
181
221
  /**
182
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
222
+ * 被拉黑的理由
183
223
  */
184
- RequestId?: string;
224
+ IspDesc?: string;
185
225
  }
186
226
  /**
187
- * ListBlackEmailAddress请求参数结构体
227
+ * 邮件发送的内容,可以是纯文本(TEXT),也可以是纯代码(HTML),或者纯文本+HTML的组合(建议方式)
188
228
  */
189
- export interface ListBlackEmailAddressRequest {
229
+ export interface Simple {
190
230
  /**
191
- * 开始日期,格式为YYYY-MM-DD
231
+ * base64之后的Html代码。需要包含所有的代码信息,不要包含外部css,否则会导致显示格式错乱
192
232
  */
193
- StartDate: string;
233
+ Html?: string;
194
234
  /**
195
- * 结束日期,格式为YYYY-MM-DD
235
+ * base64之后的纯文本信息,如果没有Html,邮件中会直接显示纯文本;如果有Html,它代表邮件的纯文本样式
196
236
  */
197
- EndDate: string;
237
+ Text?: string;
238
+ }
239
+ /**
240
+ * CreateEmailAddress请求参数结构体
241
+ */
242
+ export interface CreateEmailAddressRequest {
198
243
  /**
199
- * 规范,配合Offset使用
244
+ * 您的发信地址(发信地址总数上限为10个)
200
245
  */
201
- Limit: number;
246
+ EmailAddress: string;
202
247
  /**
203
- * 规范,配合Limit使用,Limit最大取值为100
248
+ * 发件人别名
204
249
  */
205
- Offset: number;
250
+ EmailSenderName?: string;
251
+ }
252
+ /**
253
+ * CreateReceiverDetail请求参数结构体
254
+ */
255
+ export interface CreateReceiverDetailRequest {
206
256
  /**
207
- * 可以指定邮箱进行查询
257
+ * 收件人列表ID
208
258
  */
209
- EmailAddress?: string;
259
+ ReceiverId: number;
210
260
  /**
211
- * 已废弃
261
+ * 邮箱
212
262
  */
213
- TaskID?: string;
263
+ Emails: Array<string>;
214
264
  }
215
265
  /**
216
- * 附件结构,包含附件名和base64之后的附件内容。
266
+ * UpdateEmailTemplate返回参数结构体
217
267
  */
218
- export interface Attachment {
268
+ export interface UpdateEmailTemplateResponse {
219
269
  /**
220
- * 附件名称,最大支持255个字符长度,不支持部分附件类型,详情请参考[附件类型](https://cloud.tencent.com/document/product/1288/51951)
270
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
221
271
  */
222
- FileName: string;
272
+ RequestId?: string;
273
+ }
274
+ /**
275
+ * CreateReceiverDetailWithData请求参数结构体
276
+ */
277
+ export interface CreateReceiverDetailWithDataRequest {
223
278
  /**
224
- * Base64之后的附件内容,您可以发送的附件大小上限为4M。注意:腾讯云接口请求最大支持 8M 的请求包,附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内,整体请求超出 8M 接口会返回错误。
279
+ * 收件人列表ID
225
280
  */
226
- Content?: string;
281
+ ReceiverId: number;
227
282
  /**
228
- * 附件URL。未开放功能,请勿使用。
283
+ * 收信人邮箱以及模板参数,数组形式。收件人个数限制20000个以内。
229
284
  */
230
- FileURL?: string;
285
+ Datas: Array<ReceiverInputData>;
231
286
  }
232
287
  /**
233
- * 模板发送相关信息,包含模板ID,模板变量参数等信息
288
+ * 创建定时发送邮件任务时,设置的定时参数,比如开始时间之类
234
289
  */
235
- export interface Template {
236
- /**
237
- * 模板ID。如果没有模板,请先新建一个
238
- */
239
- TemplateID: number;
290
+ export interface TimedEmailParam {
240
291
  /**
241
- * 模板中的变量参数,请使用json.dump将json对象格式化为string类型。该对象是一组键值对,每个Key代表模板中的一个变量,模板中的变量使用{{键}}表示,相应的值在发送时会被替换为{{值}}。
242
- 注意:参数值不能是html等复杂类型的数据。
243
- 示例:{"name":"xxx","age":"xx"}
292
+ * 定时发送邮件的开始时间
244
293
  */
245
- TemplateData: string;
294
+ BeginTime: string;
246
295
  }
247
296
  /**
248
- * ListSendTasks请求参数结构体
297
+ * 用于描述DNS记录的域名、记录类型、期望得到的值、目前配置的值
249
298
  */
250
- export interface ListSendTasksRequest {
299
+ export interface DNSAttributes {
251
300
  /**
252
- * 偏移量,整型,从0开始,0代表跳过0行
301
+ * 记录类型 CNAME | A | TXT | MX
253
302
  */
254
- Offset: number;
303
+ Type?: string;
255
304
  /**
256
- * 限制数目,整型,不超过100
305
+ * 域名
257
306
  */
258
- Limit: number;
307
+ SendDomain?: string;
259
308
  /**
260
- * 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成。查询所有状态,则不传这个字段
309
+ * 需要配置的值
261
310
  */
262
- Status?: number;
311
+ ExpectedValue?: string;
263
312
  /**
264
- * 收件人列表ID
313
+ * 腾讯云目前检测到的值
265
314
  */
266
- ReceiverId?: number;
315
+ CurrentValue?: string;
267
316
  /**
268
- * 任务类型 1即时 2定时 3周期,查询所有类型则不传这个字段
317
+ * 检测是否通过,创建时默认为false
269
318
  */
270
- TaskType?: number;
319
+ Status?: boolean;
271
320
  }
272
321
  /**
273
- * ListAddressUnsubscribeConfig返回参数结构体
322
+ * GetEmailTemplate返回参数结构体
274
323
  */
275
- export interface ListAddressUnsubscribeConfigResponse {
276
- /**
277
- * 地址级退订配置
278
- */
279
- AddressUnsubscribeConfigList?: Array<AddressUnsubscribeConfigData>;
324
+ export interface GetEmailTemplateResponse {
280
325
  /**
281
- * 总数
326
+ * 模板内容数据
282
327
  */
283
- Total?: number;
328
+ TemplateContent: TemplateContent;
284
329
  /**
285
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
330
+ * 模板状态 0-审核通过 1-待审核 2-审核拒绝
286
331
  */
287
- RequestId?: string;
288
- }
289
- /**
290
- * GetSendEmailStatus返回参数结构体
291
- */
292
- export interface GetSendEmailStatusResponse {
332
+ TemplateStatus: number;
293
333
  /**
294
- * 邮件发送状态列表
334
+ * 模板名称
295
335
  */
296
- EmailStatusList?: Array<SendEmailStatus>;
336
+ TemplateName: string;
297
337
  /**
298
338
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
299
339
  */
300
340
  RequestId?: string;
301
341
  }
302
342
  /**
303
- * 模板列表结构
343
+ * ListAddressUnsubscribeConfig返回参数结构体
304
344
  */
305
- export interface TemplatesMetadata {
306
- /**
307
- * 创建时间
308
- */
309
- CreatedTimestamp?: number;
310
- /**
311
- * 模板名称
312
- */
313
- TemplateName?: string;
345
+ export interface ListAddressUnsubscribeConfigResponse {
314
346
  /**
315
- * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
347
+ * 地址级退订配置
316
348
  */
317
- TemplateStatus?: number;
349
+ AddressUnsubscribeConfigList?: Array<AddressUnsubscribeConfigData>;
318
350
  /**
319
- * 模板ID
351
+ * 总数
320
352
  */
321
- TemplateID?: number;
353
+ Total?: number;
322
354
  /**
323
- * 审核原因
355
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
324
356
  */
325
- ReviewReason?: string;
357
+ RequestId?: string;
326
358
  }
327
359
  /**
328
- * 收件人列表详情
360
+ * SendEmail请求参数结构体
329
361
  */
330
- export interface ReceiverDetail {
331
- /**
332
- * 收件人地址
333
- */
334
- Email?: string;
335
- /**
336
- * 创建时间
337
- */
338
- CreateTime?: string;
362
+ export interface SendEmailRequest {
339
363
  /**
340
- * 模板参数
364
+ * 发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址,例如:noreply@mail.qcloud.com如需填写发件人别名时,请按照如下方式(注意别名与邮箱地址之间必须使用一个空格隔开):别名+一个空格+<邮箱地址>,别名中不能带有冒号(:)。
341
365
  */
342
- TemplateData?: string;
366
+ FromEmailAddress: string;
343
367
  /**
344
- * 无效原因
368
+ * 收信人邮箱地址,最多支持群发50人。注意:邮件内容会显示所有收件人地址,非群发邮件请多次调用API发送。
345
369
  */
346
- Reason?: string;
370
+ Destination: Array<string>;
347
371
  /**
348
- * 1:有效,2:无效
372
+ * 邮件主题
349
373
  */
350
- Status?: number;
374
+ Subject: string;
351
375
  /**
352
- * 收件人地址id
376
+ * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
353
377
  */
354
- EmailId?: number;
355
- }
356
- /**
357
- * DeleteBlackList请求参数结构体
358
- */
359
- export interface DeleteBlackListRequest {
378
+ ReplyToAddresses?: string;
360
379
  /**
361
- * 需要清除的黑名单邮箱列表,数组长度至少为1
380
+ * 抄送人邮箱地址,最多支持抄送20人。
362
381
  */
363
- EmailAddressList: Array<string>;
364
- }
365
- /**
366
- * 用于描述发件人相关信息
367
- */
368
- export interface EmailSender {
382
+ Cc?: Array<string>;
369
383
  /**
370
- * 发信地址
384
+ * 密送人邮箱地址,最多支持抄送20人,Bcc和Destination不能重复。
371
385
  */
372
- EmailAddress?: string;
386
+ Bcc?: Array<string>;
373
387
  /**
374
- * 发信人别名
388
+ * 使用模板发送时,填写模板相关参数。
389
+ <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置,则该字段为必填 </dx-alert>
375
390
  */
376
- EmailSenderName?: string;
391
+ Template?: Template;
377
392
  /**
378
- * 创建时间
393
+ * 已废弃
394
+ <dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。</dx-alert>
379
395
  */
380
- CreatedTimestamp?: number;
396
+ Simple?: Simple;
381
397
  /**
382
- * smtp密码类型,0=没有设置密码,1=已经设置了密码
398
+ * 需要发送附件时,填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包,附件内容经过 Base64 预期扩大1.5倍,应该控制所有附件的总大小最大在 4M 以内,整体请求超出 8M 时接口会返回错误
383
399
  */
384
- SmtpPwdType?: number;
385
- }
386
- /**
387
- * BatchSendEmail返回参数结构体
388
- */
389
- export interface BatchSendEmailResponse {
400
+ Attachments?: Array<Attachment>;
390
401
  /**
391
- * 发送任务ID
402
+ * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
392
403
  */
393
- TaskId?: number;
404
+ Unsubscribe?: string;
394
405
  /**
395
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
406
+ * 邮件触发类型 0:非触发类,默认类型,营销类邮件、非即时类邮件等选择此类型 1:触发类,验证码等即时发送类邮件,若邮件超过一定大小,系统会自动选择非触发类型通道
396
407
  */
397
- RequestId?: string;
398
- }
399
- /**
400
- * DeleteEmailIdentity请求参数结构体
401
- */
402
- export interface DeleteEmailIdentityRequest {
408
+ TriggerType?: number;
403
409
  /**
404
- * 发信域名
410
+ * smtp头中的Message-Id字段
405
411
  */
406
- EmailIdentity: string;
407
- }
408
- /**
409
- * ListAddressUnsubscribeConfig请求参数结构体
410
- */
411
- export interface ListAddressUnsubscribeConfigRequest {
412
+ SmtpMessageId?: string;
412
413
  /**
413
- * 偏移量
414
+ * smtp头中可以设置的其它字段
414
415
  */
415
- Offset?: number;
416
+ SmtpHeaders?: string;
416
417
  /**
417
- * 拉取最大条数,不超过100
418
+ * smtp头中的from字段,建议域名与FromEmailAddress保持一致
418
419
  */
419
- Limit?: string;
420
+ HeaderFrom?: string;
420
421
  }
421
422
  /**
422
423
  * UpdateEmailIdentity请求参数结构体
@@ -428,188 +429,233 @@ export interface UpdateEmailIdentityRequest {
428
429
  EmailIdentity: string;
429
430
  }
430
431
  /**
431
- * GetEmailIdentity请求参数结构体
432
+ * DeleteEmailIdentity返回参数结构体
432
433
  */
433
- export interface GetEmailIdentityRequest {
434
+ export interface DeleteEmailIdentityResponse {
434
435
  /**
435
- * 发信域名
436
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
436
437
  */
437
- EmailIdentity: string;
438
+ RequestId?: string;
438
439
  }
439
440
  /**
440
- * DeleteEmailIdentity返回参数结构体
441
+ * DeleteEmailTemplate返回参数结构体
441
442
  */
442
- export interface DeleteEmailIdentityResponse {
443
+ export interface DeleteEmailTemplateResponse {
443
444
  /**
444
445
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
445
446
  */
446
447
  RequestId?: string;
447
448
  }
448
449
  /**
449
- * GetStatisticsReport请求参数结构体
450
+ * ListCustomBlacklist请求参数结构体
450
451
  */
451
- export interface GetStatisticsReportRequest {
452
+ export interface ListCustomBlacklistRequest {
452
453
  /**
453
- * 开始日期
454
+ * 偏移量,整型,从0开始
454
455
  */
455
- StartDate: string;
456
+ Offset: number;
456
457
  /**
457
- * 结束日期
458
+ * 限制数目,整型,不超过100
458
459
  */
459
- EndDate: string;
460
+ Limit: number;
460
461
  /**
461
- * 发信域名
462
+ * 筛选黑名单的状态,0:已过期,1:生效中, 2:全部
462
463
  */
463
- Domain?: string;
464
+ Status: number;
464
465
  /**
465
- * 收件方邮箱类型,例如gmail.com
466
+ * 黑名单中的邮箱地址
466
467
  */
467
- ReceivingMailboxType?: string;
468
+ Email?: string;
468
469
  }
469
470
  /**
470
- * CreateCustomBlacklist返回参数结构体
471
+ * DeleteEmailTemplate请求参数结构体
471
472
  */
472
- export interface CreateCustomBlacklistResponse {
473
+ export interface DeleteEmailTemplateRequest {
473
474
  /**
474
- * 收件人总数
475
+ * 模板ID
475
476
  */
476
- TotalCount?: number;
477
+ TemplateID: number;
478
+ }
479
+ /**
480
+ * 描述邮件发送状态
481
+ */
482
+ export interface SendEmailStatus {
477
483
  /**
478
- * 实际上传数量
484
+ * SendEmail返回的MessageId
479
485
  */
480
- ValidCount?: number;
486
+ MessageId?: string;
481
487
  /**
482
- * 数据过长数量
488
+ * 收件人邮箱
483
489
  */
484
- TooLongCount?: number;
490
+ ToEmailAddress?: string;
485
491
  /**
486
- * 重复数量
492
+ * 发件人邮箱
487
493
  */
488
- RepeatCount?: number;
494
+ FromEmailAddress?: string;
489
495
  /**
490
- * 格式不正确数量
491
- */
492
- InvalidCount?: number;
496
+ * 腾讯云处理状态
497
+ 0: 处理成功
498
+ 1001: 内部系统异常
499
+ 1002: 内部系统异常
500
+ 1003: 内部系统异常
501
+ 1003: 内部系统异常
502
+ 1004: 发信超时
503
+ 1005: 内部系统异常
504
+ 1006: 触发频率控制,短时间内对同一地址发送过多邮件
505
+ 1007: 邮件地址在黑名单中
506
+ 1008: 域名被收件人拒收
507
+ 1009: 内部系统异常
508
+ 1010: 超出了每日发送限制
509
+ 1011: 无发送自定义内容权限,必须使用模板
510
+ 1013: 域名被收件人取消订阅
511
+ 2001: 找不到相关记录
512
+ 3007: 模板ID无效或者不可用
513
+ 3008: 被收信域名临时封禁
514
+ 3009: 无权限使用该模板
515
+ 3010: TemplateData字段格式不正确
516
+ 3014: 发件域名没有经过认证,无法发送
517
+ 3020: 收件方邮箱类型在黑名单
518
+ 3024: 邮箱地址格式预检查失败
519
+ 3030: 退信率过高,临时限制发送
520
+ 3033: 余额不足,账号欠费等
521
+ */
522
+ SendStatus?: number;
493
523
  /**
494
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
524
+ * 收件方处理状态
525
+ 0: 请求成功被腾讯云接受,进入发送队列
526
+ 1: 邮件递送成功,DeliverTime表示递送成功的时间
527
+ 2: 邮件因某种原因被丢弃,DeliverMessage表示丢弃原因
528
+ 3: 收件方ESP拒信,一般原因为邮箱地址不存在,或其它原因
529
+ 8: 邮件被ESP因某些原因延迟递送,DeliverMessage表示延迟原因
495
530
  */
496
- RequestId?: string;
497
- }
498
- /**
499
- * CreateReceiver请求参数结构体
500
- */
501
- export interface CreateReceiverRequest {
531
+ DeliverStatus?: number;
502
532
  /**
503
- * 收件人列表名称
533
+ * 收件方处理状态描述
504
534
  */
505
- ReceiversName: string;
535
+ DeliverMessage?: string;
506
536
  /**
507
- * 收件人列表描述
537
+ * 请求到达腾讯云时间戳
508
538
  */
509
- Desc?: string;
510
- }
511
- /**
512
- * 发送任务数据
513
- */
514
- export interface SendTaskData {
539
+ RequestTime?: number;
515
540
  /**
516
- * 任务id
541
+ * 腾讯云执行递送时间戳
517
542
  */
518
- TaskId?: number;
543
+ DeliverTime?: number;
519
544
  /**
520
- * 发信地址
545
+ * 用户是否打开该邮件
521
546
  */
522
- FromEmailAddress?: string;
547
+ UserOpened?: boolean;
523
548
  /**
524
- * 收件人列表Id
549
+ * 用户是否点击该邮件中的链接
525
550
  */
526
- ReceiverId?: number;
551
+ UserClicked?: boolean;
527
552
  /**
528
- * 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成
553
+ * 用户是否取消该发送者的订阅
529
554
  */
530
- TaskStatus?: number;
555
+ UserUnsubscribed?: boolean;
531
556
  /**
532
- * 任务类型 1 即时 2 定时 3 周期
557
+ * 用户是否举报该发送者
533
558
  */
534
- TaskType?: number;
559
+ UserComplainted?: boolean;
560
+ }
561
+ /**
562
+ * ListEmailTemplates请求参数结构体
563
+ */
564
+ export interface ListEmailTemplatesRequest {
535
565
  /**
536
- * 任务请求发信数量
566
+ * 获取模板数据量,用于分页
537
567
  */
538
- RequestCount?: number;
568
+ Limit: number;
539
569
  /**
540
- * 已经发送数量
570
+ * 获取模板偏移值,用于分页
541
571
  */
542
- SendCount?: number;
572
+ Offset: number;
573
+ }
574
+ /**
575
+ * DeleteBlackList请求参数结构体
576
+ */
577
+ export interface DeleteBlackListRequest {
543
578
  /**
544
- * 缓存数量
579
+ * 需要清除的黑名单邮箱列表,数组长度至少为1
545
580
  */
546
- CacheCount?: number;
581
+ EmailAddressList: Array<string>;
582
+ }
583
+ /**
584
+ * 收件人明细输入参数,包含收件人邮箱,以及模板参数
585
+ */
586
+ export interface ReceiverInputData {
547
587
  /**
548
- * 任务创建时间
588
+ * 收件人邮箱
549
589
  */
550
- CreateTime?: string;
590
+ Email: string;
551
591
  /**
552
- * 任务更新时间
592
+ * 模板中的变量参数,请使用json.dump将json对象格式化为string类型。该对象是一组键值对,每个Key代表模板中的一个变量,模板中的变量使用{{键}}表示,相应的值在发送时会被替换为{{值}}。
593
+ 注意:参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。
553
594
  */
554
- UpdateTime?: string;
595
+ TemplateData: string;
596
+ }
597
+ /**
598
+ * 收件人列表详情
599
+ */
600
+ export interface ReceiverDetail {
555
601
  /**
556
- * 邮件主题
602
+ * 收件人地址
557
603
  */
558
- Subject?: string;
604
+ Email?: string;
559
605
  /**
560
- * 模板和模板数据
561
- 注意:此字段可能返回 null,表示取不到有效值。
606
+ * 创建时间
562
607
  */
563
- Template?: Template;
608
+ CreateTime?: string;
564
609
  /**
565
- * 周期任务参数
566
- 注意:此字段可能返回 null,表示取不到有效值。
610
+ * 模板参数
567
611
  */
568
- CycleParam?: CycleEmailParam;
612
+ TemplateData?: string;
569
613
  /**
570
- * 定时任务参数
571
- 注意:此字段可能返回 null,表示取不到有效值。
614
+ * 无效原因
572
615
  */
573
- TimedParam?: TimedEmailParam;
616
+ Reason?: string;
574
617
  /**
575
- * 任务异常信息
576
- 注意:此字段可能返回 null,表示取不到有效值。
618
+ * 1:有效,2:无效
577
619
  */
578
- ErrMsg?: string;
620
+ Status?: number;
579
621
  /**
580
- * 收件人列表名称
622
+ * 收件人地址id
581
623
  */
582
- ReceiversName?: string;
624
+ EmailId?: number;
583
625
  }
584
626
  /**
585
- * ListReceiverDetails返回参数结构体
627
+ * ListBlackEmailAddress返回参数结构体
586
628
  */
587
- export interface ListReceiverDetailsResponse {
588
- /**
589
- * 总数
590
- */
591
- TotalCount?: number;
592
- /**
593
- * 数据记录
594
- */
595
- Data?: Array<ReceiverDetail>;
629
+ export interface ListBlackEmailAddressResponse {
596
630
  /**
597
- * 有效邮件地址数
631
+ * 黑名单列表
598
632
  */
599
- ValidCount?: number;
633
+ BlackList?: Array<BlackEmailAddress>;
600
634
  /**
601
- * 无效邮件地址数
635
+ * 黑名单总数
602
636
  */
603
- InvalidCount?: number;
637
+ TotalCount?: number;
604
638
  /**
605
639
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
606
640
  */
607
641
  RequestId?: string;
608
642
  }
609
643
  /**
610
- * DeleteEmailTemplate返回参数结构体
644
+ * ListEmailIdentities返回参数结构体
611
645
  */
612
- export interface DeleteEmailTemplateResponse {
646
+ export interface ListEmailIdentitiesResponse {
647
+ /**
648
+ * 发信域名列表
649
+ */
650
+ EmailIdentities: Array<EmailIdentity>;
651
+ /**
652
+ * 最大信誉等级
653
+ */
654
+ MaxReputationLevel: number;
655
+ /**
656
+ * 单域名最高日发送量
657
+ */
658
+ MaxDailyQuota: number;
613
659
  /**
614
660
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
615
661
  */
@@ -633,106 +679,95 @@ export interface UpdateCustomBlackListRequest {
633
679
  ExpireDate?: string;
634
680
  }
635
681
  /**
636
- * 地址级退订配置
682
+ * UpdateEmailSmtpPassWord请求参数结构体
637
683
  */
638
- export interface AddressUnsubscribeConfigData {
639
- /**
640
- * 发信地址
641
- */
642
- Address?: string;
684
+ export interface UpdateEmailSmtpPassWordRequest {
643
685
  /**
644
- * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
686
+ * smtp密码,长度限制64
645
687
  */
646
- UnsubscribeConfig?: string;
688
+ Password: string;
647
689
  /**
648
- * 0:关闭,1:开启
690
+ * 发信邮箱,长度限制128
649
691
  */
650
- Status?: number;
692
+ EmailAddress: string;
651
693
  }
652
694
  /**
653
- * CreateEmailIdentity请求参数结构体
695
+ * DeleteCustomBlackList请求参数结构体
654
696
  */
655
- export interface CreateEmailIdentityRequest {
656
- /**
657
- * 您的发信域名,建议使用三级以上域名。例如:mail.qcloud.com。
658
- */
659
- EmailIdentity: string;
697
+ export interface DeleteCustomBlackListRequest {
660
698
  /**
661
- * 生成的dkim密钥长度。0:1024,1:2048
699
+ * 需要删除的邮箱地址
662
700
  */
663
- DKIMOption?: number;
701
+ Emails: Array<string>;
664
702
  }
665
703
  /**
666
- * ListCustomBlacklist请求参数结构体
704
+ * UpdateAddressUnsubscribeConfig请求参数结构体
667
705
  */
668
- export interface ListCustomBlacklistRequest {
706
+ export interface UpdateAddressUnsubscribeConfigRequest {
669
707
  /**
670
- * 偏移量,整型,从0开始
708
+ * 发信地址
671
709
  */
672
- Offset: number;
710
+ Address: string;
673
711
  /**
674
- * 限制数目,整型,不超过100
712
+ * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
675
713
  */
676
- Limit: number;
714
+ UnsubscribeConfig: string;
677
715
  /**
678
- * 筛选黑名单的状态,0:已过期,1:生效中, 2:全部
716
+ * 0:关闭配置,1:打开配置
679
717
  */
680
718
  Status: number;
681
- /**
682
- * 黑名单中的邮箱地址
683
- */
684
- Email?: string;
685
719
  }
686
720
  /**
687
- * UpdateEmailSmtpPassWord请求参数结构体
721
+ * ListEmailIdentities请求参数结构体
688
722
  */
689
- export interface UpdateEmailSmtpPassWordRequest {
690
- /**
691
- * smtp密码,长度限制64
692
- */
693
- Password: string;
694
- /**
695
- * 发信邮箱,长度限制128
696
- */
697
- EmailAddress: string;
698
- }
723
+ export declare type ListEmailIdentitiesRequest = null;
699
724
  /**
700
- * 收件人列表数据类型
725
+ * CreateReceiver返回参数结构体
701
726
  */
702
- export interface ReceiverData {
727
+ export interface CreateReceiverResponse {
703
728
  /**
704
- * 收件人列表ID
729
+ * 收件人列表id,后续根据收件人列表id上传收件人地址
705
730
  */
706
731
  ReceiverId?: number;
707
732
  /**
708
- * 收件人列表名称
733
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
709
734
  */
710
- ReceiversName?: string;
735
+ RequestId?: string;
736
+ }
737
+ /**
738
+ * UpdateEmailSmtpPassWord返回参数结构体
739
+ */
740
+ export interface UpdateEmailSmtpPassWordResponse {
711
741
  /**
712
- * 收件人地址总数
742
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
713
743
  */
714
- Count?: number;
744
+ RequestId?: string;
745
+ }
746
+ /**
747
+ * ListReceivers请求参数结构体
748
+ */
749
+ export interface ListReceiversRequest {
715
750
  /**
716
- * 收件人列表描述
751
+ * 偏移量,整型,从0开始
717
752
  */
718
- Desc?: string;
753
+ Offset: number;
719
754
  /**
720
- * 列表状态(1 待上传 2 上传中 3 上传完成)
755
+ * 限制数目,整型,不超过100
721
756
  */
722
- ReceiversStatus?: number;
757
+ Limit: number;
723
758
  /**
724
- * 创建时间,如:2021-09-28 16:40:35
759
+ * 列表状态(1 待上传 2 上传中 3传完成),若查询所有就不传这个字段
725
760
  */
726
- CreateTime?: string;
761
+ Status?: number;
727
762
  /**
728
- * 无效收件人数量
763
+ * 列表名称的关键字,模糊查询
729
764
  */
730
- InvalidCount?: number;
765
+ KeyWord?: string;
731
766
  }
732
767
  /**
733
- * UpdateEmailIdentity返回参数结构体
768
+ * GetEmailIdentity返回参数结构体
734
769
  */
735
- export interface UpdateEmailIdentityResponse {
770
+ export interface GetEmailIdentityResponse {
736
771
  /**
737
772
  * 验证类型。固定值:DOMAIN
738
773
  */
@@ -742,7 +777,7 @@ export interface UpdateEmailIdentityResponse {
742
777
  */
743
778
  VerifiedForSendingStatus?: boolean;
744
779
  /**
745
- * 需要配置的DNS信息
780
+ * DNS配置详情
746
781
  */
747
782
  Attributes?: Array<DNSAttributes>;
748
783
  /**
@@ -751,207 +786,218 @@ export interface UpdateEmailIdentityResponse {
751
786
  RequestId?: string;
752
787
  }
753
788
  /**
754
- * CreateEmailTemplate请求参数结构体
789
+ * 附件结构,包含附件名和base64之后的附件内容。
755
790
  */
756
- export interface CreateEmailTemplateRequest {
791
+ export interface Attachment {
757
792
  /**
758
- * 模板名称
793
+ * 附件名称,最大支持255个字符长度,不支持部分附件类型,详情请参考[附件类型](https://cloud.tencent.com/document/product/1288/51951)。
759
794
  */
760
- TemplateName: string;
795
+ FileName: string;
761
796
  /**
762
- * 模板内容
797
+ * Base64之后的附件内容,您可以发送的附件大小上限为4M。注意:腾讯云接口请求最大支持 8M 的请求包,附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内,整体请求超出 8M 接口会返回错误。
763
798
  */
764
- TemplateContent: TemplateContent;
765
- }
766
- /**
767
- * DeleteBlackList返回参数结构体
768
- */
769
- export interface DeleteBlackListResponse {
799
+ Content?: string;
770
800
  /**
771
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
801
+ * 附件URL。未开放功能,请勿使用。
772
802
  */
773
- RequestId?: string;
803
+ FileURL?: string;
774
804
  }
775
805
  /**
776
- * DeleteCustomBlackList请求参数结构体
806
+ * ListSendTasks请求参数结构体
777
807
  */
778
- export interface DeleteCustomBlackListRequest {
808
+ export interface ListSendTasksRequest {
779
809
  /**
780
- * 需要删除的邮箱地址
810
+ * 偏移量,整型,从0开始,0代表跳过0行
781
811
  */
782
- Emails: Array<string>;
812
+ Offset: number;
813
+ /**
814
+ * 限制数目,整型,不超过100
815
+ */
816
+ Limit: number;
817
+ /**
818
+ * 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成。查询所有状态,则不传这个字段
819
+ */
820
+ Status?: number;
821
+ /**
822
+ * 收件人列表ID
823
+ */
824
+ ReceiverId?: number;
825
+ /**
826
+ * 任务类型 1即时 2定时 3周期,查询所有类型则不传这个字段
827
+ */
828
+ TaskType?: number;
783
829
  }
784
830
  /**
785
- * UpdateEmailTemplate请求参数结构体
831
+ * ListReceiverDetails返回参数结构体
786
832
  */
787
- export interface UpdateEmailTemplateRequest {
833
+ export interface ListReceiverDetailsResponse {
788
834
  /**
789
- * 模板内容
835
+ * 总数
790
836
  */
791
- TemplateContent: TemplateContent;
837
+ TotalCount?: number;
792
838
  /**
793
- * 模板ID
839
+ * 数据记录
794
840
  */
795
- TemplateID: number;
841
+ Data?: Array<ReceiverDetail>;
796
842
  /**
797
- * 模板名字
843
+ * 有效邮件地址数
844
+ */
845
+ ValidCount?: number;
846
+ /**
847
+ * 无效邮件地址数
848
+ */
849
+ InvalidCount?: number;
850
+ /**
851
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
798
852
  */
799
- TemplateName: string;
853
+ RequestId?: string;
800
854
  }
801
855
  /**
802
- * ListCustomBlacklist返回参数结构体
856
+ * ListEmailTemplates返回参数结构体
803
857
  */
804
- export interface ListCustomBlacklistResponse {
858
+ export interface ListEmailTemplatesResponse {
805
859
  /**
806
- * 列表总数
860
+ * 邮件模板列表
807
861
  */
808
- TotalCount?: number;
862
+ TemplatesMetadata?: Array<TemplatesMetadata>;
809
863
  /**
810
- * 黑名单列表详情
864
+ * 模板总数量
811
865
  */
812
- Data?: Array<BlackAddressDetail>;
866
+ TotalCount?: number;
813
867
  /**
814
868
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
815
869
  */
816
870
  RequestId?: string;
817
871
  }
818
872
  /**
819
- * 描述邮件发送状态
873
+ * GetEmailIdentity请求参数结构体
820
874
  */
821
- export interface SendEmailStatus {
822
- /**
823
- * SendEmail返回的MessageId
824
- */
825
- MessageId?: string;
826
- /**
827
- * 收件人邮箱
828
- */
829
- ToEmailAddress?: string;
875
+ export interface GetEmailIdentityRequest {
830
876
  /**
831
- * 发件人邮箱
877
+ * 发信域名
832
878
  */
833
- FromEmailAddress?: string;
879
+ EmailIdentity: string;
880
+ }
881
+ /**
882
+ * GetStatisticsReport请求参数结构体
883
+ */
884
+ export interface GetStatisticsReportRequest {
834
885
  /**
835
- * 腾讯云处理状态
836
- 0: 处理成功
837
- 1001: 内部系统异常
838
- 1002: 内部系统异常
839
- 1003: 内部系统异常
840
- 1003: 内部系统异常
841
- 1004: 发信超时
842
- 1005: 内部系统异常
843
- 1006: 触发频率控制,短时间内对同一地址发送过多邮件
844
- 1007: 邮件地址在黑名单中
845
- 1008: 域名被收件人拒收
846
- 1009: 内部系统异常
847
- 1010: 超出了每日发送限制
848
- 1011: 无发送自定义内容权限,必须使用模板
849
- 1013: 域名被收件人取消订阅
850
- 2001: 找不到相关记录
851
- 3007: 模板ID无效或者不可用
852
- 3008: 被收信域名临时封禁
853
- 3009: 无权限使用该模板
854
- 3010: TemplateData字段格式不正确
855
- 3014: 发件域名没有经过认证,无法发送
856
- 3020: 收件方邮箱类型在黑名单
857
- 3024: 邮箱地址格式预检查失败
858
- 3030: 退信率过高,临时限制发送
859
- 3033: 余额不足,账号欠费等
886
+ * 开始日期
860
887
  */
861
- SendStatus?: number;
888
+ StartDate: string;
862
889
  /**
863
- * 收件方处理状态
864
- 0: 请求成功被腾讯云接受,进入发送队列
865
- 1: 邮件递送成功,DeliverTime表示递送成功的时间
866
- 2: 邮件因某种原因被丢弃,DeliverMessage表示丢弃原因
867
- 3: 收件方ESP拒信,一般原因为邮箱地址不存在,或其它原因
868
- 8: 邮件被ESP因某些原因延迟递送,DeliverMessage表示延迟原因
890
+ * 结束日期
869
891
  */
870
- DeliverStatus?: number;
892
+ EndDate: string;
871
893
  /**
872
- * 收件方处理状态描述
894
+ * 发信域名
873
895
  */
874
- DeliverMessage?: string;
896
+ Domain?: string;
875
897
  /**
876
- * 请求到达腾讯云时间戳
898
+ * 收件方邮箱类型,例如gmail.com
877
899
  */
878
- RequestTime?: number;
900
+ ReceivingMailboxType?: string;
901
+ }
902
+ /**
903
+ * GetSendEmailStatus返回参数结构体
904
+ */
905
+ export interface GetSendEmailStatusResponse {
879
906
  /**
880
- * 腾讯云执行递送时间戳
907
+ * 邮件发送状态列表
881
908
  */
882
- DeliverTime?: number;
909
+ EmailStatusList?: Array<SendEmailStatus>;
883
910
  /**
884
- * 用户是否打开该邮件
911
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
885
912
  */
886
- UserOpened?: boolean;
913
+ RequestId?: string;
914
+ }
915
+ /**
916
+ * 地址级退订配置
917
+ */
918
+ export interface AddressUnsubscribeConfigData {
887
919
  /**
888
- * 用户是否点击该邮件中的链接
920
+ * 发信地址
889
921
  */
890
- UserClicked?: boolean;
922
+ Address?: string;
891
923
  /**
892
- * 用户是否取消该发送者的订阅
924
+ * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
893
925
  */
894
- UserUnsubscribed?: boolean;
926
+ UnsubscribeConfig?: string;
895
927
  /**
896
- * 用户是否举报该发送者
928
+ * 0:关闭,1:开启
897
929
  */
898
- UserComplainted?: boolean;
930
+ Status?: number;
899
931
  }
900
932
  /**
901
- * ListEmailTemplates请求参数结构体
933
+ * CreateEmailIdentity请求参数结构体
902
934
  */
903
- export interface ListEmailTemplatesRequest {
935
+ export interface CreateEmailIdentityRequest {
904
936
  /**
905
- * 获取模板数据量,用于分页
937
+ * 您的发信域名,建议使用三级以上域名。例如:mail.qcloud.com。
906
938
  */
907
- Limit: number;
939
+ EmailIdentity: string;
908
940
  /**
909
- * 获取模板偏移值,用于分页
941
+ * 生成的dkim密钥长度。0:1024,1:2048
910
942
  */
911
- Offset: number;
943
+ DKIMOption?: number;
912
944
  }
913
945
  /**
914
- * CreateReceiverDetailWithData返回参数结构体
946
+ * UpdateEmailTemplate请求参数结构体
915
947
  */
916
- export interface CreateReceiverDetailWithDataResponse {
948
+ export interface UpdateEmailTemplateRequest {
917
949
  /**
918
- * 收件人总数
950
+ * 模板内容
919
951
  */
920
- TotalCount?: number;
952
+ TemplateContent: TemplateContent;
921
953
  /**
922
- * 实际上传数量
954
+ * 模板ID
923
955
  */
924
- ValidCount?: number;
956
+ TemplateID: number;
925
957
  /**
926
- * 数据过长数量
958
+ * 模板名字
927
959
  */
928
- TooLongCount?: number;
960
+ TemplateName: string;
961
+ }
962
+ /**
963
+ * CreateEmailTemplate请求参数结构体
964
+ */
965
+ export interface CreateEmailTemplateRequest {
929
966
  /**
930
- * 邮件地址为空数量
967
+ * 模板名称
931
968
  */
932
- EmptyEmailCount?: number;
969
+ TemplateName: string;
933
970
  /**
934
- * 重复数量
971
+ * 模板内容
935
972
  */
936
- RepeatCount?: number;
973
+ TemplateContent: TemplateContent;
974
+ }
975
+ /**
976
+ * DeleteBlackList返回参数结构体
977
+ */
978
+ export interface DeleteBlackListResponse {
937
979
  /**
938
980
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
939
981
  */
940
982
  RequestId?: string;
941
983
  }
942
984
  /**
943
- * 收件人明细输入参数,包含收件人邮箱,以及模板参数
985
+ * DeleteCustomBlackList返回参数结构体
944
986
  */
945
- export interface ReceiverInputData {
987
+ export interface DeleteCustomBlackListResponse {
946
988
  /**
947
- * 收件人邮箱
989
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
948
990
  */
949
- Email: string;
991
+ RequestId?: string;
992
+ }
993
+ /**
994
+ * DeleteAddressUnsubscribeConfig请求参数结构体
995
+ */
996
+ export interface DeleteAddressUnsubscribeConfigRequest {
950
997
  /**
951
- * 模板中的变量参数,请使用json.dump将json对象格式化为string类型。该对象是一组键值对,每个Key代表模板中的一个变量,模板中的变量使用{{键}}表示,相应的值在发送时会被替换为{{值}}。
952
- 注意:参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。
998
+ * 需要操作的发信地址
953
999
  */
954
- TemplateData: string;
1000
+ Address?: string;
955
1001
  }
956
1002
  /**
957
1003
  * CreateReceiverDetail返回参数结构体
@@ -991,23 +1037,6 @@ export interface DeleteReceiverResponse {
991
1037
  */
992
1038
  RequestId?: string;
993
1039
  }
994
- /**
995
- * ListEmailTemplates返回参数结构体
996
- */
997
- export interface ListEmailTemplatesResponse {
998
- /**
999
- * 邮件模板列表
1000
- */
1001
- TemplatesMetadata?: Array<TemplatesMetadata>;
1002
- /**
1003
- * 模板总数量
1004
- */
1005
- TotalCount?: number;
1006
- /**
1007
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1008
- */
1009
- RequestId?: string;
1010
- }
1011
1040
  /**
1012
1041
  * SendEmail返回参数结构体
1013
1042
  */
@@ -1022,425 +1051,445 @@ export interface SendEmailResponse {
1022
1051
  RequestId?: string;
1023
1052
  }
1024
1053
  /**
1025
- * SendEmail请求参数结构体
1054
+ * 模板列表结构
1026
1055
  */
1027
- export interface SendEmailRequest {
1028
- /**
1029
- * 发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址,例如:noreply@mail.qcloud.com如需填写发件人别名时,请按照如下方式(注意别名与邮箱地址之间必须使用一个空格隔开):别名+一个空格+<邮箱地址>,别名中不能带有冒号(:)。
1030
- */
1031
- FromEmailAddress: string;
1056
+ export interface TemplatesMetadata {
1032
1057
  /**
1033
- * 收信人邮箱地址,最多支持群发50人。注意:邮件内容会显示所有收件人地址,非群发邮件请多次调用API发送。
1058
+ * 创建时间
1034
1059
  */
1035
- Destination: Array<string>;
1060
+ CreatedTimestamp?: number;
1036
1061
  /**
1037
- * 邮件主题
1062
+ * 模板名称
1038
1063
  */
1039
- Subject: string;
1064
+ TemplateName?: string;
1040
1065
  /**
1041
- * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
1066
+ * 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
1042
1067
  */
1043
- ReplyToAddresses?: string;
1068
+ TemplateStatus?: number;
1044
1069
  /**
1045
- * 抄送人邮箱地址,最多支持抄送20人。
1070
+ * 模板ID
1046
1071
  */
1047
- Cc?: Array<string>;
1072
+ TemplateID?: number;
1048
1073
  /**
1049
- * 密送人邮箱地址,最多支持抄送20人,Bcc和Destination不能重复。
1074
+ * 审核原因
1050
1075
  */
1051
- Bcc?: Array<string>;
1076
+ ReviewReason?: string;
1077
+ }
1078
+ /**
1079
+ * 黑名单详情
1080
+ */
1081
+ export interface BlackAddressDetail {
1052
1082
  /**
1053
- * 使用模板发送时,填写模板相关参数。
1054
- <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置,则该字段为必填 </dx-alert>
1083
+ * 黑名单地址id
1055
1084
  */
1056
- Template?: Template;
1085
+ Id?: number;
1057
1086
  /**
1058
- * 已废弃
1059
- <dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。</dx-alert>
1087
+ * 邮箱地址
1060
1088
  */
1061
- Simple?: Simple;
1089
+ Email?: string;
1062
1090
  /**
1063
- * 需要发送附件时,填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包,附件内容经过 Base64 预期扩大1.5倍,应该控制所有附件的总大小最大在 4M 以内,整体请求超出 8M 时接口会返回错误
1091
+ * 创建时间
1064
1092
  */
1065
- Attachments?: Array<Attachment>;
1093
+ CreateTime?: string;
1066
1094
  /**
1067
- * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
1095
+ * 过期时间
1068
1096
  */
1069
- Unsubscribe?: string;
1097
+ ExpireDate?: string;
1070
1098
  /**
1071
- * 邮件触发类型 0:非触发类,默认类型,营销类邮件、非即时类邮件等选择此类型 1:触发类,验证码等即时发送类邮件,若邮件超过一定大小,系统会自动选择非触发类型通道
1099
+ * 黑名单状态,0:已过期,1:生效中
1072
1100
  */
1073
- TriggerType?: number;
1101
+ Status?: number;
1102
+ }
1103
+ /**
1104
+ * GetStatisticsReport返回参数结构体
1105
+ */
1106
+ export interface GetStatisticsReportResponse {
1074
1107
  /**
1075
- * smtp头中的Message-Id字段
1108
+ * 发信统计报告,按天
1076
1109
  */
1077
- SmtpMessageId?: string;
1110
+ DailyVolumes: Array<Volume>;
1078
1111
  /**
1079
- * smtp头中可以设置的其它字段
1112
+ * 发信统计报告,总览
1080
1113
  */
1081
- SmtpHeaders?: string;
1114
+ OverallVolume: Volume;
1082
1115
  /**
1083
- * smtp头中的from字段,建议域名与FromEmailAddress保持一致
1116
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1084
1117
  */
1085
- HeaderFrom?: string;
1118
+ RequestId?: string;
1086
1119
  }
1087
1120
  /**
1088
- * ListBlackEmailAddress返回参数结构体
1121
+ * DeleteEmailAddress返回参数结构体
1089
1122
  */
1090
- export interface ListBlackEmailAddressResponse {
1123
+ export interface DeleteEmailAddressResponse {
1091
1124
  /**
1092
- * 黑名单列表
1125
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1093
1126
  */
1094
- BlackList?: Array<BlackEmailAddress>;
1127
+ RequestId?: string;
1128
+ }
1129
+ /**
1130
+ * ListCustomBlacklist返回参数结构体
1131
+ */
1132
+ export interface ListCustomBlacklistResponse {
1095
1133
  /**
1096
- * 黑名单总数
1134
+ * 列表总数
1097
1135
  */
1098
1136
  TotalCount?: number;
1137
+ /**
1138
+ * 黑名单列表详情
1139
+ */
1140
+ Data?: Array<BlackAddressDetail>;
1099
1141
  /**
1100
1142
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1101
1143
  */
1102
1144
  RequestId?: string;
1103
1145
  }
1104
1146
  /**
1105
- * GetSendEmailStatus请求参数结构体
1147
+ * ListReceiverDetails请求参数结构体
1106
1148
  */
1107
- export interface GetSendEmailStatusRequest {
1149
+ export interface ListReceiverDetailsRequest {
1108
1150
  /**
1109
- * 发送的日期,必填。仅支持查询某个日期,不支持范围查询。
1151
+ * 收件人列表ID,CreateReceiver接口创建收件人列表时会返回该值
1110
1152
  */
1111
- RequestDate: string;
1153
+ ReceiverId: number;
1112
1154
  /**
1113
- * 偏移量。默认为0
1155
+ * 偏移量,整型,从0开始
1114
1156
  */
1115
1157
  Offset: number;
1116
1158
  /**
1117
- * 拉取最大条数,最多 100
1159
+ * 限制数目,整型,不超过100
1118
1160
  */
1119
1161
  Limit: number;
1120
1162
  /**
1121
- * SendMail接口返回的MessageId字段。
1163
+ * 收件人地址,长度0-50,示例:xxx@te.com,支持模糊查询
1122
1164
  */
1123
- MessageId?: string;
1165
+ Email?: string;
1124
1166
  /**
1125
- * 收件人邮箱。
1167
+ * 搜索开始时间
1126
1168
  */
1127
- ToEmailAddress?: string;
1169
+ CreateTimeBegin?: string;
1170
+ /**
1171
+ * 搜索结束时间
1172
+ */
1173
+ CreateTimeEnd?: string;
1174
+ /**
1175
+ * 1:有效,2:无效
1176
+ */
1177
+ Status?: number;
1128
1178
  }
1129
1179
  /**
1130
- * 邮件发送的内容,可以是纯文本(TEXT),也可以是纯代码(HTML),或者纯文本+HTML的组合(建议方式)
1180
+ * CreateEmailIdentity返回参数结构体
1131
1181
  */
1132
- export interface Simple {
1182
+ export interface CreateEmailIdentityResponse {
1133
1183
  /**
1134
- * base64之后的Html代码。需要包含所有的代码信息,不要包含外部css,否则会导致显示格式错乱
1184
+ * 验证类型。固定值:DOMAIN
1135
1185
  */
1136
- Html?: string;
1186
+ IdentityType?: string;
1137
1187
  /**
1138
- * base64之后的纯文本信息,如果没有Html,邮件中会直接显示纯文本;如果有Html,它代表邮件的纯文本样式
1188
+ * 是否已通过验证
1139
1189
  */
1140
- Text?: string;
1190
+ VerifiedForSendingStatus?: boolean;
1191
+ /**
1192
+ * 需要配置的DNS信息
1193
+ */
1194
+ Attributes?: Array<DNSAttributes>;
1195
+ /**
1196
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1197
+ */
1198
+ RequestId?: string;
1141
1199
  }
1142
1200
  /**
1143
- * 统计数据的结构体
1201
+ * CreateEmailAddress返回参数结构体
1144
1202
  */
1145
- export interface Volume {
1203
+ export interface CreateEmailAddressResponse {
1146
1204
  /**
1147
- * 日期
1148
- 注意:此字段可能返回 null,表示取不到有效值。
1205
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1149
1206
  */
1150
- SendDate?: string;
1207
+ RequestId?: string;
1208
+ }
1209
+ /**
1210
+ * DeleteAddressUnsubscribeConfig返回参数结构体
1211
+ */
1212
+ export interface DeleteAddressUnsubscribeConfigResponse {
1151
1213
  /**
1152
- * 邮件请求数量
1214
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1153
1215
  */
1154
- RequestCount?: number;
1216
+ RequestId?: string;
1217
+ }
1218
+ /**
1219
+ * BatchSendEmail请求参数结构体
1220
+ */
1221
+ export interface BatchSendEmailRequest {
1155
1222
  /**
1156
- * 腾讯云通过数量
1223
+ * 发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
1224
+ 发信人 &lt;邮件地址&gt; 的方式填写,例如:
1225
+ 腾讯云团队 &lt;noreply@mail.qcloud.com&gt;
1157
1226
  */
1158
- AcceptedCount?: number;
1227
+ FromEmailAddress: string;
1159
1228
  /**
1160
- * 送达数量
1229
+ * 收件人列表ID
1161
1230
  */
1162
- DeliveredCount?: number;
1231
+ ReceiverId: number;
1163
1232
  /**
1164
- * 打开邮件的用户数量,根据收件人去重
1233
+ * 邮件主题
1165
1234
  */
1166
- OpenedCount?: number;
1235
+ Subject: string;
1167
1236
  /**
1168
- * 点击了邮件中的链接数量用户数量
1237
+ * 任务类型 1: 立即发送 2: 定时发送 3: 周期(频率)发送
1169
1238
  */
1170
- ClickedCount?: number;
1239
+ TaskType: number;
1171
1240
  /**
1172
- * 退信数量
1241
+ * 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人的回复邮件将会发送失败。
1173
1242
  */
1174
- BounceCount?: number;
1243
+ ReplyToAddresses?: string;
1175
1244
  /**
1176
- * 取消订阅的用户数量
1177
- 注意:此字段可能返回 null,表示取不到有效值。
1245
+ * 使用模板发送时,填写的模板相关参数
1246
+ <dx-alert infotype="notice" title="注意"> 如您未申请过特殊配置,则该字段为必填 </dx-alert>
1178
1247
  */
1179
- UnsubscribeCount?: number;
1180
- }
1181
- /**
1182
- * DeleteReceiver请求参数结构体
1183
- */
1184
- export interface DeleteReceiverRequest {
1248
+ Template?: Template;
1185
1249
  /**
1186
- * 收件人列表id,创建收件人列表时会返回
1250
+ * 已废弃<dx-alert infotype="notice" title="说明"> 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置,则不存在该字段。</dx-alert>
1187
1251
  */
1188
- ReceiverId: number;
1189
- }
1190
- /**
1191
- * ListEmailIdentities返回参数结构体
1192
- */
1193
- export interface ListEmailIdentitiesResponse {
1252
+ Simple?: Simple;
1194
1253
  /**
1195
- * 发信域名列表
1254
+ * 需要发送附件时,填写附件相关参数(暂未支持)
1196
1255
  */
1197
- EmailIdentities: Array<EmailIdentity>;
1256
+ Attachments?: Array<Attachment>;
1198
1257
  /**
1199
- * 最大信誉等级
1258
+ * 周期发送任务的必要参数
1200
1259
  */
1201
- MaxReputationLevel: number;
1260
+ CycleParam?: CycleEmailParam;
1202
1261
  /**
1203
- * 单域名最高日发送量
1262
+ * 定时发送任务的必要参数
1204
1263
  */
1205
- MaxDailyQuota: number;
1264
+ TimedParam?: TimedEmailParam;
1206
1265
  /**
1207
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1266
+ * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
1208
1267
  */
1209
- RequestId?: string;
1210
- }
1211
- /**
1212
- * DeleteEmailTemplate请求参数结构体
1213
- */
1214
- export interface DeleteEmailTemplateRequest {
1268
+ Unsubscribe?: string;
1215
1269
  /**
1216
- * 模板ID
1270
+ * 是否添加广告标识 0:不添加 1:添加到subject前面,2:添加到subject后面
1217
1271
  */
1218
- TemplateID: number;
1272
+ ADLocation?: number;
1219
1273
  }
1220
1274
  /**
1221
- * 模板内容,TEXT和HTML必须至少存在一项,建议使用TEXT和HTML的组合
1275
+ * CreateCustomBlacklist请求参数结构体
1222
1276
  */
1223
- export interface TemplateContent {
1277
+ export interface CreateCustomBlacklistRequest {
1224
1278
  /**
1225
- * base64之后的Html代码
1279
+ * 添加到黑名单的邮件地址
1226
1280
  */
1227
- Html?: string;
1281
+ Emails: Array<string>;
1228
1282
  /**
1229
- * base64之后的文本内容
1283
+ * 过期日期
1230
1284
  */
1231
- Text?: string;
1285
+ ExpireDate?: string;
1232
1286
  }
1233
1287
  /**
1234
- * GetStatisticsReport返回参数结构体
1288
+ * ListEmailAddress请求参数结构体
1235
1289
  */
1236
- export interface GetStatisticsReportResponse {
1237
- /**
1238
- * 发信统计报告,按天
1239
- */
1240
- DailyVolumes: Array<Volume>;
1241
- /**
1242
- * 发信统计报告,总览
1243
- */
1244
- OverallVolume: Volume;
1290
+ export declare type ListEmailAddressRequest = null;
1291
+ /**
1292
+ * UpdateCustomBlackList返回参数结构体
1293
+ */
1294
+ export interface UpdateCustomBlackListResponse {
1245
1295
  /**
1246
1296
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1247
1297
  */
1248
1298
  RequestId?: string;
1249
1299
  }
1250
1300
  /**
1251
- * DeleteEmailAddress请求参数结构体
1301
+ * ListBlackEmailAddress请求参数结构体
1252
1302
  */
1253
- export interface DeleteEmailAddressRequest {
1303
+ export interface ListBlackEmailAddressRequest {
1254
1304
  /**
1255
- * 发信地址
1305
+ * 开始日期,格式为YYYY-MM-DD
1256
1306
  */
1257
- EmailAddress: string;
1258
- }
1259
- /**
1260
- * 黑名单详情
1261
- */
1262
- export interface BlackAddressDetail {
1307
+ StartDate: string;
1263
1308
  /**
1264
- * 黑名单地址id
1309
+ * 结束日期,格式为YYYY-MM-DD
1265
1310
  */
1266
- Id?: number;
1311
+ EndDate: string;
1267
1312
  /**
1268
- * 邮箱地址
1313
+ * 规范,配合Offset使用
1269
1314
  */
1270
- Email?: string;
1315
+ Limit: number;
1271
1316
  /**
1272
- * 创建时间
1317
+ * 规范,配合Limit使用,Limit最大取值为100
1273
1318
  */
1274
- CreateTime?: string;
1319
+ Offset: number;
1275
1320
  /**
1276
- * 过期时间
1321
+ * 可以指定邮箱进行查询
1277
1322
  */
1278
- ExpireDate?: string;
1323
+ EmailAddress?: string;
1279
1324
  /**
1280
- * 黑名单状态,0:已过期,1:生效中
1325
+ * 已废弃
1281
1326
  */
1282
- Status?: number;
1327
+ TaskID?: string;
1283
1328
  }
1284
1329
  /**
1285
- * 发信域名验证列表结构体
1330
+ * CreateReceiverDetailWithData返回参数结构体
1286
1331
  */
1287
- export interface EmailIdentity {
1332
+ export interface CreateReceiverDetailWithDataResponse {
1288
1333
  /**
1289
- * 发信域名
1334
+ * 收件人总数
1290
1335
  */
1291
- IdentityName?: string;
1336
+ TotalCount?: number;
1292
1337
  /**
1293
- * 验证类型,固定为DOMAIN
1338
+ * 实际上传数量
1294
1339
  */
1295
- IdentityType?: string;
1340
+ ValidCount?: number;
1296
1341
  /**
1297
- * 是否已通过验证
1342
+ * 数据过长数量
1298
1343
  */
1299
- SendingEnabled?: boolean;
1344
+ TooLongCount?: number;
1300
1345
  /**
1301
- * 当前信誉等级
1346
+ * 邮件地址为空数量
1302
1347
  */
1303
- CurrentReputationLevel?: number;
1348
+ EmptyEmailCount?: number;
1304
1349
  /**
1305
- * 当日最高发信量
1350
+ * 重复数量
1306
1351
  */
1307
- DailyQuota?: number;
1352
+ RepeatCount?: number;
1308
1353
  /**
1309
- * 域名配置的独立ip
1354
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1310
1355
  */
1311
- SendIp?: Array<string>;
1356
+ RequestId?: string;
1357
+ }
1358
+ /**
1359
+ * GetEmailTemplate请求参数结构体
1360
+ */
1361
+ export interface GetEmailTemplateRequest {
1362
+ /**
1363
+ * 模板ID
1364
+ */
1365
+ TemplateID: number;
1312
1366
  }
1313
1367
  /**
1314
- * 邮箱黑名单结构,包含被拉黑的邮箱地址和被拉黑时间,以及被拉黑的理由
1368
+ * ListSendTasks返回参数结构体
1315
1369
  */
1316
- export interface BlackEmailAddress {
1317
- /**
1318
- * 邮箱被拉黑时间
1319
- */
1320
- BounceTime?: string;
1370
+ export interface ListSendTasksResponse {
1321
1371
  /**
1322
- * 被拉黑的邮箱地址
1372
+ * 总数
1323
1373
  */
1324
- EmailAddress?: string;
1374
+ TotalCount?: number;
1325
1375
  /**
1326
- * 被拉黑的理由
1376
+ * 数据记录
1327
1377
  */
1328
- IspDesc?: string;
1329
- }
1330
- /**
1331
- * DeleteEmailAddress返回参数结构体
1332
- */
1333
- export interface DeleteEmailAddressResponse {
1378
+ Data?: Array<SendTaskData>;
1334
1379
  /**
1335
1380
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1336
1381
  */
1337
1382
  RequestId?: string;
1338
1383
  }
1339
1384
  /**
1340
- * 创建重复周期发送邮件任务的参数
1385
+ * 统计数据的结构体
1341
1386
  */
1342
- export interface CycleEmailParam {
1387
+ export interface Volume {
1343
1388
  /**
1344
- * 任务开始时间
1389
+ * 日期
1390
+ 注意:此字段可能返回 null,表示取不到有效值。
1345
1391
  */
1346
- BeginTime: string;
1392
+ SendDate?: string;
1347
1393
  /**
1348
- * 任务周期 小时维度
1394
+ * 邮件请求数量
1349
1395
  */
1350
- IntervalTime: number;
1396
+ RequestCount?: number;
1351
1397
  /**
1352
- * 是否终止周期,用于任务更新 0否1是
1398
+ * 腾讯云通过数量
1353
1399
  */
1354
- TermCycle?: number;
1355
- }
1356
- /**
1357
- * CreateEmailIdentity返回参数结构体
1358
- */
1359
- export interface CreateEmailIdentityResponse {
1400
+ AcceptedCount?: number;
1360
1401
  /**
1361
- * 验证类型。固定值:DOMAIN
1402
+ * 送达数量
1362
1403
  */
1363
- IdentityType?: string;
1404
+ DeliveredCount?: number;
1364
1405
  /**
1365
- * 是否已通过验证
1406
+ * 打开邮件的用户数量,根据收件人去重
1366
1407
  */
1367
- VerifiedForSendingStatus?: boolean;
1408
+ OpenedCount?: number;
1368
1409
  /**
1369
- * 需要配置的DNS信息
1410
+ * 点击了邮件中的链接数量用户数量
1370
1411
  */
1371
- Attributes?: Array<DNSAttributes>;
1412
+ ClickedCount?: number;
1372
1413
  /**
1373
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1414
+ * 退信数量
1374
1415
  */
1375
- RequestId?: string;
1416
+ BounceCount?: number;
1417
+ /**
1418
+ * 取消订阅的用户数量
1419
+ 注意:此字段可能返回 null,表示取不到有效值。
1420
+ */
1421
+ UnsubscribeCount?: number;
1376
1422
  }
1377
1423
  /**
1378
- * ListReceiverDetails请求参数结构体
1424
+ * 收件人列表数据类型
1379
1425
  */
1380
- export interface ListReceiverDetailsRequest {
1426
+ export interface ReceiverData {
1381
1427
  /**
1382
- * 收件人列表ID,CreateReceiver接口创建收件人列表时会返回该值
1428
+ * 收件人列表ID
1383
1429
  */
1384
- ReceiverId: number;
1430
+ ReceiverId?: number;
1385
1431
  /**
1386
- * 偏移量,整型,从0开始
1432
+ * 收件人列表名称
1387
1433
  */
1388
- Offset: number;
1434
+ ReceiversName?: string;
1389
1435
  /**
1390
- * 限制数目,整型,不超过100
1436
+ * 收件人地址总数
1391
1437
  */
1392
- Limit: number;
1438
+ Count?: number;
1393
1439
  /**
1394
- * 收件人地址,长度0-50,示例:xxx@te.com,支持模糊查询
1440
+ * 收件人列表描述
1395
1441
  */
1396
- Email?: string;
1442
+ Desc?: string;
1397
1443
  /**
1398
- * 搜索开始时间
1444
+ * 列表状态(1 待上传 2 上传中 3 上传完成)
1399
1445
  */
1400
- CreateTimeBegin?: string;
1446
+ ReceiversStatus?: number;
1401
1447
  /**
1402
- * 搜索结束时间
1448
+ * 创建时间,如:2021-09-28 16:40:35
1403
1449
  */
1404
- CreateTimeEnd?: string;
1450
+ CreateTime?: string;
1405
1451
  /**
1406
- * 1:有效,2:无效
1452
+ * 无效收件人数量
1407
1453
  */
1408
- Status?: number;
1454
+ InvalidCount?: number;
1409
1455
  }
1410
1456
  /**
1411
- * CreateEmailAddress请求参数结构体
1457
+ * CreateAddressUnsubscribeConfig请求参数结构体
1412
1458
  */
1413
- export interface CreateEmailAddressRequest {
1459
+ export interface CreateAddressUnsubscribeConfigRequest {
1414
1460
  /**
1415
- * 您的发信地址(发信地址总数上限为10个)
1461
+ * 发信地址
1416
1462
  */
1417
- EmailAddress: string;
1463
+ Address: string;
1418
1464
  /**
1419
- * 发件人别名
1465
+ * 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
1420
1466
  */
1421
- EmailSenderName?: string;
1422
- }
1423
- /**
1424
- * DeleteCustomBlackList返回参数结构体
1425
- */
1426
- export interface DeleteCustomBlackListResponse {
1467
+ UnsubscribeConfig: string;
1427
1468
  /**
1428
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1469
+ * 0:关闭,1:打开
1429
1470
  */
1430
- RequestId?: string;
1471
+ Status: number;
1431
1472
  }
1432
1473
  /**
1433
- * CreateReceiverDetail请求参数结构体
1474
+ * UpdateEmailIdentity返回参数结构体
1434
1475
  */
1435
- export interface CreateReceiverDetailRequest {
1476
+ export interface UpdateEmailIdentityResponse {
1436
1477
  /**
1437
- * 收件人列表ID
1478
+ * 验证类型。固定值:DOMAIN
1438
1479
  */
1439
- ReceiverId: number;
1480
+ IdentityType?: string;
1440
1481
  /**
1441
- * 邮箱
1482
+ * 是否已通过验证
1442
1483
  */
1443
- Emails: Array<string>;
1484
+ VerifiedForSendingStatus?: boolean;
1485
+ /**
1486
+ * 需要配置的DNS信息
1487
+ */
1488
+ Attributes?: Array<DNSAttributes>;
1489
+ /**
1490
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1491
+ */
1492
+ RequestId?: string;
1444
1493
  }
1445
1494
  /**
1446
1495
  * CreateEmailTemplate返回参数结构体
@@ -1456,109 +1505,130 @@ export interface CreateEmailTemplateResponse {
1456
1505
  RequestId?: string;
1457
1506
  }
1458
1507
  /**
1459
- * ListReceivers返回参数结构体
1508
+ * GetSendEmailStatus请求参数结构体
1460
1509
  */
1461
- export interface ListReceiversResponse {
1510
+ export interface GetSendEmailStatusRequest {
1462
1511
  /**
1463
- * 总数
1512
+ * 发送的日期,必填。仅支持查询某个日期,不支持范围查询。
1464
1513
  */
1465
- TotalCount?: number;
1514
+ RequestDate: string;
1466
1515
  /**
1467
- * 数据记录
1516
+ * 偏移量。默认为0
1468
1517
  */
1469
- Data?: Array<ReceiverData>;
1518
+ Offset: number;
1470
1519
  /**
1471
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId
1520
+ * 拉取最大条数,最多 100
1472
1521
  */
1473
- RequestId?: string;
1522
+ Limit: number;
1523
+ /**
1524
+ * SendMail接口返回的MessageId字段。
1525
+ */
1526
+ MessageId?: string;
1527
+ /**
1528
+ * 收件人邮箱。
1529
+ */
1530
+ ToEmailAddress?: string;
1474
1531
  }
1475
1532
  /**
1476
- * CreateEmailAddress返回参数结构体
1533
+ * ListEmailAddress返回参数结构体
1477
1534
  */
1478
- export interface CreateEmailAddressResponse {
1535
+ export interface ListEmailAddressResponse {
1536
+ /**
1537
+ * 发信地址列表详情
1538
+ */
1539
+ EmailSenders?: Array<EmailSender>;
1479
1540
  /**
1480
1541
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1481
1542
  */
1482
1543
  RequestId?: string;
1483
1544
  }
1484
1545
  /**
1485
- * UpdateEmailTemplate返回参数结构体
1546
+ * DeleteEmailAddress请求参数结构体
1486
1547
  */
1487
- export interface UpdateEmailTemplateResponse {
1548
+ export interface DeleteEmailAddressRequest {
1488
1549
  /**
1489
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1550
+ * 发信地址
1490
1551
  */
1491
- RequestId?: string;
1552
+ EmailAddress: string;
1492
1553
  }
1493
1554
  /**
1494
- * CreateReceiverDetailWithData请求参数结构体
1555
+ * 发信域名验证列表结构体
1495
1556
  */
1496
- export interface CreateReceiverDetailWithDataRequest {
1557
+ export interface EmailIdentity {
1497
1558
  /**
1498
- * 收件人列表ID
1559
+ * 发信域名
1499
1560
  */
1500
- ReceiverId: number;
1561
+ IdentityName?: string;
1501
1562
  /**
1502
- * 收信人邮箱以及模板参数,数组形式。收件人个数限制20000个以内。
1563
+ * 验证类型,固定为DOMAIN
1503
1564
  */
1504
- Datas: Array<ReceiverInputData>;
1565
+ IdentityType?: string;
1566
+ /**
1567
+ * 是否已通过验证
1568
+ */
1569
+ SendingEnabled?: boolean;
1570
+ /**
1571
+ * 当前信誉等级
1572
+ */
1573
+ CurrentReputationLevel?: number;
1574
+ /**
1575
+ * 当日最高发信量
1576
+ */
1577
+ DailyQuota?: number;
1578
+ /**
1579
+ * 域名配置的独立ip
1580
+ */
1581
+ SendIp?: Array<string>;
1505
1582
  }
1506
1583
  /**
1507
- * 创建定时发送邮件任务时,设置的定时参数,比如开始时间之类
1584
+ * DeleteReceiver请求参数结构体
1508
1585
  */
1509
- export interface TimedEmailParam {
1586
+ export interface DeleteReceiverRequest {
1510
1587
  /**
1511
- * 定时发送邮件的开始时间
1588
+ * 收件人列表id,创建收件人列表时会返回
1512
1589
  */
1513
- BeginTime: string;
1590
+ ReceiverId: number;
1514
1591
  }
1515
1592
  /**
1516
- * 用于描述DNS记录的域名、记录类型、期望得到的值、目前配置的值
1593
+ * 创建重复周期发送邮件任务的参数
1517
1594
  */
1518
- export interface DNSAttributes {
1519
- /**
1520
- * 记录类型 CNAME | A | TXT | MX
1521
- */
1522
- Type?: string;
1523
- /**
1524
- * 域名
1525
- */
1526
- SendDomain?: string;
1595
+ export interface CycleEmailParam {
1527
1596
  /**
1528
- * 需要配置的值
1597
+ * 任务开始时间
1529
1598
  */
1530
- ExpectedValue?: string;
1599
+ BeginTime: string;
1531
1600
  /**
1532
- * 腾讯云目前检测到的值
1601
+ * 任务周期 小时维度
1533
1602
  */
1534
- CurrentValue?: string;
1603
+ IntervalTime: number;
1535
1604
  /**
1536
- * 检测是否通过,创建时默认为false
1605
+ * 是否终止周期,用于任务更新 0否1是
1537
1606
  */
1538
- Status?: boolean;
1607
+ TermCycle?: number;
1539
1608
  }
1540
1609
  /**
1541
- * GetEmailTemplate返回参数结构体
1610
+ * CreateAddressUnsubscribeConfig返回参数结构体
1542
1611
  */
1543
- export interface GetEmailTemplateResponse {
1612
+ export interface CreateAddressUnsubscribeConfigResponse {
1544
1613
  /**
1545
- * 模板内容数据
1614
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1546
1615
  */
1547
- TemplateContent: TemplateContent;
1616
+ RequestId?: string;
1617
+ }
1618
+ /**
1619
+ * ListReceivers返回参数结构体
1620
+ */
1621
+ export interface ListReceiversResponse {
1548
1622
  /**
1549
- * 模板状态 0-审核通过 1-待审核 2-审核拒绝
1623
+ * 总数
1550
1624
  */
1551
- TemplateStatus: number;
1625
+ TotalCount?: number;
1552
1626
  /**
1553
- * 模板名称
1627
+ * 数据记录
1554
1628
  */
1555
- TemplateName: string;
1629
+ Data?: Array<ReceiverData>;
1556
1630
  /**
1557
1631
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1558
1632
  */
1559
1633
  RequestId?: string;
1560
1634
  }
1561
- /**
1562
- * ListEmailIdentities请求参数结构体
1563
- */
1564
- export declare type ListEmailIdentitiesRequest = null;