tencentcloud-sdk-nodejs 4.0.701 → 4.0.702

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 (99) hide show
  1. package/CHANGELOG.md +670 -0
  2. package/SERVICE_CHANGELOG.md +1132 -206
  3. package/package.json +1 -1
  4. package/products.md +22 -23
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +23 -18
  7. package/src/services/as/v20180419/as_models.ts +1 -4
  8. package/src/services/batch/v20170312/batch_models.ts +1 -1
  9. package/src/services/cfg/v20210820/cfg_client.ts +1 -0
  10. package/src/services/cfg/v20210820/cfg_models.ts +76 -3
  11. package/src/services/cls/v20201016/cls_models.ts +1 -1
  12. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  13. package/src/services/cwp/v20180228/cwp_client.ts +4778 -1799
  14. package/src/services/cwp/v20180228/cwp_models.ts +21046 -9016
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +1 -1
  16. package/src/services/dlc/v20210125/dlc_client.ts +24 -4
  17. package/src/services/dlc/v20210125/dlc_models.ts +264 -53
  18. package/src/services/dts/v20211206/dts_models.ts +30 -30
  19. package/src/services/emr/v20190103/emr_client.ts +18 -6
  20. package/src/services/emr/v20190103/emr_models.ts +28 -0
  21. package/src/services/ess/v20201111/ess_client.ts +19 -0
  22. package/src/services/ess/v20201111/ess_models.ts +61 -0
  23. package/src/services/essbasic/v20210526/essbasic_client.ts +20 -1
  24. package/src/services/essbasic/v20210526/essbasic_models.ts +79 -19
  25. package/src/services/index.ts +0 -1
  26. package/src/services/mps/v20190612/mps_models.ts +29 -24
  27. package/src/services/ocr/v20181119/ocr_models.ts +4 -0
  28. package/src/services/sms/v20190711/sms_client.ts +0 -7
  29. package/src/services/sms/v20190711/sms_models.ts +14 -12
  30. package/src/services/ssl/v20191205/ssl_models.ts +32 -4
  31. package/src/services/teo/v20220901/teo_client.ts +5 -41
  32. package/src/services/teo/v20220901/teo_models.ts +84 -209
  33. package/src/services/trp/v20210515/trp_client.ts +17 -3
  34. package/src/services/trp/v20210515/trp_models.ts +58 -6
  35. package/src/services/waf/v20180125/waf_client.ts +87 -11
  36. package/src/services/waf/v20180125/waf_models.ts +485 -185
  37. package/tencentcloud/common/sdk_version.d.ts +1 -1
  38. package/tencentcloud/common/sdk_version.js +1 -1
  39. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +23 -18
  40. package/tencentcloud/services/as/v20180419/as_models.d.ts +1 -4
  41. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +1 -1
  42. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +75 -3
  43. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  44. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  45. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1522 -562
  46. package/tencentcloud/services/cwp/v20180228/cwp_client.js +2285 -847
  47. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +20250 -8805
  48. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +1 -1
  49. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  50. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  51. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +254 -53
  52. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +30 -30
  53. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +7 -3
  54. package/tencentcloud/services/emr/v20190103/emr_client.js +9 -3
  55. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +26 -0
  56. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +12 -1
  57. package/tencentcloud/services/ess/v20201111/ess_client.js +13 -0
  58. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +59 -0
  59. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +12 -1
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -0
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +77 -19
  62. package/tencentcloud/services/index.d.ts +0 -1
  63. package/tencentcloud/services/index.js +0 -2
  64. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +29 -24
  65. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +4 -0
  66. package/tencentcloud/services/sms/v20190711/sms_client.d.ts +0 -7
  67. package/tencentcloud/services/sms/v20190711/sms_client.js +0 -7
  68. package/tencentcloud/services/sms/v20190711/sms_models.d.ts +14 -12
  69. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +32 -4
  70. package/tencentcloud/services/teo/v20220901/teo_client.d.ts +1 -13
  71. package/tencentcloud/services/teo/v20220901/teo_client.js +0 -18
  72. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +84 -203
  73. package/tencentcloud/services/trp/v20210515/trp_client.d.ts +7 -1
  74. package/tencentcloud/services/trp/v20210515/trp_client.js +8 -0
  75. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +56 -6
  76. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +25 -1
  77. package/tencentcloud/services/waf/v20180125/waf_client.js +36 -0
  78. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +477 -193
  79. package/test/cwp.v20180228.test.js +2948 -558
  80. package/test/dlc.v20210125.test.js +10 -0
  81. package/test/emr.v20190103.test.js +12 -2
  82. package/test/ess.v20201111.test.js +10 -0
  83. package/test/essbasic.v20210526.test.js +10 -0
  84. package/test/teo.v20220901.test.js +0 -30
  85. package/test/trp.v20210515.test.js +10 -0
  86. package/test/waf.v20180125.test.js +60 -0
  87. package/src/services/zj/index.ts +0 -5
  88. package/src/services/zj/v20190121/index.ts +0 -6
  89. package/src/services/zj/v20190121/zj_client.ts +0 -311
  90. package/src/services/zj/v20190121/zj_models.ts +0 -1415
  91. package/tencentcloud/services/zj/index.d.ts +0 -6
  92. package/tencentcloud/services/zj/index.js +0 -7
  93. package/tencentcloud/services/zj/v20190121/index.d.ts +0 -6
  94. package/tencentcloud/services/zj/v20190121/index.js +0 -9
  95. package/tencentcloud/services/zj/v20190121/zj_client.d.ts +0 -94
  96. package/tencentcloud/services/zj/v20190121/zj_client.js +0 -157
  97. package/tencentcloud/services/zj/v20190121/zj_models.d.ts +0 -1329
  98. package/tencentcloud/services/zj/v20190121/zj_models.js +0 -18
  99. package/test/zj.v20190121.test.js +0 -231
@@ -1,1415 +0,0 @@
1
- /*
2
- * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing,
11
- * software distributed under the License is distributed on an
12
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
- * KIND, either express or implied. See the License for the
14
- * specific language governing permissions and limitations
15
- * under the License.
16
- */
17
-
18
- /**
19
- * ModifySmsTemplate返回参数结构体
20
- */
21
- export interface ModifySmsTemplateResponse {
22
- /**
23
- * 返回
24
- */
25
- Data?: ModifySmsTemplateDataStruct
26
- /**
27
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
28
- */
29
- RequestId?: string
30
- }
31
-
32
- /**
33
- * 添加短信人群包信息接口返回
34
- */
35
- export interface SmsAddCrowdPackInfoResponse {
36
- /**
37
- * 人群包id
38
- */
39
- ID: number
40
- }
41
-
42
- /**
43
- * PushMmsContent返回参数结构体
44
- */
45
- export interface PushMmsContentResponse {
46
- /**
47
- * 推送短信返回信息
48
- */
49
- Data?: PushMmsContentResp
50
- /**
51
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
52
- */
53
- RequestId?: string
54
- }
55
-
56
- /**
57
- * 短信模板创建接口返回
58
- */
59
- export interface AddSmsTemplateDataStruct {
60
- /**
61
- * 短信模板ID
62
- */
63
- TemplateId: number
64
- }
65
-
66
- /**
67
- * DescribeMmsInstanceList请求参数结构体
68
- */
69
- export interface DescribeMmsInstanceListRequest {
70
- /**
71
- * 商户证书
72
- */
73
- License: string
74
- /**
75
- * 偏移量
76
- */
77
- Offset: number
78
- /**
79
- * 返回数量
80
- */
81
- Limit: number
82
- /**
83
- * 业务代码
84
- */
85
- AppSubId?: string
86
- /**
87
- * 实例标题
88
- */
89
- Title?: string
90
- }
91
-
92
- /**
93
- * DescribeMmsInstanceInfo返回参数结构体
94
- */
95
- export interface DescribeMmsInstanceInfoResponse {
96
- /**
97
- * 彩信实例信息
98
- */
99
- Data?: MmsInstanceInfo
100
- /**
101
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
102
- */
103
- RequestId?: string
104
- }
105
-
106
- /**
107
- * 发送短信返回
108
- */
109
- export interface SendSmsPaasDataStruct {
110
- /**
111
- * 发送流水号
112
- */
113
- SerialNo: string
114
- /**
115
- * 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
116
- */
117
- PhoneNumber: string
118
- /**
119
- * 计费条数
120
- */
121
- Fee: number
122
- /**
123
- * OK为成功
124
- */
125
- Code: string
126
- /**
127
- * 短信请求错误码描述
128
- */
129
- Message: string
130
- }
131
-
132
- /**
133
- * AddCrowdPackInfo返回参数结构体
134
- */
135
- export interface AddCrowdPackInfoResponse {
136
- /**
137
- * 接口返回
138
- */
139
- Data?: SmsAddCrowdPackInfoResponse
140
- /**
141
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
142
- */
143
- RequestId?: string
144
- }
145
-
146
- /**
147
- * AddSmsSign请求参数结构体
148
- */
149
- export interface AddSmsSignRequest {
150
- /**
151
- * 商户证书
152
- */
153
- License: string
154
- /**
155
- * 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
156
- 0:公司(0,1,2,3)。
157
- 1:APP(0,1,2,3,4) 。
158
- 2:网站(0,1,2,3,5)。
159
- 3:公众号或者小程序(0,1,2,3,6)。
160
- 4:商标(7)。
161
- 5:政府/机关事业单位/其他机构(2,3)。
162
- 注:必须按照对应关系选择证明类型,否则会审核失败。
163
- */
164
- SignType: number
165
- /**
166
- * 证明类型:
167
- 0:三证合一。
168
- 1:企业营业执照。
169
- 2:组织机构代码证书。
170
- 3:社会信用代码证书。
171
- 4:应用后台管理截图(个人开发APP)。
172
- 5:网站备案后台截图(个人开发网站)。
173
- 6:小程序设置页面截图(个人认证小程序)。
174
- 7:商标注册书
175
- */
176
- DocumentType: number
177
- /**
178
- * 是否国际/港澳台短信:
179
- 0:表示国内短信。
180
- 1:表示国际/港澳台短信。
181
- */
182
- International: number
183
- /**
184
- * 资质图片url
185
- */
186
- ProofImage: string
187
- /**
188
- * 签名内容
189
- */
190
- SignName: string
191
- /**
192
- * 签名备注,比如申请原因,使用场景等,可以填空
193
- */
194
- Remark?: string
195
- }
196
-
197
- /**
198
- * AddSmsSign返回参数结构体
199
- */
200
- export interface AddSmsSignResponse {
201
- /**
202
- * 签名id数组
203
- */
204
- Data?: PaasCreateSignResp
205
- /**
206
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
207
- */
208
- RequestId?: string
209
- }
210
-
211
- /**
212
- * GetSmsCampaignStatus请求参数结构体
213
- */
214
- export interface GetSmsCampaignStatusRequest {
215
- /**
216
- * 商户证书
217
- */
218
- License: string
219
- /**
220
- * 活动ID
221
- */
222
- CampaignId: number
223
- }
224
-
225
- /**
226
- * DescribeSmsTemplateList返回参数结构体
227
- */
228
- export interface DescribeSmsTemplateListResponse {
229
- /**
230
- * 返回数据信息
231
- */
232
- Data?: Array<DescribeSmsTemplateListDataStruct>
233
- /**
234
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
235
- */
236
- RequestId?: string
237
- }
238
-
239
- /**
240
- * 彩信实例状态列表
241
- */
242
- export interface MmsInstanceInfoList {
243
- /**
244
- * 总数据量
245
- */
246
- Total: number
247
- /**
248
- * 彩信实例状态信息列表
249
- */
250
- List: Array<MmsInstanceInfo>
251
- }
252
-
253
- /**
254
- * GetCrowdPackList返回参数结构体
255
- */
256
- export interface GetCrowdPackListResponse {
257
- /**
258
- * 人群包信息列表
259
- */
260
- Data?: SmsGetCrowdPackListResponse
261
- /**
262
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
263
- */
264
- RequestId?: string
265
- }
266
-
267
- /**
268
- * 创建超级短信样例返回结果
269
- */
270
- export interface CreateMmsInstanceResp {
271
- /**
272
- * 返回码:0-成功 其它-失败
273
- */
274
- ReturnCode: number
275
- /**
276
- * 返回信息
277
- */
278
- ReturnMsg: string
279
- /**
280
- * 样例id
281
- */
282
- InstanceId: number
283
- }
284
-
285
- /**
286
- * AddSmsTemplate请求参数结构体
287
- */
288
- export interface AddSmsTemplateRequest {
289
- /**
290
- * 商户证书
291
- */
292
- License: string
293
- /**
294
- * 短信签名,创建签名时返回
295
- */
296
- SignID: number
297
- /**
298
- * 模板名称
299
- */
300
- TemplateName: string
301
- /**
302
- * 短信内容,动态内容使用占位符{1},{2}等表示
303
- */
304
- TemplateContent: string
305
- /**
306
- * 短信类型:{0:普通短信,1:营销短信}
307
- */
308
- SmsType: number
309
- /**
310
- * 是否国际/港澳台短信:
311
- 0:表示国内短信。
312
- 1:表示国际/港澳台短信。
313
- */
314
- International: number
315
- /**
316
- * 短信模板标签
317
- */
318
- Remark: string
319
- /**
320
- * 发送短信活动时配置的落地链接地址,仅用作短信活动
321
- */
322
- Urls?: Array<string>
323
- /**
324
- * 发送短信活动时用于展示人群包动态参数模板占位符序号或接口发送时变量占位符序号
325
- */
326
- CommonParams?: Array<number | bigint>
327
- /**
328
- * 发送短信活动时用于展示短连接模板占位符序号,仅用作短信活动
329
- */
330
- UrlParams?: Array<number | bigint>
331
- }
332
-
333
- /**
334
- * DescribeMmsInstanceInfo请求参数结构体
335
- */
336
- export interface DescribeMmsInstanceInfoRequest {
337
- /**
338
- * 商户证书
339
- */
340
- License: string
341
- /**
342
- * 彩信实例id
343
- */
344
- InstanceId: number
345
- }
346
-
347
- /**
348
- * CreateCampaign返回参数结构体
349
- */
350
- export interface CreateCampaignResponse {
351
- /**
352
- * 活动信息
353
- */
354
- Data?: SmsCreateCampaignResponse
355
- /**
356
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
357
- */
358
- RequestId?: string
359
- }
360
-
361
- /**
362
- * 发送超级短信返回
363
- */
364
- export interface PushMmsContentResp {
365
- /**
366
- * 返回码:0-成功 其它-失败
367
- */
368
- ReturnCode: number
369
- /**
370
- * 返回信息
371
- */
372
- ReturnMsg: string
373
- /**
374
- * 消息回执id
375
- */
376
- MessageId: number
377
- }
378
-
379
- /**
380
- * 接口返回给服务商的COS路径等信息
381
- */
382
- export interface UploadFansInfoCosInfo {
383
- /**
384
- * COS bucket
385
- */
386
- Bucket: string
387
- /**
388
- * COS路径
389
- */
390
- Key: string
391
- /**
392
- * COS区域
393
- */
394
- Region: string
395
- }
396
-
397
- /**
398
- * CreateCampaign请求参数结构体
399
- */
400
- export interface CreateCampaignRequest {
401
- /**
402
- * 商户证书
403
- */
404
- License: string
405
- /**
406
- * 短信活动发送时间
407
- */
408
- SendTime: number
409
- /**
410
- * 短信活动名称
411
- */
412
- Name: string
413
- /**
414
- * 发送策略
415
- */
416
- Strategies?: Array<PaasStrategy>
417
- /**
418
- * 废弃
419
- */
420
- TemplateId?: number
421
- /**
422
- * 废弃
423
- */
424
- CrowdID?: number
425
- /**
426
- * 活动类型(0-短信,1-超短,不填默认为超短)
427
- */
428
- SmsType?: number
429
- }
430
-
431
- /**
432
- * 短信子账号额度接口出参
433
- */
434
- export interface SmsAmountDataStruct {
435
- /**
436
- * 短信活动配额
437
- */
438
- SmsCampaignAmount: number
439
- /**
440
- * 短信活动消耗配额
441
- */
442
- SmsCampaignConsume: number
443
- /**
444
- * 短信发送额度
445
- */
446
- SmsSendAmount: number
447
- /**
448
- * 短信发送消耗额度
449
- */
450
- SmsSendConsume: number
451
- /**
452
- * 超短活动额度
453
- */
454
- MmsCampaignAmount: number
455
- /**
456
- * 超短活动消耗额度
457
- */
458
- MmsCampaignConsume: number
459
- /**
460
- * 超短短信额度
461
- */
462
- MmsSendAmount: number
463
- /**
464
- * 超短短信消耗额度
465
- */
466
- MmsSendConsume: number
467
- }
468
-
469
- /**
470
- * AddCrowdPackInfo请求参数结构体
471
- */
472
- export interface AddCrowdPackInfoRequest {
473
- /**
474
- * 商户证书
475
- */
476
- License: string
477
- /**
478
- * 人群包名称
479
- */
480
- Name: string
481
- /**
482
- * 人群包文件名称,人群包文件必须为utf8编码,动态参数只能是汉字、数字、英文字母的组合,不能包含其他字符
483
- */
484
- FileName: string
485
- /**
486
- * 人群包描述
487
- */
488
- Desc: string
489
- /**
490
- * 已经上传好的人群包cos地址
491
- */
492
- CosUrl: string
493
- /**
494
- * 人群包手机号数量
495
- */
496
- PhoneNum?: number
497
- }
498
-
499
- /**
500
- * 短信api成功返回信息
501
- */
502
- export interface SmsSuccessResponse {
503
- /**
504
- * 成功返回信息
505
- */
506
- Message: string
507
- }
508
-
509
- /**
510
- * 短信人群包返回信息
511
- */
512
- export interface SmsGetCrowdPackListResponse {
513
- /**
514
- * 人群包总数
515
- */
516
- Total: number
517
- /**
518
- * 人群包返回数据列表
519
- 注意:此字段可能返回 null,表示取不到有效值。
520
- */
521
- List: Array<SmsGetCrowdPackList>
522
- }
523
-
524
- /**
525
- * 获取短信模板状态返回
526
- */
527
- export interface DescribeSmsTemplateListDataStruct {
528
- /**
529
- * 模板Id
530
- */
531
- TemplateId: number
532
- /**
533
- * 是否国际/港澳台短信:
534
- 0:表示国内短信。
535
- 1:表示国际/港澳台短信。
536
- */
537
- International: number
538
- /**
539
- * 申请签名状态。其中:
540
- 0:表示审核通过。
541
- -1:表示审核未通过或审核失败。
542
- */
543
- StatusCode: number
544
- /**
545
- * 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
546
- */
547
- ReviewReply: string
548
- /**
549
- * 模板名称。
550
- */
551
- TemplateName: string
552
- /**
553
- * 提交审核时间,UNIX 时间戳(单位:秒)。
554
- */
555
- CreateTime: number
556
- }
557
-
558
- /**
559
- * DeleteMmsInstance返回参数结构体
560
- */
561
- export interface DeleteMmsInstanceResponse {
562
- /**
563
- * 删除信息返回
564
- */
565
- Data?: DelMmsInstanceData
566
- /**
567
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
568
- */
569
- RequestId?: string
570
- }
571
-
572
- /**
573
- * ModifySmsTemplate请求参数结构体
574
- */
575
- export interface ModifySmsTemplateRequest {
576
- /**
577
- * 商户证书
578
- */
579
- License: string
580
- /**
581
- * 短信模板id
582
- */
583
- TemplateId: number
584
- /**
585
- * 短信签名,创建签名时返回
586
- */
587
- SignID: number
588
- /**
589
- * 模板名称
590
- */
591
- TemplateName: string
592
- /**
593
- * 短信内容,动态内容使用占位符{1},{2}等表示
594
- */
595
- TemplateContent: string
596
- /**
597
- * 短信类型:{0:普通短信,1:营销短信}
598
- */
599
- SmsType: number
600
- /**
601
- * 是否国际/港澳台短信:
602
- 0:表示国内短信。
603
- 1:表示国际/港澳台短信。
604
- */
605
- International: number
606
- /**
607
- * 短信模板标签
608
- */
609
- Remark: string
610
- /**
611
- * 发送短信活动时配置的落地链接地址,仅用作短信活动
612
- */
613
- Urls?: Array<string>
614
- /**
615
- * 发送短信活动时用于展示人群包动态参数模板占位符序号,仅用作短信活动
616
- */
617
- CommonParams?: Array<number | bigint>
618
- /**
619
- * 发送短信活动时用于展示短连接模板占位符序号,仅用作短信活动
620
- */
621
- UrlParams?: Array<number | bigint>
622
- }
623
-
624
- /**
625
- * 彩信实例审核状态
626
- */
627
- export interface MmsInstanceStateInfo {
628
- /**
629
- * 运营商
630
- */
631
- Operator: string
632
- /**
633
- * 审核状态:0未审核,1审核通过,2审核拒绝
634
- */
635
- State: number
636
- }
637
-
638
- /**
639
- * 取消活动的返回值Data部分
640
- */
641
- export interface CancelActivityData {
642
- /**
643
- * 成功返回时的文字描述
644
- */
645
- Message: string
646
- }
647
-
648
- /**
649
- * SendSms返回参数结构体
650
- */
651
- export interface SendSmsResponse {
652
- /**
653
- * 出参数据
654
- */
655
- Data?: Array<SendSmsPaasDataStruct>
656
- /**
657
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
658
- */
659
- RequestId?: string
660
- }
661
-
662
- /**
663
- * 短信发送人群包策略
664
- */
665
- export interface PaasStrategy {
666
- /**
667
- * 人群包id
668
- */
669
- CrowdID: number
670
- /**
671
- * 待选素材数组
672
- */
673
- Items: Array<PaasStrategyItem>
674
- }
675
-
676
- /**
677
- * CancelCampaign返回参数结构体
678
- */
679
- export interface CancelCampaignResponse {
680
- /**
681
- * 处理结果
682
- */
683
- Data?: CancelActivityData
684
- /**
685
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
686
- */
687
- RequestId?: string
688
- }
689
-
690
- /**
691
- * 短信活动统计人群包数据
692
- */
693
- export interface SmsCampaignStatisticsCrowdData {
694
- /**
695
- * 人群包id
696
- */
697
- CrowdId: number
698
- /**
699
- * 人群包名称
700
- */
701
- CrowdName: string
702
- /**
703
- * 人群包目标触达总数
704
- */
705
- CrowdCount: number
706
- /**
707
- * 模板列表
708
- */
709
- TemplateList: Array<SmsCampaignStatisticsTemplateData>
710
- }
711
-
712
- /**
713
- * DescribeSmsSignList请求参数结构体
714
- */
715
- export interface DescribeSmsSignListRequest {
716
- /**
717
- * 商户证书
718
- */
719
- License: string
720
- /**
721
- * 签名ID数组
722
- */
723
- SignIdSet: Array<number | bigint>
724
- /**
725
- * 是否国际/港澳台短信:
726
- 0:表示国内短信。
727
- 1:表示国际/港澳台短信。
728
- */
729
- International: number
730
- }
731
-
732
- /**
733
- * GetCrowdUploadInfo返回参数结构体
734
- */
735
- export interface GetCrowdUploadInfoResponse {
736
- /**
737
- * 返回信息
738
- */
739
- Data?: SmsGetCrowdUploadInfoResponse
740
- /**
741
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
742
- */
743
- RequestId?: string
744
- }
745
-
746
- /**
747
- * 短信获取人群包列表的返回数据信息
748
- */
749
- export interface SmsGetCrowdPackList {
750
- /**
751
- * 创建时间
752
- */
753
- CreatedAt: string
754
- /**
755
- * 人群包id
756
- */
757
- ID: number
758
- /**
759
- * 人群包名称
760
- */
761
- Name: string
762
- /**
763
- * 人群包状态
764
- */
765
- Status: number
766
- /**
767
- * 人群包手机号数量
768
- */
769
- PhoneNum: number
770
- /**
771
- * 人群包标签信息
772
- */
773
- Tag: string
774
- /**
775
- * 人群包md5
776
- */
777
- MD5: string
778
- /**
779
- * 人群包文件名称
780
- */
781
- FileName: string
782
- /**
783
- * 人群包描述
784
- */
785
- Desc: string
786
- }
787
-
788
- /**
789
- * GetSmsAmountInfo返回参数结构体
790
- */
791
- export interface GetSmsAmountInfoResponse {
792
- /**
793
- * 短信账号额度接口
794
- */
795
- Data?: SmsAmountDataStruct
796
- /**
797
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
798
- */
799
- RequestId?: string
800
- }
801
-
802
- /**
803
- * 获取普通短信签名信息返回信息
804
- */
805
- export interface DescribeSmsSignListDataStruct {
806
- /**
807
- * 签名Id
808
- */
809
- SignId: number
810
- /**
811
- * 是否国际/港澳台短信:
812
- 0:表示国内短信。
813
- 1:表示国际/港澳台短信。
814
- */
815
- International: number
816
- /**
817
- * 申请签名状态。其中:
818
- 0:表示审核通过。
819
- -1:表示审核未通过或审核失败。
820
- */
821
- StatusCode: number
822
- /**
823
- * 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
824
- */
825
- ReviewReply: string
826
- /**
827
- * 签名名称。
828
- */
829
- SignName: string
830
- /**
831
- * 提交审核时间,UNIX 时间戳(单位:秒)。
832
- */
833
- CreateTime: number
834
- }
835
-
836
- /**
837
- * GetCrowdPackList请求参数结构体
838
- */
839
- export interface GetCrowdPackListRequest {
840
- /**
841
- * 商户证书
842
- */
843
- License: string
844
- /**
845
- * 偏移量
846
- */
847
- Offset: number
848
- /**
849
- * 限制返回数量
850
- */
851
- Limit: number
852
- /**
853
- * 人群包名称,用于过滤人群包
854
- */
855
- Name?: string
856
- /**
857
- * 人群包状态,默认-1,用于过滤人群包
858
- */
859
- Status?: number
860
- }
861
-
862
- /**
863
- * AddSmsTemplate返回参数结构体
864
- */
865
- export interface AddSmsTemplateResponse {
866
- /**
867
- * 短信模板创建接口返回
868
- */
869
- Data?: AddSmsTemplateDataStruct
870
- /**
871
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
872
- */
873
- RequestId?: string
874
- }
875
-
876
- /**
877
- * 创建签名返回结构
878
- */
879
- export interface PaasCreateSignResp {
880
- /**
881
- * 签名id
882
- */
883
- SignId: number
884
- }
885
-
886
- /**
887
- * 拉取活动状态返回
888
- */
889
- export interface PaasSmsCampaignStatusResp {
890
- /**
891
- * 0-未发送 1-发送中 2-发送结束 3-发送取消
892
- */
893
- Status: number
894
- }
895
-
896
- /**
897
- * DelCrowdPack返回参数结构体
898
- */
899
- export interface DelCrowdPackResponse {
900
- /**
901
- * 接口返回
902
- */
903
- Data?: SmsSuccessResponse
904
- /**
905
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
906
- */
907
- RequestId?: string
908
- }
909
-
910
- /**
911
- * DelCrowdPack请求参数结构体
912
- */
913
- export interface DelCrowdPackRequest {
914
- /**
915
- * 商户证书
916
- */
917
- License: string
918
- /**
919
- * 人群包id
920
- */
921
- ID: number
922
- }
923
-
924
- /**
925
- * CreateMmsInstance返回参数结构体
926
- */
927
- export interface CreateMmsInstanceResponse {
928
- /**
929
- * 创建样例返回信息
930
- */
931
- Data?: CreateMmsInstanceResp
932
- /**
933
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
934
- */
935
- RequestId?: string
936
- }
937
-
938
- /**
939
- * DescribeSmsTemplateList请求参数结构体
940
- */
941
- export interface DescribeSmsTemplateListRequest {
942
- /**
943
- * 商户证书
944
- */
945
- License: string
946
- /**
947
- * 短信模板id数组
948
- */
949
- TemplateIdSet: Array<number | bigint>
950
- /**
951
- * 是否国际/港澳台短信:
952
- 0:表示国内短信。
953
- 1:表示国际/港澳台短信。
954
- */
955
- International: number
956
- }
957
-
958
- /**
959
- * DeleteMmsInstance请求参数结构体
960
- */
961
- export interface DeleteMmsInstanceRequest {
962
- /**
963
- * 商户证书
964
- */
965
- License: string
966
- /**
967
- * 超级短信样例id
968
- */
969
- InstanceId: number
970
- }
971
-
972
- /**
973
- * 删除超短样例响应
974
- */
975
- export interface DelMmsInstanceData {
976
- /**
977
- * 样例id
978
- */
979
- InstanceId: number
980
- }
981
-
982
- /**
983
- * 短信活动策略元素
984
- */
985
- export interface PaasStrategyItem {
986
- /**
987
- * 短信模板id或超级短信样例id
988
- */
989
- Id: number
990
- /**
991
- * 素材类型 0-普短 1-超短
992
- */
993
- ContentType: number
994
- }
995
-
996
- /**
997
- * GetSmsAmountInfo请求参数结构体
998
- */
999
- export interface GetSmsAmountInfoRequest {
1000
- /**
1001
- * 商户证书
1002
- */
1003
- License: string
1004
- }
1005
-
1006
- /**
1007
- * DelTemplate请求参数结构体
1008
- */
1009
- export interface DelTemplateRequest {
1010
- /**
1011
- * 商户证书
1012
- */
1013
- License: string
1014
- /**
1015
- * 短信模板ID
1016
- */
1017
- TemplateID: number
1018
- }
1019
-
1020
- /**
1021
- * 创建短信活动返回结构
1022
- */
1023
- export interface SmsCreateCampaignResponse {
1024
- /**
1025
- * 活动id
1026
- */
1027
- CampaignId: number
1028
- }
1029
-
1030
- /**
1031
- * 短信模板编辑接口出参
1032
- */
1033
- export interface ModifySmsTemplateDataStruct {
1034
- /**
1035
- * 短信模板id
1036
- 注意:此字段可能返回 null,表示取不到有效值。
1037
- */
1038
- TemplateId: number
1039
- }
1040
-
1041
- /**
1042
- * PushMmsContent请求参数结构体
1043
- */
1044
- export interface PushMmsContentRequest {
1045
- /**
1046
- * 商户证书
1047
- */
1048
- License: string
1049
- /**
1050
- * 素材样例id
1051
- */
1052
- InstanceId: number
1053
- /**
1054
- * 手机号
1055
- */
1056
- Tel: string
1057
- /**
1058
- * 附带数据字段
1059
- */
1060
- Session?: string
1061
- /**
1062
- * 动态参数key(即申请样例时设置的u_或p_开头的动态参数,要求序号有序)
1063
- */
1064
- DynamicParaKey?: Array<string>
1065
- /**
1066
- * 动态参数值,和DynamicParaKey对应
1067
- */
1068
- DynamicParaValue?: Array<string>
1069
- }
1070
-
1071
- /**
1072
- * DescribeMmsInstanceList返回参数结构体
1073
- */
1074
- export interface DescribeMmsInstanceListResponse {
1075
- /**
1076
- * 彩信实例信息列表返回
1077
- */
1078
- Data?: MmsInstanceInfoList
1079
- /**
1080
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1081
- */
1082
- RequestId?: string
1083
- }
1084
-
1085
- /**
1086
- * 创建样例时候content元素
1087
- */
1088
- export interface CreateMmsInstanceItem {
1089
- /**
1090
- * 素材类型:1-文本 2-图片 3-视频 4-音频
1091
- */
1092
- ContentType: number
1093
- /**
1094
- * 素材内容:如果素材是文本类型,直接填写文本内容,否则填写素材文件上传到cos后的url地址
1095
- */
1096
- Content: string
1097
- }
1098
-
1099
- /**
1100
- * GetCrowdUploadInfo请求参数结构体
1101
- */
1102
- export interface GetCrowdUploadInfoRequest {
1103
- /**
1104
- * 商户证书
1105
- */
1106
- License: string
1107
- /**
1108
- * 上传文件名称
1109
- */
1110
- FileName: string
1111
- }
1112
-
1113
- /**
1114
- * CancelCampaign请求参数结构体
1115
- */
1116
- export interface CancelCampaignRequest {
1117
- /**
1118
- * 商户证书
1119
- */
1120
- License: string
1121
- /**
1122
- * 短信活动id
1123
- */
1124
- CampaignId: number
1125
- }
1126
-
1127
- /**
1128
- * 短信活动统计响应
1129
- */
1130
- export interface SmsCampaignStatisticsData {
1131
- /**
1132
- * 活动Id
1133
- */
1134
- CampaignId: number
1135
- /**
1136
- * 统计数据
1137
- */
1138
- Statistics: Array<SmsCampaignStatisticsCrowdData>
1139
- }
1140
-
1141
- /**
1142
- * 彩信实例信息
1143
- InstanceId int
1144
- InstanceName string
1145
- Status int
1146
- StatusInfo string
1147
- AppSubId string
1148
- Title string
1149
- Sign string
1150
- Contents string
1151
- CreatedAt string
1152
- */
1153
- export interface MmsInstanceInfo {
1154
- /**
1155
- * 彩信实例id
1156
- */
1157
- InstanceId: number
1158
- /**
1159
- * 彩信实例名称
1160
- */
1161
- InstanceName: string
1162
- /**
1163
- * 状态是否通知
1164
- */
1165
- Status: number
1166
- /**
1167
- * 实例审核状态信息
1168
- 注意:此字段可能返回 null,表示取不到有效值。
1169
- */
1170
- StatusInfo: Array<MmsInstanceStateInfo>
1171
- /**
1172
- * 业务码
1173
- */
1174
- AppSubId: string
1175
- /**
1176
- * 彩信标题
1177
- */
1178
- Title: string
1179
- /**
1180
- * 签名
1181
- */
1182
- Sign: string
1183
- /**
1184
- * 彩信内容
1185
- */
1186
- Contents: string
1187
- /**
1188
- * 创建时间
1189
- */
1190
- CreatedAt: string
1191
- /**
1192
- * 样例配置的链接地址
1193
- 注意:此字段可能返回 null,表示取不到有效值。
1194
- */
1195
- Urls: Array<string>
1196
- /**
1197
- * 机型列表
1198
- 注意:此字段可能返回 null,表示取不到有效值。
1199
- */
1200
- PhoneType: Array<number | bigint>
1201
- /**
1202
- * 普通参数序号数组
1203
- 注意:此字段可能返回 null,表示取不到有效值。
1204
- */
1205
- CommonParams: Array<number | bigint>
1206
- /**
1207
- * 链接参数序号数组
1208
- 注意:此字段可能返回 null,表示取不到有效值。
1209
- */
1210
- UrlParams: Array<number | bigint>
1211
- }
1212
-
1213
- /**
1214
- * DelTemplate返回参数结构体
1215
- */
1216
- export interface DelTemplateResponse {
1217
- /**
1218
- * 接口返回
1219
- */
1220
- Data?: SmsSuccessResponse
1221
- /**
1222
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1223
- */
1224
- RequestId?: string
1225
- }
1226
-
1227
- /**
1228
- * 获取短信人群包上传信息返回
1229
- */
1230
- export interface SmsGetCrowdUploadInfoResponse {
1231
- /**
1232
- * 过期时间
1233
- */
1234
- ExpiredTime: number
1235
- /**
1236
- * 会话token
1237
- */
1238
- SessionToken: string
1239
- /**
1240
- * 临时密钥id
1241
- */
1242
- TmpSecretId: string
1243
- /**
1244
- * 临时密钥
1245
- */
1246
- TmpSecretKey: string
1247
- /**
1248
- * cos信息
1249
- */
1250
- CosInfo: UploadFansInfoCosInfo
1251
- }
1252
-
1253
- /**
1254
- * CreateMmsInstance请求参数结构体
1255
- */
1256
- export interface CreateMmsInstanceRequest {
1257
- /**
1258
- * 商户证书
1259
- */
1260
- License: string
1261
- /**
1262
- * 样例名称
1263
- */
1264
- InstanceName: string
1265
- /**
1266
- * 标题
1267
- */
1268
- Title: string
1269
- /**
1270
- * 签名
1271
- */
1272
- Sign: string
1273
- /**
1274
- * 素材内容
1275
- */
1276
- Contents: Array<CreateMmsInstanceItem>
1277
- /**
1278
- * 样例中链接动态变量对应的链接,和占位符顺序一致
1279
- */
1280
- Urls?: Array<string>
1281
- /**
1282
- * 机型列表
1283
- */
1284
- PhoneType?: Array<number | bigint>
1285
- /**
1286
- * 发送超短活动时用于展示人群包动态参数模板占位符序号或接口发送时变量占位符序号
1287
- */
1288
- CommonParams?: Array<number | bigint>
1289
- /**
1290
- * 发送超短活动时用于展示短连接模板占位符序号,仅用作超短活动
1291
- */
1292
- UrlParams?: Array<number | bigint>
1293
- }
1294
-
1295
- /**
1296
- * DescribeSmsSignList返回参数结构体
1297
- */
1298
- export interface DescribeSmsSignListResponse {
1299
- /**
1300
- * 返回数据
1301
- */
1302
- Data?: Array<DescribeSmsSignListDataStruct>
1303
- /**
1304
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1305
- */
1306
- RequestId?: string
1307
- }
1308
-
1309
- /**
1310
- * DescribeSmsCampaignStatistics返回参数结构体
1311
- */
1312
- export interface DescribeSmsCampaignStatisticsResponse {
1313
- /**
1314
- * 响应数据
1315
- */
1316
- Data?: SmsCampaignStatisticsData
1317
- /**
1318
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1319
- */
1320
- RequestId?: string
1321
- }
1322
-
1323
- /**
1324
- * GetSmsCampaignStatus返回参数结构体
1325
- */
1326
- export interface GetSmsCampaignStatusResponse {
1327
- /**
1328
- * 活动状态
1329
- */
1330
- Data?: PaasSmsCampaignStatusResp
1331
- /**
1332
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1333
- */
1334
- RequestId?: string
1335
- }
1336
-
1337
- /**
1338
- * DescribeSmsCampaignStatistics请求参数结构体
1339
- */
1340
- export interface DescribeSmsCampaignStatisticsRequest {
1341
- /**
1342
- * 活动id
1343
- */
1344
- CampaignId: number
1345
- /**
1346
- * 商户证书
1347
- */
1348
- License: string
1349
- }
1350
-
1351
- /**
1352
- * SendSms请求参数结构体
1353
- */
1354
- export interface SendSmsRequest {
1355
- /**
1356
- * 商户证书
1357
- */
1358
- License: string
1359
- /**
1360
- * 手机号码,采用 e.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号,如:+8613800138000
1361
- */
1362
- Phone: Array<string>
1363
- /**
1364
- * 短信模板id(推荐使用模板id发送,使用内容发送时模板id留空)
1365
- */
1366
- TemplateId?: string
1367
- /**
1368
- * 模板参数,若无模板参数,则设置为空。
1369
- */
1370
- Params?: Array<string>
1371
- /**
1372
- * 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名。注:国内短信为必填参数。
1373
- */
1374
- Sign?: string
1375
- /**
1376
- * 国际/港澳台短信 senderid,国内短信填空
1377
- */
1378
- SenderId?: string
1379
- /**
1380
- * 短信类型:{0:普通短信,1:营销短信},使用内容发送时必填
1381
- */
1382
- SmsType?: number
1383
- /**
1384
- * 是否国际/港澳台短信:
1385
- 0:表示国内短信。
1386
- 1:表示国际/港澳台短信。使用内容发送时必填
1387
- */
1388
- International?: number
1389
- /**
1390
- * 发送使用的模板内容,如果有占位符,此处也包括占位符,占位符的实际内容通过Params参数传递,使用模板id发送时此字段为空
1391
- */
1392
- Content?: string
1393
- }
1394
-
1395
- /**
1396
- * 短信活动统计模板展示结构
1397
- */
1398
- export interface SmsCampaignStatisticsTemplateData {
1399
- /**
1400
- * 模板或样例id
1401
- */
1402
- TemplateId: string
1403
- /**
1404
- * 模板内容
1405
- */
1406
- TemplateContent: string
1407
- /**
1408
- * 触达成功数
1409
- */
1410
- SendCount: number
1411
- /**
1412
- * 短链点击数
1413
- */
1414
- ClickCount: number
1415
- }