tencentcloud-sdk-nodejs 4.0.701 → 4.0.703

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