tencentcloud-sdk-nodejs 4.0.223 → 4.0.227
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.
- package/CHANGELOG.md +425 -99
- package/README.md +2 -2
- package/package.json +1 -1
- package/products.md +22 -22
- package/src/common/sdk_version.ts +1 -1
- package/src/services/aa/v20200224/aa_models.ts +15 -22
- package/src/services/advisor/v20200721/advisor_models.ts +7 -1
- package/src/services/as/v20180419/as_models.ts +2 -6
- package/src/services/ccc/v20200210/ccc_models.ts +49 -7
- package/src/services/cdb/v20170320/cdb_client.ts +2 -14
- package/src/services/cdb/v20170320/cdb_models.ts +49 -49
- package/src/services/cdn/v20180606/cdn_client.ts +72 -18
- package/src/services/cdn/v20180606/cdn_models.ts +706 -165
- package/src/services/cls/v20201016/cls_client.ts +3 -18
- package/src/services/cls/v20201016/cls_models.ts +16 -1
- package/src/services/cme/v20191029/cme_models.ts +5 -0
- package/src/services/cwp/v20180228/cwp_models.ts +4 -5
- package/src/services/faceid/v20180301/faceid_models.ts +25 -9
- package/src/services/ims/v20201229/ims_models.ts +10 -0
- package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +6 -6
- package/src/services/mongodb/v20190725/mongodb_models.ts +1 -1
- package/src/services/monitor/v20180724/monitor_models.ts +1 -1
- package/src/services/ses/v20201002/ses_client.ts +32 -18
- package/src/services/ses/v20201002/ses_models.ts +149 -52
- package/src/services/taf/v20200210/taf_client.ts +3 -2
- package/src/services/taf/v20200210/taf_models.ts +48 -8
- package/src/services/tdmq/v20200217/tdmq_client.ts +282 -71
- package/src/services/tdmq/v20200217/tdmq_models.ts +856 -144
- package/src/services/tem/v20210701/tem_models.ts +5 -0
- package/src/services/tiia/v20190529/tiia_client.ts +78 -3
- package/src/services/tiia/v20190529/tiia_models.ts +397 -29
- package/src/services/tiw/v20190919/tiw_client.ts +17 -1
- package/src/services/tiw/v20190919/tiw_models.ts +82 -5
- package/src/services/trtc/v20190722/trtc_client.ts +3 -40
- package/src/services/trtc/v20190722/trtc_models.ts +43 -187
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/aa/v20200224/aa_models.d.ts +13 -20
- package/tencentcloud/services/advisor/v20200721/advisor_models.d.ts +6 -1
- package/tencentcloud/services/as/v20180419/as_models.d.ts +2 -6
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +40 -6
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +1 -5
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +0 -6
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +41 -43
- package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +26 -3
- package/tencentcloud/services/cdn/v20180606/cdn_client.js +32 -3
- package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +622 -150
- package/tencentcloud/services/cls/v20201016/cls_client.d.ts +3 -18
- package/tencentcloud/services/cls/v20201016/cls_client.js +2 -17
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +14 -1
- package/tencentcloud/services/cme/v20191029/cme_models.d.ts +4 -0
- package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +3 -4
- package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +22 -9
- package/tencentcloud/services/ims/v20201229/ims_models.d.ts +8 -0
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +6 -6
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +1 -1
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +1 -1
- package/tencentcloud/services/ses/v20201002/ses_client.d.ts +10 -6
- package/tencentcloud/services/ses/v20201002/ses_client.js +13 -7
- package/tencentcloud/services/ses/v20201002/ses_models.d.ts +129 -47
- package/tencentcloud/services/taf/v20200210/taf_client.d.ts +1 -1
- package/tencentcloud/services/taf/v20200210/taf_client.js +1 -1
- package/tencentcloud/services/taf/v20200210/taf_models.d.ts +39 -7
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +89 -21
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +132 -30
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +728 -124
- package/tencentcloud/services/tem/v20210701/tem_models.d.ts +4 -0
- package/tencentcloud/services/tiia/v20190529/tiia_client.d.ts +26 -1
- package/tencentcloud/services/tiia/v20190529/tiia_client.js +37 -0
- package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +341 -28
- package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +8 -1
- package/tencentcloud/services/tiw/v20190919/tiw_client.js +9 -0
- package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +72 -5
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +1 -13
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +0 -18
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +39 -163
- package/test/cdb.v20170320.test.js +0 -10
- package/test/cdn.v20180606.test.js +32 -2
- package/test/ses.v20201002.test.js +14 -4
- package/test/tdmq.v20200217.test.js +190 -20
- package/test/tiia.v20190529.test.js +60 -0
- package/test/tiw.v20190919.test.js +10 -0
- package/test/trtc.v20190722.test.js +0 -30
|
@@ -172,24 +172,9 @@ export declare class Client extends AbstractClient {
|
|
|
172
172
|
系统根据携带的哈希值(X-CLS-HashKey)将数据写入到符合范围要求的目标分区。例如,可以将某个日志源端通过 hashkey 与某个主题分区强绑定,这样可以保证数据在该分区上写入和消费是严格保序的。
|
|
173
173
|
|
|
174
174
|
此外日志服务还为用户提供以下两种不同的日志上传模式:
|
|
175
|
+
|
|
175
176
|
|
|
176
|
-
|
|
177
|
-
## 请求
|
|
178
|
-
|
|
179
|
-
#### 请求头业务参数
|
|
180
|
-
|
|
181
|
-
X-CLS-HashKey 请求头表示日志根据 hashkey 路由写入到 CLS 对应范围的主题分区,以保证写入到的每个主题分区是严格有序的,便于消费时有序消费。
|
|
182
|
-
|
|
183
|
-
| 字段名 | 类型 | 位置 | 是否必须 | 含义 |
|
|
184
|
-
| ------------------ | ------ | ------ | -------- | ------------------------------------------------------------ |
|
|
185
|
-
| X-CLS-HashKey | string | header | 否 | 根据 hashkey 写入相应范围的主题分区 |
|
|
186
|
-
| X-CLS-TopicId | String | header | 是 | 主题id | |
|
|
187
|
-
| Content-Type | String | header | 是 | 请求参数的协议类型, 目前只支持pb协议,填写 "application/octet-stream" |
|
|
188
|
-
| X-TC-Action | String | header | 是 | 公共参数,本接口取值:UploadLog。
|
|
189
|
-
| X-TC-Region | String | header | 是 | 公共参数,本接口不需要传递此参数。
|
|
190
|
-
| X-TC-Version | String | header | 是 | 公共参数,本接口取值:2020-10-16。
|
|
191
|
-
|
|
192
|
-
#### 输入参数(pb协议)
|
|
177
|
+
#### 输入参数(pb二进制流,位于body中)
|
|
193
178
|
|
|
194
179
|
| 字段名 | 类型 | 位置 | 必须 | 含义 |
|
|
195
180
|
| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
|
|
@@ -322,7 +307,7 @@ cls.pb.cc cls.pb.h cls.proto
|
|
|
322
307
|
|
|
323
308
|
将生成的 cls.pb.h 头文件引入代码中,调用接口进行数据格式封装。
|
|
324
309
|
*/
|
|
325
|
-
UploadLog(req
|
|
310
|
+
UploadLog(req: UploadLogRequest, cb?: (error: string, rep: UploadLogResponse) => void): Promise<UploadLogResponse>;
|
|
326
311
|
/**
|
|
327
312
|
* 本接口用于创建离线上下文任务
|
|
328
313
|
*/
|
|
@@ -266,24 +266,9 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
266
266
|
系统根据携带的哈希值(X-CLS-HashKey)将数据写入到符合范围要求的目标分区。例如,可以将某个日志源端通过 hashkey 与某个主题分区强绑定,这样可以保证数据在该分区上写入和消费是严格保序的。
|
|
267
267
|
|
|
268
268
|
此外日志服务还为用户提供以下两种不同的日志上传模式:
|
|
269
|
+
|
|
269
270
|
|
|
270
|
-
|
|
271
|
-
## 请求
|
|
272
|
-
|
|
273
|
-
#### 请求头业务参数
|
|
274
|
-
|
|
275
|
-
X-CLS-HashKey 请求头表示日志根据 hashkey 路由写入到 CLS 对应范围的主题分区,以保证写入到的每个主题分区是严格有序的,便于消费时有序消费。
|
|
276
|
-
|
|
277
|
-
| 字段名 | 类型 | 位置 | 是否必须 | 含义 |
|
|
278
|
-
| ------------------ | ------ | ------ | -------- | ------------------------------------------------------------ |
|
|
279
|
-
| X-CLS-HashKey | string | header | 否 | 根据 hashkey 写入相应范围的主题分区 |
|
|
280
|
-
| X-CLS-TopicId | String | header | 是 | 主题id | |
|
|
281
|
-
| Content-Type | String | header | 是 | 请求参数的协议类型, 目前只支持pb协议,填写 "application/octet-stream" |
|
|
282
|
-
| X-TC-Action | String | header | 是 | 公共参数,本接口取值:UploadLog。
|
|
283
|
-
| X-TC-Region | String | header | 是 | 公共参数,本接口不需要传递此参数。
|
|
284
|
-
| X-TC-Version | String | header | 是 | 公共参数,本接口取值:2020-10-16。
|
|
285
|
-
|
|
286
|
-
#### 输入参数(pb协议)
|
|
271
|
+
#### 输入参数(pb二进制流,位于body中)
|
|
287
272
|
|
|
288
273
|
| 字段名 | 类型 | 位置 | 必须 | 含义 |
|
|
289
274
|
| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
|
|
@@ -271,7 +271,20 @@ export interface DescribeAsyncContextResultResponse {
|
|
|
271
271
|
/**
|
|
272
272
|
* UploadLog请求参数结构体
|
|
273
273
|
*/
|
|
274
|
-
export
|
|
274
|
+
export interface UploadLogRequest {
|
|
275
|
+
/**
|
|
276
|
+
* 主题id
|
|
277
|
+
*/
|
|
278
|
+
TopicId: string;
|
|
279
|
+
/**
|
|
280
|
+
* 根据 hashkey 写入相应范围的主题分区
|
|
281
|
+
*/
|
|
282
|
+
HashKey?: string;
|
|
283
|
+
/**
|
|
284
|
+
* 压缩方法
|
|
285
|
+
*/
|
|
286
|
+
CompressType?: string;
|
|
287
|
+
}
|
|
275
288
|
/**
|
|
276
289
|
* CreateAsyncContextTask请求参数结构体
|
|
277
290
|
*/
|
|
@@ -908,6 +908,10 @@ export interface ExportVideoByEditorTrackDataRequest {
|
|
|
908
908
|
* 在线编辑轨道数据。轨道数据相关介绍,请查看 [视频合成协议](https://cloud.tencent.com/document/product/1156/51225)。
|
|
909
909
|
*/
|
|
910
910
|
TrackData: string;
|
|
911
|
+
/**
|
|
912
|
+
* 轨道数据对应的画布宽高比。
|
|
913
|
+
*/
|
|
914
|
+
AspectRatio?: string;
|
|
911
915
|
/**
|
|
912
916
|
* 视频封面图片文件(如 jpeg, png 等)进行 Base64 编码后的字符串,仅支持 gif、jpeg、png 三种图片格式,原图片文件不能超过2 M大 小。
|
|
913
917
|
*/
|
|
@@ -479,7 +479,7 @@ export interface BaselineEffectHost {
|
|
|
479
479
|
*/
|
|
480
480
|
LastScanTime: string;
|
|
481
481
|
/**
|
|
482
|
-
*
|
|
482
|
+
* 风险项处理状态状态:0-未通过,1-通过
|
|
483
483
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
484
484
|
*/
|
|
485
485
|
Status: number;
|
|
@@ -1135,7 +1135,7 @@ export interface DescribeAvailableExpertServiceDetailResponse {
|
|
|
1135
1135
|
*/
|
|
1136
1136
|
EmergencyResponseBuy: boolean;
|
|
1137
1137
|
/**
|
|
1138
|
-
*
|
|
1138
|
+
* 是否购买过旗舰护网
|
|
1139
1139
|
*/
|
|
1140
1140
|
ProtectNetBuy: boolean;
|
|
1141
1141
|
/**
|
|
@@ -3451,8 +3451,7 @@ export interface DescribeAssetEnvListRequest {
|
|
|
3451
3451
|
*/
|
|
3452
3452
|
Offset?: number;
|
|
3453
3453
|
/**
|
|
3454
|
-
*
|
|
3455
|
-
0
|
|
3454
|
+
* 该字段已废弃,由Filters代替
|
|
3456
3455
|
*/
|
|
3457
3456
|
Type?: number;
|
|
3458
3457
|
/**
|
|
@@ -72,6 +72,11 @@ export interface GetFaceIdTokenRequest {
|
|
|
72
72
|
* 透传参数 1000长度字符串
|
|
73
73
|
*/
|
|
74
74
|
Extra?: string;
|
|
75
|
+
/**
|
|
76
|
+
* 默认为false,设置该参数为true后,核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中,拉取结果时会返回对应资源完整cos地址。开通地址见https://console.cloud.tencent.com/faceid/cos
|
|
77
|
+
【注意】选择该参数为true后将不返回base64数据,请根据接入情况谨慎修改。
|
|
78
|
+
*/
|
|
79
|
+
UseCos?: boolean;
|
|
75
80
|
}
|
|
76
81
|
/**
|
|
77
82
|
* Liveness请求参数结构体
|
|
@@ -270,12 +275,12 @@ export interface CheckBankCardInformationResponse {
|
|
|
270
275
|
*/
|
|
271
276
|
export interface DetectInfoBestFrame {
|
|
272
277
|
/**
|
|
273
|
-
*
|
|
278
|
+
* 活体比对最佳帧Base64编码。
|
|
274
279
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
275
280
|
*/
|
|
276
281
|
BestFrame: string;
|
|
277
282
|
/**
|
|
278
|
-
*
|
|
283
|
+
* 自截帧Base64编码数组。
|
|
279
284
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
280
285
|
*/
|
|
281
286
|
BestFrames: Array<string>;
|
|
@@ -735,7 +740,7 @@ LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模
|
|
|
735
740
|
Encryption?: Encryption;
|
|
736
741
|
}
|
|
737
742
|
/**
|
|
738
|
-
* Eid
|
|
743
|
+
* Eid出参,包括商户方用户的标识和加密的用户姓名身份证信息。
|
|
739
744
|
*/
|
|
740
745
|
export interface EidInfo {
|
|
741
746
|
/**
|
|
@@ -743,9 +748,17 @@ export interface EidInfo {
|
|
|
743
748
|
*/
|
|
744
749
|
EidCode: string;
|
|
745
750
|
/**
|
|
746
|
-
*
|
|
751
|
+
* Eid中心针对商户方EidCode的电子签名
|
|
747
752
|
*/
|
|
748
753
|
EidSign: string;
|
|
754
|
+
/**
|
|
755
|
+
* 商户方公钥加密的会话密钥的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
|
|
756
|
+
*/
|
|
757
|
+
DesKey: string;
|
|
758
|
+
/**
|
|
759
|
+
* 会话密钥sm2加密后的base64字符串,[指引详见](https://cloud.tencent.com/document/product/1007/63370)
|
|
760
|
+
*/
|
|
761
|
+
UserInfo: string;
|
|
749
762
|
}
|
|
750
763
|
/**
|
|
751
764
|
* GetFaceIdToken返回参数结构体
|
|
@@ -754,7 +767,7 @@ export interface GetFaceIdTokenResponse {
|
|
|
754
767
|
/**
|
|
755
768
|
* 有效期 10分钟。只能完成1次核身。
|
|
756
769
|
*/
|
|
757
|
-
FaceIdToken
|
|
770
|
+
FaceIdToken: string;
|
|
758
771
|
/**
|
|
759
772
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
760
773
|
*/
|
|
@@ -1157,7 +1170,7 @@ export interface CheckEidTokenStatusRequest {
|
|
|
1157
1170
|
*/
|
|
1158
1171
|
export interface GetEidResultResponse {
|
|
1159
1172
|
/**
|
|
1160
|
-
*
|
|
1173
|
+
* 文本类信息。(基于对敏感信息的保护,验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回,如需获取请在控制台申请返回身份信息,详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
|
|
1161
1174
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1162
1175
|
*/
|
|
1163
1176
|
Text: DetectInfoText;
|
|
@@ -1172,7 +1185,7 @@ export interface GetEidResultResponse {
|
|
|
1172
1185
|
*/
|
|
1173
1186
|
BestFrame: DetectInfoBestFrame;
|
|
1174
1187
|
/**
|
|
1175
|
-
* Eid
|
|
1188
|
+
* Eid信息。(包括商户下用户唯一标识以及加密后的姓名、身份证号信息。解密方式详见[E证通获取实名信息指引](https://cloud.tencent.com/document/product/1007/63370))
|
|
1176
1189
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1177
1190
|
*/
|
|
1178
1191
|
EidInfo: EidInfo;
|
|
@@ -1801,12 +1814,12 @@ export interface GetFaceIdResultResponse {
|
|
|
1801
1814
|
*/
|
|
1802
1815
|
Similarity: number;
|
|
1803
1816
|
/**
|
|
1804
|
-
* 用户核验的视频
|
|
1817
|
+
* 用户核验的视频base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
|
|
1805
1818
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1806
1819
|
*/
|
|
1807
1820
|
VideoBase64: string;
|
|
1808
1821
|
/**
|
|
1809
|
-
* 用户核验视频的截帧
|
|
1822
|
+
* 用户核验视频的截帧base64,如果选择了使用cos,返回完整cos地址如https://bucket.cos.ap-guangzhou.myqcloud.com/objectKey
|
|
1810
1823
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1811
1824
|
*/
|
|
1812
1825
|
BestFrameBase64: string;
|
|
@@ -107,6 +107,10 @@ export interface OcrTextDetail {
|
|
|
107
107
|
* 该参数用于返回OCR文本识别结果的置信度,取值在**0**(**置信度最低**)-**100**(**置信度最高**),越高代表对应图像越有可能是识别出的文字;如:*你好 99*,则表明OCR识别框内的文字大概率是”你好“。
|
|
108
108
|
*/
|
|
109
109
|
Rate: number;
|
|
110
|
+
/**
|
|
111
|
+
* 该字段用于返回检测结果所对应的恶意二级标签。
|
|
112
|
+
*/
|
|
113
|
+
SubLabel: string;
|
|
110
114
|
}
|
|
111
115
|
/**
|
|
112
116
|
* 实体检测结果明细,当检测场景为实体、广告台标、二维码时表示模型检测目标框的标签名称、标签值、标签分数以及检测框的位置信息。
|
|
@@ -132,6 +136,10 @@ export interface ObjectDetail {
|
|
|
132
136
|
* 该字段用于返回实体检测框的坐标位置(左上角xy坐标、长宽、旋转角度)以方便快速定位实体的相关信息。
|
|
133
137
|
*/
|
|
134
138
|
Location: Location;
|
|
139
|
+
/**
|
|
140
|
+
* 该参数用于返回命中的实体二级标签。
|
|
141
|
+
*/
|
|
142
|
+
SubLabel: string;
|
|
135
143
|
}
|
|
136
144
|
/**
|
|
137
145
|
* 用于返回OCR结果检测详情
|
|
@@ -1311,16 +1311,16 @@ export interface CallDeviceActionSyncResponse {
|
|
|
1311
1311
|
/**
|
|
1312
1312
|
* 调用Id
|
|
1313
1313
|
*/
|
|
1314
|
-
ClientToken
|
|
1314
|
+
ClientToken: string;
|
|
1315
1315
|
/**
|
|
1316
1316
|
* 输出参数
|
|
1317
1317
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1318
1318
|
*/
|
|
1319
|
-
OutputParams
|
|
1319
|
+
OutputParams: string;
|
|
1320
1320
|
/**
|
|
1321
|
-
*
|
|
1321
|
+
* 返回状态,当设备不在线等部分情况,会通过该 Status 返回。
|
|
1322
1322
|
*/
|
|
1323
|
-
Status
|
|
1323
|
+
Status: string;
|
|
1324
1324
|
/**
|
|
1325
1325
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1326
1326
|
*/
|
|
@@ -2104,11 +2104,11 @@ export interface CallDeviceActionAsyncResponse {
|
|
|
2104
2104
|
/**
|
|
2105
2105
|
* 调用Id
|
|
2106
2106
|
*/
|
|
2107
|
-
ClientToken
|
|
2107
|
+
ClientToken: string;
|
|
2108
2108
|
/**
|
|
2109
2109
|
* 异步调用状态
|
|
2110
2110
|
*/
|
|
2111
|
-
Status
|
|
2111
|
+
Status: string;
|
|
2112
2112
|
/**
|
|
2113
2113
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2114
2114
|
*/
|
|
@@ -443,7 +443,7 @@ export interface CreateAlarmPolicyRequest {
|
|
|
443
443
|
*/
|
|
444
444
|
MonitorType: string;
|
|
445
445
|
/**
|
|
446
|
-
* 告警策略类型,由 [DescribeAllNamespaces](https://cloud.tencent.com/document/product/248/48683)
|
|
446
|
+
* 告警策略类型,由 [DescribeAllNamespaces](https://cloud.tencent.com/document/product/248/48683) 获得。对于云产品监控,取接口出参的 QceNamespacesNew.N.Id,例如 cvm_device
|
|
447
447
|
*/
|
|
448
448
|
Namespace: string;
|
|
449
449
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { ListEmailAddressRequest, GetEmailIdentityResponse, ListBlackEmailAddressRequest, GetSendEmailStatusResponse, SendEmailRequest, DeleteEmailIdentityRequest, UpdateEmailIdentityRequest, GetEmailIdentityRequest, DeleteEmailIdentityResponse, GetStatisticsReportRequest, DeleteEmailTemplateResponse,
|
|
3
|
+
import { BatchSendEmailRequest, GetEmailTemplateRequest, CreateEmailTemplateRequest, ListEmailAddressRequest, GetEmailIdentityResponse, ListBlackEmailAddressRequest, GetSendEmailStatusResponse, SendEmailRequest, BatchSendEmailResponse, DeleteEmailIdentityRequest, UpdateEmailIdentityRequest, GetEmailIdentityRequest, DeleteEmailIdentityResponse, GetStatisticsReportRequest, DeleteEmailTemplateResponse, CreateEmailIdentityRequest, UpdateEmailTemplateRequest, UpdateEmailIdentityResponse, DeleteEmailTemplateRequest, DeleteBlackListResponse, ListEmailTemplatesRequest, DeleteBlackListRequest, ListEmailTemplatesResponse, SendEmailResponse, ListBlackEmailAddressResponse, GetSendEmailStatusRequest, ListEmailIdentitiesResponse, ListEmailAddressResponse, GetStatisticsReportResponse, DeleteEmailAddressRequest, DeleteEmailAddressResponse, CreateEmailIdentityResponse, CreateEmailAddressRequest, CreateEmailTemplateResponse, CreateEmailAddressResponse, UpdateEmailTemplateResponse, GetEmailTemplateResponse, ListEmailIdentitiesRequest } from "./ses_models";
|
|
4
4
|
/**
|
|
5
5
|
* ses client
|
|
6
6
|
* @class
|
|
@@ -29,11 +29,11 @@ export declare class Client extends AbstractClient {
|
|
|
29
29
|
*/
|
|
30
30
|
CreateEmailTemplate(req: CreateEmailTemplateRequest, cb?: (error: string, rep: CreateEmailTemplateResponse) => void): Promise<CreateEmailTemplateResponse>;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
|
|
33
33
|
*/
|
|
34
|
-
|
|
34
|
+
BatchSendEmail(req: BatchSendEmailRequest, cb?: (error: string, rep: BatchSendEmailResponse) => void): Promise<BatchSendEmailResponse>;
|
|
35
35
|
/**
|
|
36
|
-
* 您可以通过此API发送TEXT或者HTML
|
|
36
|
+
* 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。
|
|
37
37
|
*/
|
|
38
38
|
SendEmail(req: SendEmailRequest, cb?: (error: string, rep: SendEmailResponse) => void): Promise<SendEmailResponse>;
|
|
39
39
|
/**
|
|
@@ -41,13 +41,17 @@ export declare class Client extends AbstractClient {
|
|
|
41
41
|
*/
|
|
42
42
|
ListEmailIdentities(req?: ListEmailIdentitiesRequest, cb?: (error: string, rep: ListEmailIdentitiesResponse) => void): Promise<ListEmailIdentitiesResponse>;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* 获取近期发送的统计情况,包含发送量、送达率、打开率、退信率等一系列数据。
|
|
45
45
|
*/
|
|
46
|
-
|
|
46
|
+
GetStatisticsReport(req: GetStatisticsReportRequest, cb?: (error: string, rep: GetStatisticsReportResponse) => void): Promise<GetStatisticsReportResponse>;
|
|
47
47
|
/**
|
|
48
48
|
* 获取邮件发送状态。仅支持查询90天之内的数据
|
|
49
49
|
*/
|
|
50
50
|
GetSendEmailStatus(req: GetSendEmailStatusRequest, cb?: (error: string, rep: GetSendEmailStatusResponse) => void): Promise<GetSendEmailStatusResponse>;
|
|
51
|
+
/**
|
|
52
|
+
* 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce),腾讯云会拉黑该地址,并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判,可以从黑名单中删除。
|
|
53
|
+
*/
|
|
54
|
+
ListBlackEmailAddress(req: ListBlackEmailAddressRequest, cb?: (error: string, rep: ListBlackEmailAddressResponse) => void): Promise<ListBlackEmailAddressResponse>;
|
|
51
55
|
/**
|
|
52
56
|
* 删除发信模版
|
|
53
57
|
*/
|
|
@@ -59,13 +59,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
59
59
|
return this.request("CreateEmailTemplate", req, cb);
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* 您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParam
|
|
63
63
|
*/
|
|
64
|
-
async
|
|
65
|
-
return this.request("
|
|
64
|
+
async BatchSendEmail(req, cb) {
|
|
65
|
+
return this.request("BatchSendEmail", req, cb);
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* 您可以通过此API发送TEXT或者HTML
|
|
68
|
+
* 您可以通过此API发送TEXT或者HTML邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件,如需发送自定义内容,请单独联系商务开通此功能。
|
|
69
69
|
*/
|
|
70
70
|
async SendEmail(req, cb) {
|
|
71
71
|
return this.request("SendEmail", req, cb);
|
|
@@ -77,10 +77,10 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
77
77
|
return this.request("ListEmailIdentities", req, cb);
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
|
-
*
|
|
80
|
+
* 获取近期发送的统计情况,包含发送量、送达率、打开率、退信率等一系列数据。
|
|
81
81
|
*/
|
|
82
|
-
async
|
|
83
|
-
return this.request("
|
|
82
|
+
async GetStatisticsReport(req, cb) {
|
|
83
|
+
return this.request("GetStatisticsReport", req, cb);
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
86
|
* 获取邮件发送状态。仅支持查询90天之内的数据
|
|
@@ -88,6 +88,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
88
88
|
async GetSendEmailStatus(req, cb) {
|
|
89
89
|
return this.request("GetSendEmailStatus", req, cb);
|
|
90
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* 腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce),腾讯云会拉黑该地址,并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判,可以从黑名单中删除。
|
|
93
|
+
*/
|
|
94
|
+
async ListBlackEmailAddress(req, cb) {
|
|
95
|
+
return this.request("ListBlackEmailAddress", req, cb);
|
|
96
|
+
}
|
|
91
97
|
/**
|
|
92
98
|
* 删除发信模版
|
|
93
99
|
*/
|
|
@@ -1,15 +1,96 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* BatchSendEmail请求参数结构体
|
|
3
3
|
*/
|
|
4
|
-
export interface
|
|
4
|
+
export interface BatchSendEmailRequest {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* 发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
|
|
7
|
+
发信人 <邮件地址> 的方式填写,例如:
|
|
8
|
+
腾讯云团队 <noreply@mail.qcloud.com>
|
|
7
9
|
*/
|
|
8
|
-
|
|
10
|
+
FromEmailAddress: string;
|
|
9
11
|
/**
|
|
10
|
-
*
|
|
12
|
+
* 收件人列表ID
|
|
11
13
|
*/
|
|
12
|
-
|
|
14
|
+
ReceiverId: number;
|
|
15
|
+
/**
|
|
16
|
+
* 邮件主题
|
|
17
|
+
*/
|
|
18
|
+
Subject: string;
|
|
19
|
+
/**
|
|
20
|
+
* 任务类型 1即时 2 定时 3 周期
|
|
21
|
+
*/
|
|
22
|
+
TaskType: number;
|
|
23
|
+
/**
|
|
24
|
+
* 邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址,可以是个人邮箱。如果不填,收件人将会回复到腾讯云。
|
|
25
|
+
*/
|
|
26
|
+
ReplyToAddresses?: string;
|
|
27
|
+
/**
|
|
28
|
+
* 使用模板发送时,填写的模板相关参数
|
|
29
|
+
*/
|
|
30
|
+
Template?: Template;
|
|
31
|
+
/**
|
|
32
|
+
* 使用API直接发送内容时,填写的邮件内容
|
|
33
|
+
*/
|
|
34
|
+
Simple?: Simple;
|
|
35
|
+
/**
|
|
36
|
+
* 需要发送附件时,填写附件相关参数。
|
|
37
|
+
*/
|
|
38
|
+
Attachments?: Array<Attachment>;
|
|
39
|
+
/**
|
|
40
|
+
* 周期发送任务的必要参数
|
|
41
|
+
*/
|
|
42
|
+
CycleParam?: CycleEmailParam;
|
|
43
|
+
/**
|
|
44
|
+
* 定时发送任务的必要参数
|
|
45
|
+
*/
|
|
46
|
+
TimedParam?: TimedEmailParam;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* GetEmailTemplate请求参数结构体
|
|
50
|
+
*/
|
|
51
|
+
export interface GetEmailTemplateRequest {
|
|
52
|
+
/**
|
|
53
|
+
* 模板ID
|
|
54
|
+
*/
|
|
55
|
+
TemplateID: number;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* CreateEmailTemplate请求参数结构体
|
|
59
|
+
*/
|
|
60
|
+
export interface CreateEmailTemplateRequest {
|
|
61
|
+
/**
|
|
62
|
+
* 模板名称
|
|
63
|
+
*/
|
|
64
|
+
TemplateName: string;
|
|
65
|
+
/**
|
|
66
|
+
* 模板内容
|
|
67
|
+
*/
|
|
68
|
+
TemplateContent: TemplateContent;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* 模板列表结构
|
|
72
|
+
*/
|
|
73
|
+
export interface TemplatesMetadata {
|
|
74
|
+
/**
|
|
75
|
+
* 创建时间
|
|
76
|
+
*/
|
|
77
|
+
CreatedTimestamp: number;
|
|
78
|
+
/**
|
|
79
|
+
* 模板名称
|
|
80
|
+
*/
|
|
81
|
+
TemplateName: string;
|
|
82
|
+
/**
|
|
83
|
+
* 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
|
|
84
|
+
*/
|
|
85
|
+
TemplateStatus: number;
|
|
86
|
+
/**
|
|
87
|
+
* 模板ID
|
|
88
|
+
*/
|
|
89
|
+
TemplateID: number;
|
|
90
|
+
/**
|
|
91
|
+
* 审核原因
|
|
92
|
+
*/
|
|
93
|
+
ReviewReason: string;
|
|
13
94
|
}
|
|
14
95
|
/**
|
|
15
96
|
* ListEmailAddress请求参数结构体
|
|
@@ -110,8 +191,8 @@ export interface GetSendEmailStatusResponse {
|
|
|
110
191
|
export interface SendEmailRequest {
|
|
111
192
|
/**
|
|
112
193
|
* 发信邮件地址。请填写发件人邮箱地址,例如:noreply@mail.qcloud.com。如需填写发件人说明,请按照
|
|
113
|
-
发信人
|
|
114
|
-
腾讯云团队
|
|
194
|
+
发信人 <邮件地址> 的方式填写,例如:
|
|
195
|
+
腾讯云团队 <noreply@mail.qcloud.com>
|
|
115
196
|
*/
|
|
116
197
|
FromEmailAddress: string;
|
|
117
198
|
/**
|
|
@@ -158,6 +239,19 @@ export interface EmailSender {
|
|
|
158
239
|
*/
|
|
159
240
|
CreatedTimestamp: number;
|
|
160
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* BatchSendEmail返回参数结构体
|
|
244
|
+
*/
|
|
245
|
+
export interface BatchSendEmailResponse {
|
|
246
|
+
/**
|
|
247
|
+
* 发送任务ID
|
|
248
|
+
*/
|
|
249
|
+
TaskId: number;
|
|
250
|
+
/**
|
|
251
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
252
|
+
*/
|
|
253
|
+
RequestId?: string;
|
|
254
|
+
}
|
|
161
255
|
/**
|
|
162
256
|
* DeleteEmailIdentity请求参数结构体
|
|
163
257
|
*/
|
|
@@ -264,17 +358,13 @@ export interface Volume {
|
|
|
264
358
|
UnsubscribeCount: number;
|
|
265
359
|
}
|
|
266
360
|
/**
|
|
267
|
-
*
|
|
361
|
+
* CreateEmailIdentity请求参数结构体
|
|
268
362
|
*/
|
|
269
|
-
export interface
|
|
270
|
-
/**
|
|
271
|
-
* 模板名称
|
|
272
|
-
*/
|
|
273
|
-
TemplateName: string;
|
|
363
|
+
export interface CreateEmailIdentityRequest {
|
|
274
364
|
/**
|
|
275
|
-
*
|
|
365
|
+
* 您的发信域名,建议使用三级以上域名。例如:mail.qcloud.com。
|
|
276
366
|
*/
|
|
277
|
-
|
|
367
|
+
EmailIdentity: string;
|
|
278
368
|
}
|
|
279
369
|
/**
|
|
280
370
|
* UpdateEmailTemplate请求参数结构体
|
|
@@ -507,29 +597,17 @@ export interface GetSendEmailStatusRequest {
|
|
|
507
597
|
ToEmailAddress?: string;
|
|
508
598
|
}
|
|
509
599
|
/**
|
|
510
|
-
*
|
|
600
|
+
* 邮件发送的内容,可以是纯文本(TEXT),也可以是纯代码(HTML),或者纯文本+HTML的组合(建议方式)
|
|
511
601
|
*/
|
|
512
|
-
export interface
|
|
513
|
-
/**
|
|
514
|
-
* 创建时间
|
|
515
|
-
*/
|
|
516
|
-
CreatedTimestamp: number;
|
|
517
|
-
/**
|
|
518
|
-
* 模板名称
|
|
519
|
-
*/
|
|
520
|
-
TemplateName: string;
|
|
521
|
-
/**
|
|
522
|
-
* 模板状态。1-审核中|0-已通过|2-拒绝|其它-不可用
|
|
523
|
-
*/
|
|
524
|
-
TemplateStatus: number;
|
|
602
|
+
export interface Simple {
|
|
525
603
|
/**
|
|
526
|
-
*
|
|
604
|
+
* base64之后的Html代码。需要包含所有的代码信息,不要包含外部css,否则会导致显示格式错乱
|
|
527
605
|
*/
|
|
528
|
-
|
|
606
|
+
Html?: string;
|
|
529
607
|
/**
|
|
530
|
-
*
|
|
608
|
+
* base64之后的纯文本信息,如果没有Html,邮件中会直接显示纯文本;如果有Html,它代表邮件的纯文本样式
|
|
531
609
|
*/
|
|
532
|
-
|
|
610
|
+
Text?: string;
|
|
533
611
|
}
|
|
534
612
|
/**
|
|
535
613
|
* ListEmailIdentities返回参数结构体
|
|
@@ -628,13 +706,17 @@ export interface BlackEmailAddress {
|
|
|
628
706
|
EmailAddress: string;
|
|
629
707
|
}
|
|
630
708
|
/**
|
|
631
|
-
*
|
|
709
|
+
* 创建重复周期发送邮件任务的参数
|
|
632
710
|
*/
|
|
633
|
-
export interface
|
|
711
|
+
export interface CycleEmailParam {
|
|
634
712
|
/**
|
|
635
|
-
*
|
|
713
|
+
* 任务开始时间
|
|
636
714
|
*/
|
|
637
|
-
|
|
715
|
+
BeginTime: string;
|
|
716
|
+
/**
|
|
717
|
+
* 任务周期 小时维度
|
|
718
|
+
*/
|
|
719
|
+
IntervalTime: number;
|
|
638
720
|
}
|
|
639
721
|
/**
|
|
640
722
|
* DeleteEmailAddress返回参数结构体
|
|
@@ -666,15 +748,6 @@ export interface CreateEmailIdentityResponse {
|
|
|
666
748
|
*/
|
|
667
749
|
RequestId?: string;
|
|
668
750
|
}
|
|
669
|
-
/**
|
|
670
|
-
* CreateEmailIdentity请求参数结构体
|
|
671
|
-
*/
|
|
672
|
-
export interface CreateEmailIdentityRequest {
|
|
673
|
-
/**
|
|
674
|
-
* 您的发信域名,建议使用三级以上域名。例如:mail.qcloud.com。
|
|
675
|
-
*/
|
|
676
|
-
EmailIdentity: string;
|
|
677
|
-
}
|
|
678
751
|
/**
|
|
679
752
|
* CreateEmailAddress请求参数结构体
|
|
680
753
|
*/
|
|
@@ -715,6 +788,15 @@ export interface UpdateEmailTemplateResponse {
|
|
|
715
788
|
*/
|
|
716
789
|
RequestId?: string;
|
|
717
790
|
}
|
|
791
|
+
/**
|
|
792
|
+
* 创建定时发送邮件任务时,设置的定时参数,比如开始时间之类
|
|
793
|
+
*/
|
|
794
|
+
export interface TimedEmailParam {
|
|
795
|
+
/**
|
|
796
|
+
* 定时发送邮件的开始时间
|
|
797
|
+
*/
|
|
798
|
+
BeginTime: string;
|
|
799
|
+
}
|
|
718
800
|
/**
|
|
719
801
|
* 用于描述DNS记录的域名、记录类型、期望得到的值、目前配置的值
|
|
720
802
|
*/
|
|
@@ -34,7 +34,7 @@ export declare class Client extends AbstractClient {
|
|
|
34
34
|
*/
|
|
35
35
|
RecognizePreciseTargetAudience(req: RecognizePreciseTargetAudienceRequest, cb?: (error: string, rep: RecognizePreciseTargetAudienceResponse) => void): Promise<RecognizePreciseTargetAudienceResponse>;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* 流量安选产品,短信发送接口
|
|
38
38
|
*/
|
|
39
39
|
SendTrafficSecuritySmsMessage(req: SendTrafficSecuritySmsMessageRequest, cb?: (error: string, rep: SendTrafficSecuritySmsMessageResponse) => void): Promise<SendTrafficSecuritySmsMessageResponse>;
|
|
40
40
|
}
|
|
@@ -66,7 +66,7 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
66
66
|
return this.request("RecognizePreciseTargetAudience", req, cb);
|
|
67
67
|
}
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* 流量安选产品,短信发送接口
|
|
70
70
|
*/
|
|
71
71
|
async SendTrafficSecuritySmsMessage(req, cb) {
|
|
72
72
|
return this.request("SendTrafficSecuritySmsMessage", req, cb);
|