tencentcloud-sdk-nodejs 4.0.664 → 4.0.666

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 (68) hide show
  1. package/CHANGELOG.md +367 -0
  2. package/SERVICE_CHANGELOG.md +389 -39
  3. package/package.json +1 -1
  4. package/products.md +23 -23
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apigateway/v20180808/apigateway_models.ts +2 -2
  7. package/src/services/cdb/v20170320/cdb_models.ts +3 -3
  8. package/src/services/cfw/v20190904/cfw_models.ts +65 -35
  9. package/src/services/ckafka/v20190819/ckafka_models.ts +9 -0
  10. package/src/services/clb/v20180317/clb_client.ts +21 -9
  11. package/src/services/clb/v20180317/clb_models.ts +24 -0
  12. package/src/services/cls/v20201016/cls_models.ts +1 -1
  13. package/src/services/cynosdb/v20190107/cynosdb_models.ts +33 -3
  14. package/src/services/dasb/v20191018/dasb_client.ts +5 -3
  15. package/src/services/dasb/v20191018/dasb_models.ts +153 -73
  16. package/src/services/emr/v20190103/emr_client.ts +23 -10
  17. package/src/services/emr/v20190103/emr_models.ts +129 -52
  18. package/src/services/ess/v20201111/ess_models.ts +214 -85
  19. package/src/services/essbasic/v20210526/essbasic_client.ts +1 -1
  20. package/src/services/live/v20180801/live_models.ts +25 -17
  21. package/src/services/ssl/v20191205/ssl_models.ts +9 -0
  22. package/src/services/tcr/v20190924/tcr_client.ts +13 -1
  23. package/src/services/tcr/v20190924/tcr_models.ts +50 -2
  24. package/src/services/tcss/v20201101/tcss_models.ts +119 -45
  25. package/src/services/teo/v20220901/teo_models.ts +16 -3
  26. package/src/services/tione/v20211111/tione_client.ts +13 -1
  27. package/src/services/tione/v20211111/tione_models.ts +47 -2
  28. package/src/services/tke/v20180525/tke_models.ts +1 -1
  29. package/src/services/trp/v20210515/trp_models.ts +16 -2
  30. package/src/services/vpc/v20170312/vpc_models.ts +2 -2
  31. package/src/services/waf/v20180125/waf_models.ts +35 -6
  32. package/tencentcloud/common/sdk_version.d.ts +1 -1
  33. package/tencentcloud/common/sdk_version.js +1 -1
  34. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +2 -2
  35. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +3 -3
  36. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +65 -35
  37. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +9 -0
  38. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +9 -5
  39. package/tencentcloud/services/clb/v20180317/clb_client.js +11 -5
  40. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +22 -0
  41. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  42. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +33 -3
  43. package/tencentcloud/services/dasb/v20191018/dasb_client.d.ts +1 -1
  44. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +150 -72
  45. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +7 -3
  46. package/tencentcloud/services/emr/v20190103/emr_client.js +9 -3
  47. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +126 -52
  48. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +214 -85
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  50. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  51. package/tencentcloud/services/live/v20180801/live_models.d.ts +25 -17
  52. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +9 -0
  53. package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +5 -1
  54. package/tencentcloud/services/tcr/v20190924/tcr_client.js +6 -0
  55. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +48 -2
  56. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +119 -45
  57. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +16 -3
  58. package/tencentcloud/services/tione/v20211111/tione_client.d.ts +5 -1
  59. package/tencentcloud/services/tione/v20211111/tione_client.js +6 -0
  60. package/tencentcloud/services/tione/v20211111/tione_models.d.ts +45 -2
  61. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -1
  62. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +16 -2
  63. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +2 -2
  64. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +35 -6
  65. package/test/clb.v20180317.test.js +12 -2
  66. package/test/emr.v20190103.test.js +12 -2
  67. package/test/tcr.v20190924.test.js +10 -0
  68. package/test/tione.v20211111.test.js +10 -0
@@ -2932,7 +2932,7 @@ export interface CreateEmbedWebUrlRequest {
2932
2932
  /**
2933
2933
  * WEB嵌入的业务资源ID
2934
2934
  <br/>PREVIEW_SEAL_DETAIL,必填,取值为印章id
2935
- <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模版id
2935
+ <br/>MODIFY_TEMPLATE,PREVIEW_TEMPLATE,必填,取值为模板id
2936
2936
  <br/>PREVIEW_FLOW,PREVIEW_FLOW_DETAIL,必填,取值为合同id
2937
2937
  */
2938
2938
  BusinessId?: string;
@@ -3112,101 +3112,160 @@ export interface DeleteIntegrationRoleUsersRequest {
3112
3112
  */
3113
3113
  export interface CreateFlowByFilesRequest {
3114
3114
  /**
3115
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId 代发合同
3115
+ * 执行本接口操作的员工信息。
3116
+ 使用此接口时,必须填写userId。
3117
+ 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
3118
+ 支持填入集团子公司经办人 userId 代发合同。
3116
3119
  */
3117
3120
  Operator: UserInfo;
3118
3121
  /**
3119
- * 签署流程名称,最大长度200个字符
3122
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3123
+ 该名称还将用于合同签署完成后的下载文件名。
3120
3124
  */
3121
3125
  FlowName: string;
3122
3126
  /**
3123
- * 签署参与者信息,最大限制50
3127
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3128
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
3124
3129
  */
3125
3130
  Approvers: Array<ApproverInfo>;
3126
3131
  /**
3127
- * 签署pdf文件的资源编号列表,通过UploadFiles接口获取,暂时仅支持单文件发起
3132
+ * 本合同流程需包含的PDF文件资源编号列表,通过UploadFiles接口获取PDF文件资源编号。目前,此接口仅支持单个文件发起。
3128
3133
  */
3129
3134
  FileIds: Array<string>;
3130
3135
  /**
3131
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3136
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
3137
+ */
3138
+ FlowDescription?: string;
3139
+ /**
3140
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
3132
3141
  */
3133
3142
  FlowType?: string;
3134
3143
  /**
3135
- * 经办人内容控件配置
3144
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
3145
+ - 单行文本控件
3146
+ - 多行文本控件
3147
+ - 勾选框控件
3148
+ - 数字控件
3149
+ - 图片控件
3150
+ - 动态表格等填写控件
3136
3151
  */
3137
3152
  Components?: Array<Component>;
3138
3153
  /**
3139
- * 被抄送人的信息列表。
3140
- 注:此功能为白名单功能,若有需要,请联系电子签客服开白使用
3154
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3155
+ 注:此功能为白名单功能,使用前请联系对接的客户经理沟通。
3141
3156
  */
3142
3157
  CcInfos?: Array<CcInfo>;
3143
3158
  /**
3144
- * 是否需要预览,true:预览模式,false:非预览(默认);
3145
- 预览链接有效期300秒;
3159
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
3160
+
3161
+ - 0:合同发起时通知(默认值)
3162
+ - 1:签署完成后通知
3163
+ */
3164
+ CcNotifyType?: number;
3165
+ /**
3166
+ * 是否为预览模式,取值如下:
3167
+
3168
+ false:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。
3146
3169
 
3147
- 注:如果使用“预览模式”,出参会返回合同预览链接 PreviewUrl,不会正式发起合同,且出参不会返回签署流程编号 FlowId;如果使用“非预览”,则会正常返回签署流程编号 FlowId,不会生成合同预览链接 PreviewUrl
3170
+ true:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。
3148
3171
  */
3149
3172
  NeedPreview?: boolean;
3150
3173
  /**
3151
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3174
+ *
3175
+ 预览模式下产生的预览链接类型
3176
+
3177
+ - 0 :(默认) 文件流 ,点开后后下载预览的合同PDF文件
3178
+
3179
+ - 1 :H5链接 ,点开后在浏览器中展示合同的样子
3180
+
3181
+ 注意: 此参数在NeedPreview 为true时有效
3152
3182
  */
3153
3183
  PreviewType?: number;
3154
3184
  /**
3155
- * 签署流程的签署截止时间。
3156
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3185
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3186
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3157
3187
  */
3158
3188
  Deadline?: number;
3159
3189
  /**
3160
- * 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3190
+ * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
3191
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
3161
3192
  */
3162
3193
  RemindedOn?: number;
3163
3194
  /**
3164
- * 发送类型:
3165
- true:无序签
3166
- false:有序签
3167
- 注:默认为false(有序签)
3195
+ *
3196
+ 合同流程的签署顺序类型:
3197
+ - false:(默认)有序签署, 本合同多个参与人需要依次签署
3198
+ - true:无序签署, 本合同多个参与人没有先后签署限制
3168
3199
  */
3169
3200
  Unordered?: boolean;
3170
3201
  /**
3171
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3202
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
3203
+
3204
+ - {合同名称}
3205
+ - {发起方企业}
3206
+ - {发起方姓名}
3207
+ - {签署方N企业}
3208
+ - {签署方N姓名}
3209
+
3210
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
3211
+
3212
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:
3213
+ 合同名称:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`
3214
+
3215
+ 则小程序中列表页展示此合同为以下样子
3216
+ ```
3217
+ 合同名称:租房合同
3218
+ 发起方:腾讯公司(张三)
3219
+ 签署方:李四
3220
+ ```
3172
3221
  */
3173
3222
  CustomShowMap?: string;
3174
3223
  /**
3175
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3176
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3224
+ *
3225
+ 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3177
3226
 
3178
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3227
+ - false:(默认)不需要审批,直接签署。
3228
+ - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3229
+
3230
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3231
+
3232
+ - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3233
+ - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3234
+
3235
+ 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3179
3236
  */
3180
3237
  NeedSignReview?: boolean;
3181
3238
  /**
3182
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3239
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3240
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3241
+ 回调的相关说明可参考开发者中心的"回调通知"模块。
3183
3242
  */
3184
3243
  UserData?: string;
3185
3244
  /**
3186
- * 签署人校验方式
3187
- VerifyCheck: 人脸识别(默认)
3188
- MobileCheck:手机号验证
3189
- 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
3245
+ * 指定个人签署方查看合同的校验方式
3246
+
3247
+ - VerifyCheck :(默认)人脸识别,人脸识别后才能合同内容
3248
+ - MobileCheck: 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3190
3249
  */
3191
3250
  ApproverVerifyType?: string;
3192
3251
  /**
3193
- * 签署流程描述,最大长度1000个字符
3194
- */
3195
- FlowDescription?: string;
3196
- /**
3197
- * 标识是否允许发起后添加控件。0为不允许1为允许。如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
3252
+ * 签署方签署控件(印章/签名等)的生成方式:
3253
+
3254
+ - 0:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。
3255
+ - 1:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。
3198
3256
  */
3199
3257
  SignBeanTag?: number;
3200
3258
  /**
3201
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3259
+ * 代理企业和员工的信息。
3260
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3202
3261
  */
3203
3262
  Agent?: Agent;
3204
3263
  /**
3205
- * 给关注人发送短信通知的类型,0-合同发起时通知 1-签署完成后通知
3206
- */
3207
- CcNotifyType?: number;
3208
- /**
3209
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3264
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3265
+
3266
+ - E_PRESCRIPTION_AUTO_SIGN:处方单(医疗自动签)
3267
+
3268
+ 注: 个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。
3210
3269
  */
3211
3270
  AutoSignScene?: string;
3212
3271
  }
@@ -3359,15 +3418,17 @@ export interface CreatePersonAuthCertificateImageRequest {
3359
3418
  */
3360
3419
  export interface CreateFlowByFilesResponse {
3361
3420
  /**
3362
- * 签署流程编号。
3421
+ * 合同流程ID,为32位字符串。
3422
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3423
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3363
3424
 
3364
- 注:如入参 是否需要预览 NeedPreview 设置为 true,不会正式发起合同,此处不会有值返回;如入参 是否需要预览 NeedPreview 设置为 false,此处会正常返回签署流程编号 FlowId。
3425
+ 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
3365
3426
  */
3366
3427
  FlowId?: string;
3367
3428
  /**
3368
- * 合同预览链接。
3429
+ * 合同预览链接URL。
3369
3430
 
3370
- 注:如入参 是否需要预览 NeedPreview 设置为 true,会开启“预览模式”,此处会返回预览链接;如入参 是否需要预览 NeedPreview 设置为 false,此处不会有值返回。
3431
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
3371
3432
  注意:此字段可能返回 null,表示取不到有效值。
3372
3433
  */
3373
3434
  PreviewUrl?: string;
@@ -3519,59 +3580,89 @@ export interface FailedCreateRoleData {
3519
3580
  */
3520
3581
  export interface ApproverInfo {
3521
3582
  /**
3522
- * 参与者类型:
3583
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3523
3584
  0:企业
3524
3585
  1:个人
3525
3586
  3:企业静默签署
3526
3587
  注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
3527
3588
  7: 个人自动签署,适用于个人自动签场景。
3528
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
3589
+ 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
3529
3590
  */
3530
3591
  ApproverType: number;
3531
3592
  /**
3532
- * 签署人的姓名
3593
+ * 签署方经办人的姓名。
3594
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3533
3595
  */
3534
3596
  ApproverName: string;
3535
3597
  /**
3536
- * 签署人的手机号,11位数字
3598
+ * 本企业的签署方经办人的员工UserId
3599
+
3600
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3601
+
3602
+ 注: 若传该字段,则签署方经办人的其他信息(如签署方经办人的姓名、证件号码、手机号码等)将被忽略。
3537
3603
  */
3538
3604
  ApproverMobile: string;
3539
3605
  /**
3540
- * 如果签署方是企业签署方(approverType = 1 或者 approverType = 3),
3606
+ * 组织机构名称。
3607
+ 如果签署方是企业签署方(approverType = 1 或者 approverType = 3), 则企业名称必填。
3541
3608
 
3542
- 则企业名称必填
3609
+ 注: 请确认该名称与企业营业执照中注册的名称一致 ; 如果名称中包含英文括号(),请使用中文括号()代替。
3543
3610
  */
3544
3611
  OrganizationName?: string;
3545
3612
  /**
3546
- * 签署人的签署控件列表
3613
+ * 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
3614
+ - 个人签名/印章
3615
+ - 企业印章
3616
+ - 骑缝章等签署控件
3547
3617
  */
3548
3618
  SignComponents?: Array<Component>;
3549
3619
  /**
3550
- * 签署人的证件类型
3551
- ID_CARD 身份证
3552
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
3553
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3554
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3620
+ * 签署方经办人的证件类型,支持以下类型
3621
+ - ID_CARD 居民身份证 (默认值)
3622
+ - HONGKONG_AND_MACAO 港澳居民来往内地通行证
3623
+ - HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
3624
+ - OTHER_CARD_TYPE 其他证件
3625
+
3626
+ 注: 其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。
3555
3627
  */
3556
3628
  ApproverIdCardType?: string;
3557
3629
  /**
3558
- * 签署人证件号(长度不超过18位)
3630
+ * 签署方经办人的证件号码,应符合以下规则
3631
+ - 居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
3632
+ - 港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。
3633
+ - 港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
3559
3634
  */
3560
3635
  ApproverIdCardNumber?: string;
3561
3636
  /**
3562
- * 签署通知类型:sms--短信,none--不通知
3637
+ * 通知签署方经办人的方式, 有以下途径:
3638
+
3639
+ - sms: (默认)短信
3640
+ - none: 不通知
3563
3641
  */
3564
3642
  NotifyType?: string;
3565
3643
  /**
3566
- * 签署人角色类型:1--收款人、2--开具人、3--见证人
3644
+ * 收据场景设置签署人角色类型, 可以设置如下类型:
3645
+ - 1:收款人
3646
+ - 2:开具人
3647
+ - 3:见证人
3648
+
3649
+ 注: 收据场景为白名单功能,使用前请联系对接的客户经理沟通。
3567
3650
  */
3568
3651
  ApproverRole?: number;
3569
3652
  /**
3570
3653
  * 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
3654
+
3655
+ 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
3571
3656
  */
3572
3657
  VerifyChannel?: Array<string>;
3573
3658
  /**
3574
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
3659
+ * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
3660
+
3661
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
3662
+
3663
+ - 合同页数少于等于2页,阅读时间为3秒;
3664
+ - 合同页数为3到5页,阅读时间为5秒;
3665
+ - 合同页数大于等于6页,阅读时间为10秒。
3575
3666
  */
3576
3667
  PreReadTime?: number;
3577
3668
  /**
@@ -3581,35 +3672,60 @@ export interface ApproverInfo {
3581
3672
  */
3582
3673
  UserId?: string;
3583
3674
  /**
3584
- * 签署人用户来源,此参数仅针对企微用户开放
3585
-
3586
- 企微侧用户请传入:WEWORKAPP
3675
+ * 在企微场景下使用,需设置参数为WEWORKAPP,以表明合同来源于企微。
3587
3676
  */
3588
3677
  ApproverSource?: string;
3589
3678
  /**
3590
- * 企业签署方或签标识,客户自定义,64位长度。用于发起含有或签签署人的合同。或签参与人必须有此字段。合同内不同或签参与人CustomApproverTag需要保证唯一。如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
3679
+ * 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
3680
+ 所有参与或签的人员均需具备该标识。
3681
+ 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
3682
+ 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
3591
3683
  */
3592
3684
  CustomApproverTag?: string;
3593
3685
  /**
3594
- * 签署人个性化能力值
3686
+ * 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
3687
+ 详细操作可以参考开发者中心的ApproverOption结构体。
3595
3688
  */
3596
3689
  ApproverOption?: ApproverOption;
3597
3690
  /**
3598
- * 签署人查看合同时认证方式,
3599
- 1-实名查看 2-短信验证码查看(企业签署方不支持该方式)
3600
- 如果不传默认为1
3601
- 模板发起的时候,认证方式以模板配置为主
3691
+ * 指定个人签署方查看合同的校验方式,可以传值如下:
3692
+
3693
+ - 1 : (默认)人脸识别,人脸识别后才能合同内容
3694
+ - 2 : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容
3695
+
3696
+ 注:
3697
+
3698
+ - 如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式
3699
+ - 此字段不可传多个校验方式
3602
3700
  */
3603
3701
  ApproverVerifyTypes?: Array<number>;
3604
3702
  /**
3605
- * 签署人签署合同时的认证方式
3606
- 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3607
- 合同签署认证方式的优先级 verifyChannel>approverSignTypes
3608
- 模板发起的时候,认证方式以模板配置为主
3703
+ * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
3704
+
3705
+ - 1:人脸认证,需进行人脸识别成功后才能签署合同;
3706
+ - 2:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;
3707
+ - 3:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。
3708
+
3709
+ 注:
3710
+
3711
+ - 默认情况下,认证校验方式为人脸认证和签署密码两种形式;
3712
+ - 您可以传递多种值,表示可用多种认证校验方式。
3713
+
3609
3714
  */
3610
3715
  ApproverSignTypes?: Array<number>;
3611
3716
  /**
3612
- * 当前签署方进行签署操作是否需要企业内部审批,true 则为需要。为个人签署方时则由发起方企业审核。
3717
+ *
3718
+ 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3719
+
3720
+ - false:(默认)不需要审批,直接签署。
3721
+ - true:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。
3722
+
3723
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3724
+
3725
+ - 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。
3726
+ - 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。
3727
+
3728
+ 注:此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同
3613
3729
  */
3614
3730
  ApproverNeedSignReview?: boolean;
3615
3731
  }
@@ -4217,11 +4333,17 @@ export interface CreatePrepareFlowRequest {
4217
4333
  */
4218
4334
  export interface ApproverOption {
4219
4335
  /**
4220
- * 是否可以拒签 默认false-可以拒签 true-不可以拒签
4336
+ * 签署方是否可以拒签
4337
+
4338
+ - false: ( 默认)可以拒签
4339
+ - true:不可以拒签
4221
4340
  */
4222
4341
  NoRefuse?: boolean;
4223
4342
  /**
4224
- * 是否可以转发 默认false-可以转发 true-不可以转发
4343
+ * 签署方是否可以转他人处理
4344
+
4345
+ - false: ( 默认)可以转他人处理
4346
+ - true:不可以转他人处理
4225
4347
  */
4226
4348
  NoTransfer?: boolean;
4227
4349
  }
@@ -5339,27 +5461,34 @@ export interface DescribeExtendedServiceAuthInfosResponse {
5339
5461
  */
5340
5462
  export interface CcInfo {
5341
5463
  /**
5342
- * 被抄送人手机号,11位数字
5464
+ * 被抄送方手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
5465
+ 请确认手机号所有方为此业务通知方。
5343
5466
  */
5344
5467
  Mobile?: string;
5345
5468
  /**
5346
- * 被抄送人姓名
5469
+ * 被抄送方姓名。
5470
+ 抄送方的姓名将用于身份认证,请确保填写的姓名为抄送方的真实姓名,而非昵称等代名。
5347
5471
  */
5348
5472
  Name?: string;
5349
5473
  /**
5350
- * 被抄送人类型,
5351
- 0--个人
5352
- 1--员工
5474
+ * 被抄送方类型, 可设置以下类型:
5475
+
5476
+ - 0:个人抄送方
5477
+ - 1:企业员工抄送方
5353
5478
  */
5354
5479
  CcType?: number;
5355
5480
  /**
5356
- * 被抄送人权限
5357
- 0--可查看
5358
- 1--可查看也可下载
5481
+ * 被抄送方权限, 可设置如下权限:
5482
+
5483
+ - 0:可查看合同内容
5484
+ - 1:可查看合同内容也可下载原文
5359
5485
  */
5360
5486
  CcPermission?: number;
5361
5487
  /**
5362
- * 关注方通知类型:sms--短信,none--不通知
5488
+ * 通知签署方经办人的方式, 有以下途径:
5489
+
5490
+ - sms: (默认)短信
5491
+ - none: 不通知
5363
5492
  */
5364
5493
  NotifyType?: string;
5365
5494
  }
@@ -299,7 +299,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
299
299
  >
300
300
  > 3:取消部分子客授权 OperateType=DELETE
301
301
  > - 对子客企业进行模板库中模板可见性的进行删除操作。
302
- > - 主要对于手动领取的模板,去除授权后子客在在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
302
+ > - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
303
303
  > - 对于自动领取的模板,由于已经下发,更改授权不会影响。
304
304
  > - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
305
305
  */
@@ -409,7 +409,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
409
409
  >
410
410
  > 3:取消部分子客授权 OperateType=DELETE
411
411
  > - 对子客企业进行模板库中模板可见性的进行删除操作。
412
- > - 主要对于手动领取的模板,去除授权后子客在在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
412
+ > - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
413
413
  > - 对于自动领取的模板,由于已经下发,更改授权不会影响。
414
414
  > - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
415
415
  */
@@ -660,13 +660,13 @@ export interface ResumeDelayLiveStreamRequest {
660
660
  export interface DescribeCallbackRecordsListRequest {
661
661
  /**
662
662
  * 起始时间点,接口查询支持两种时间格式:
663
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
663
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
664
664
  2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。
665
665
  */
666
666
  StartTime: string;
667
667
  /**
668
668
  * 结束时间点,接口查询支持两种时间格式:
669
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
669
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
670
670
  2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。
671
671
 
672
672
  查询的起始和结束时间跨度不支持超过1天。仅支持查询最近14天的数据。
@@ -703,33 +703,41 @@ export interface DescribeCallbackRecordsListRequest {
703
703
  */
704
704
  export interface CallbackEventInfo {
705
705
  /**
706
- * 事件时间
706
+ * 事件时间。
707
+ 接口返回支持两种时间格式:
708
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
709
+ 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
710
+ 接口返回的时间格式和查询请求传入的时间格式一致。
707
711
  */
708
- EventTime: string;
712
+ EventTime?: string;
709
713
  /**
710
714
  * 事件类型
711
715
  */
712
- EventType: number;
716
+ EventType?: number;
713
717
  /**
714
718
  * 回调请求
715
719
  */
716
- Request: string;
720
+ Request?: string;
717
721
  /**
718
722
  * 回调响应
719
723
  */
720
- Response: string;
724
+ Response?: string;
721
725
  /**
722
- * 客户接口响应时间
726
+ * 客户接口响应时间。
727
+ 接口返回支持两种时间格式:
728
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)
729
+ 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
730
+ 接口返回的时间格式和查询请求传入的时间格式一致。
723
731
  */
724
- ResponseTime: string;
732
+ ResponseTime?: string;
725
733
  /**
726
734
  * 回调结果
727
735
  */
728
- ResultCode: number;
736
+ ResultCode?: number;
729
737
  /**
730
738
  * 流名称
731
739
  */
732
- StreamId: string;
740
+ StreamId?: string;
733
741
  }
734
742
  /**
735
743
  * DescribeTopClientIpSumInfoList返回参数结构体
@@ -3044,27 +3052,27 @@ export interface StopLiveStreamMonitorResponse {
3044
3052
  export interface DayStreamPlayInfo {
3045
3053
  /**
3046
3054
  * 数据时间点,接口返回支持两种时间格式:
3047
- 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
3055
+ 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见ISO日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I
3048
3056
  2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。
3049
3057
  接口返回的时间格式和查询请求传入的时间格式一致。
3050
3058
  */
3051
- Time: string;
3059
+ Time?: string;
3052
3060
  /**
3053
3061
  * 带宽(单位Mbps)。
3054
3062
  */
3055
- Bandwidth: number;
3063
+ Bandwidth?: number;
3056
3064
  /**
3057
3065
  * 流量 (单位MB)。
3058
3066
  */
3059
- Flux: number;
3067
+ Flux?: number;
3060
3068
  /**
3061
3069
  * 请求数。
3062
3070
  */
3063
- Request: number;
3071
+ Request?: number;
3064
3072
  /**
3065
3073
  * 在线人数。
3066
3074
  */
3067
- Online: number;
3075
+ Online?: number;
3068
3076
  }
3069
3077
  /**
3070
3078
  * ModifyLivePlayDomain返回参数结构体
@@ -2651,6 +2651,15 @@ export interface ReplaceCertificateRequest {
2651
2651
  * 重颁发原因。
2652
2652
  */
2653
2653
  Reason?: string;
2654
+ /**
2655
+ * CSR加密方式,可选:RSA、ECC、SM2
2656
+ (CsrType为Online才可选), 默认为RSA
2657
+ */
2658
+ CertCSREncryptAlgo?: string;
2659
+ /**
2660
+ * CSR加密参数,CsrEncryptAlgo为RSA时, 可选2048、4096等默认为2048;CsrEncryptAlgo为ECC时,可选prime256v1,secp384r1等,默认为prime256v1;
2661
+ */
2662
+ CertCSRKeyParameter?: string;
2654
2663
  }
2655
2664
  /**
2656
2665
  * 公司信息