tencentcloud-sdk-nodejs 4.0.682 → 4.0.684

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 (120) hide show
  1. package/CHANGELOG.md +337 -0
  2. package/SERVICE_CHANGELOG.md +369 -166
  3. package/package.json +1 -1
  4. package/products.md +17 -17
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/bma/index.ts +2 -2
  8. package/src/services/btoe/index.ts +2 -2
  9. package/src/services/cbs/v20170312/cbs_client.ts +2 -2
  10. package/src/services/ccc/v20200210/ccc_client.ts +2 -1
  11. package/src/services/ccc/v20200210/ccc_models.ts +21 -2
  12. package/src/services/cdwch/v20200915/cdwch_client.ts +27 -15
  13. package/src/services/cdwch/v20200915/cdwch_models.ts +70 -46
  14. package/src/services/cfw/v20190904/cfw_client.ts +711 -456
  15. package/src/services/cfw/v20190904/cfw_models.ts +1815 -305
  16. package/src/services/cii/index.ts +2 -2
  17. package/src/services/cloudstudio/index.ts +2 -2
  18. package/src/services/dts/index.ts +2 -2
  19. package/src/services/eb/v20210416/eb_client.ts +110 -59
  20. package/src/services/eb/v20210416/eb_models.ts +917 -780
  21. package/src/services/ess/v20201111/ess_client.ts +64 -30
  22. package/src/services/ess/v20201111/ess_models.ts +381 -214
  23. package/src/services/essbasic/index.ts +2 -2
  24. package/src/services/facefusion/v20181201/facefusion_client.ts +4 -2
  25. package/src/services/iai/index.ts +2 -2
  26. package/src/services/iai/v20180301/iai_models.ts +21 -25
  27. package/src/services/iai/v20200303/iai_models.ts +23 -27
  28. package/src/services/ims/index.ts +2 -2
  29. package/src/services/iotcloud/index.ts +2 -2
  30. package/src/services/iotvideo/index.ts +4 -4
  31. package/src/services/mgobe/index.ts +2 -2
  32. package/src/services/mrs/v20200910/mrs_models.ts +48 -25
  33. package/src/services/tem/index.ts +2 -2
  34. package/src/services/thpc/index.ts +4 -4
  35. package/src/services/thpc/v20230321/thpc_models.ts +17 -0
  36. package/src/services/tione/index.ts +2 -2
  37. package/src/services/tms/index.ts +2 -2
  38. package/src/services/trocket/v20230308/trocket_client.ts +68 -17
  39. package/src/services/trocket/v20230308/trocket_models.ts +371 -35
  40. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  41. package/src/services/tsw/index.ts +2 -2
  42. package/src/services/vm/index.ts +2 -2
  43. package/src/services/waf/v20180125/waf_client.ts +37 -38
  44. package/src/services/waf/v20180125/waf_models.ts +73 -73
  45. package/src/services/yunsou/index.ts +2 -2
  46. package/tencentcloud/common/sdk_version.d.ts +1 -1
  47. package/tencentcloud/common/sdk_version.js +1 -1
  48. package/tencentcloud/services/ams/index.d.ts +4 -4
  49. package/tencentcloud/services/ams/index.js +2 -2
  50. package/tencentcloud/services/bma/index.d.ts +4 -4
  51. package/tencentcloud/services/bma/index.js +2 -2
  52. package/tencentcloud/services/btoe/index.d.ts +4 -4
  53. package/tencentcloud/services/btoe/index.js +2 -2
  54. package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +2 -2
  55. package/tencentcloud/services/cbs/v20170312/cbs_client.js +2 -2
  56. package/tencentcloud/services/ccc/v20200210/ccc_client.d.ts +1 -1
  57. package/tencentcloud/services/ccc/v20200210/ccc_client.js +1 -1
  58. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +20 -2
  59. package/tencentcloud/services/cdwch/v20200915/cdwch_client.d.ts +9 -5
  60. package/tencentcloud/services/cdwch/v20200915/cdwch_client.js +12 -6
  61. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +68 -46
  62. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +227 -147
  63. package/tencentcloud/services/cfw/v20190904/cfw_client.js +336 -216
  64. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +1815 -360
  65. package/tencentcloud/services/cii/index.d.ts +4 -4
  66. package/tencentcloud/services/cii/index.js +2 -2
  67. package/tencentcloud/services/cloudstudio/index.d.ts +4 -4
  68. package/tencentcloud/services/cloudstudio/index.js +2 -2
  69. package/tencentcloud/services/dts/index.d.ts +4 -4
  70. package/tencentcloud/services/dts/index.js +2 -2
  71. package/tencentcloud/services/eb/v20210416/eb_client.d.ts +17 -1
  72. package/tencentcloud/services/eb/v20210416/eb_client.js +24 -0
  73. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +896 -770
  74. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +56 -22
  75. package/tencentcloud/services/ess/v20201111/ess_client.js +56 -22
  76. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +381 -214
  77. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  78. package/tencentcloud/services/essbasic/index.js +2 -2
  79. package/tencentcloud/services/facefusion/v20181201/facefusion_client.d.ts +3 -1
  80. package/tencentcloud/services/facefusion/v20181201/facefusion_client.js +3 -1
  81. package/tencentcloud/services/iai/index.d.ts +4 -4
  82. package/tencentcloud/services/iai/index.js +2 -2
  83. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +21 -25
  84. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +23 -27
  85. package/tencentcloud/services/ims/index.d.ts +4 -4
  86. package/tencentcloud/services/ims/index.js +2 -2
  87. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  88. package/tencentcloud/services/iotcloud/index.js +2 -2
  89. package/tencentcloud/services/iotvideo/index.d.ts +6 -6
  90. package/tencentcloud/services/iotvideo/index.js +4 -4
  91. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  92. package/tencentcloud/services/mgobe/index.js +2 -2
  93. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +48 -25
  94. package/tencentcloud/services/tem/index.d.ts +4 -4
  95. package/tencentcloud/services/tem/index.js +2 -2
  96. package/tencentcloud/services/thpc/index.d.ts +6 -6
  97. package/tencentcloud/services/thpc/index.js +4 -4
  98. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +17 -0
  99. package/tencentcloud/services/tione/index.d.ts +4 -4
  100. package/tencentcloud/services/tione/index.js +2 -2
  101. package/tencentcloud/services/tms/index.d.ts +4 -4
  102. package/tencentcloud/services/tms/index.js +2 -2
  103. package/tencentcloud/services/trocket/v20230308/trocket_client.d.ts +24 -8
  104. package/tencentcloud/services/trocket/v20230308/trocket_client.js +33 -9
  105. package/tencentcloud/services/trocket/v20230308/trocket_models.d.ts +359 -34
  106. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  107. package/tencentcloud/services/tsw/index.d.ts +4 -4
  108. package/tencentcloud/services/tsw/index.js +2 -2
  109. package/tencentcloud/services/vm/index.d.ts +4 -4
  110. package/tencentcloud/services/vm/index.js +2 -2
  111. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -13
  112. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -18
  113. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +69 -68
  114. package/tencentcloud/services/yunsou/index.d.ts +4 -4
  115. package/tencentcloud/services/yunsou/index.js +2 -2
  116. package/test/cdwch.v20200915.test.js +14 -4
  117. package/test/cfw.v20190904.test.js +340 -140
  118. package/test/eb.v20210416.test.js +40 -0
  119. package/test/trocket.v20230308.test.js +42 -2
  120. package/test/waf.v20180125.test.js +24 -24
@@ -111,16 +111,17 @@ export interface CancelFlowResponse {
111
111
  */
112
112
  export interface DescribeFlowEvidenceReportRequest {
113
113
  /**
114
- * 调用方用户信息,userId 必填
114
+ * 执行本接口操作的员工信息。
115
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
115
116
  */
116
117
  Operator: UserInfo;
117
118
  /**
118
- * 出证报告编号
119
+ * 签署报告编号
119
120
  */
120
121
  ReportId: string;
121
122
  /**
122
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
123
-
123
+ * 代理企业和员工的信息。
124
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
124
125
  */
125
126
  Agent?: Agent;
126
127
  }
@@ -325,12 +326,16 @@ export interface CreateMultiFlowSignQRCodeResponse {
325
326
  */
326
327
  export interface FlowApproverUrlInfo {
327
328
  /**
328
- * 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
329
+ * 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
330
+ 注: `注意该链接有效期为30分钟`
329
331
  注意:此字段可能返回 null,表示取不到有效值。
330
332
  */
331
333
  SignUrl?: string;
332
334
  /**
333
- * 签署人类型 1-个人
335
+ * 签署参与人类型
336
+ <ul><li> **1** :个人参与方</li></ul>
337
+
338
+ 注: `现在仅支持个人参与方`
334
339
  注意:此字段可能返回 null,表示取不到有效值。
335
340
  */
336
341
  ApproverType?: number;
@@ -345,7 +350,8 @@ export interface FlowApproverUrlInfo {
345
350
  */
346
351
  ApproverMobile?: string;
347
352
  /**
348
- * 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
353
+ * 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
354
+ 注: `注意该链接有效期为30分钟`
349
355
  注意:此字段可能返回 null,表示取不到有效值。
350
356
  */
351
357
  LongUrl?: string;
@@ -510,39 +516,39 @@ export interface CreateFlowOption {
510
516
  CustomCreateFlowDescription?: string;
511
517
  }
512
518
  /**
513
- * 解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
514
- 注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。
515
- 注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
516
- 注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole
519
+ * 解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
520
+ `注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
521
+ `注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
522
+ `注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
517
523
  */
518
524
  export interface ReleasedApprover {
519
525
  /**
520
- * 签署人姓名,最大长度50个字符
526
+ * 签署人姓名,最大长度50个字。
521
527
 
522
528
  */
523
529
  Name: string;
524
530
  /**
525
- * 签署人手机号
531
+ * 签署人手机号。
526
532
  */
527
533
  Mobile: string;
528
534
  /**
529
- * 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取(即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId )
535
+ * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
530
536
  */
531
537
  RelievedApproverReceiptId: string;
532
538
  /**
533
539
  * 指定签署人类型,目前仅支持
534
- ORGANIZATION-企业
535
- ENTERPRISESERVER-企业静默签
540
+ <ul><li> **ORGANIZATION**:企业(默认值)</li>
541
+ <li> **ENTERPRISESERVER**:企业静默签</li></ul>
536
542
  */
537
543
  ApproverType?: string;
538
544
  /**
539
- * 签署控件类型,支持自定义企业签署方的签署控件为“印章”或“签名”
540
- - SIGN_SEAL-默认为印章控件类型
541
- - SIGN_SIGNATURE-手写签名控件类型
545
+ * 签署控件类型,支持自定义企业签署方的签署控件类型
546
+ <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
547
+ <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
542
548
  */
543
549
  ApproverSignComponentType?: string;
544
550
  /**
545
- * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
551
+ * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
546
552
  */
547
553
  ApproverSignRole?: string;
548
554
  }
@@ -601,9 +607,9 @@ export interface CreateFlowEvidenceReportRequest {
601
607
  export interface StartFlowResponse {
602
608
  /**
603
609
  * 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
604
- START - 发起成功
605
- REVIEW - 提交审核成功
606
- EXECUTING - 已提交发起任务
610
+ <ul><li> **START** : 发起成功, 合同进入签署环节</li>
611
+ <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
612
+ <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
607
613
  */
608
614
  Status?: string;
609
615
  /**
@@ -701,23 +707,39 @@ export interface AuthorizedUser {
701
707
  */
702
708
  export interface CreateConvertTaskApiRequest {
703
709
  /**
704
- * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
710
+ * 需要进行转换的资源文件类型
711
+ 支持的文件类型如下:
712
+ <ul><li>doc</li>
713
+ <li>docx</li>
714
+ <li>xls</li>
715
+ <li>xlsx</li>
716
+ <li>jpg</li>
717
+ <li>jpeg</li>
718
+ <li>png</li>
719
+ <li>bmp</li>
720
+ <li>txt</li></ul>
705
721
  */
706
722
  ResourceType: string;
707
723
  /**
708
- * 资源名称,长度限制为256字符
724
+ * 需要进行转换操作的文件资源名称,带资源后缀名。
725
+
726
+ 注: `资源名称长度限制为256个字符`
709
727
  */
710
728
  ResourceName: string;
711
729
  /**
712
- * 文件Id,通过UploadFiles获取
730
+ * 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
731
+
732
+ 注: `目前,此接口仅支持单个文件进行转换。`
713
733
  */
714
734
  ResourceId: string;
715
735
  /**
716
- * 调用方用户信息,userId 必填
736
+ * 执行本接口操作的员工信息。
737
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
717
738
  */
718
739
  Operator?: UserInfo;
719
740
  /**
720
- * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
741
+ * 代理企业和员工的信息。
742
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
721
743
  */
722
744
  Agent?: Agent;
723
745
  /**
@@ -940,11 +962,12 @@ export interface DescribeFlowEvidenceReportResponse {
940
962
  */
941
963
  ReportUrl?: string;
942
964
  /**
943
- * 出证任务执行的状态, 分布表示下面的含义
944
-
945
- EvidenceStatusExecuting 出证任务在执行中
946
- EvidenceStatusSuccess 出证任务执行成功
947
- EvidenceStatusFailed 出证任务执行失败
965
+ * 签署报告出证任务的状态
966
+ <ul>
967
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
968
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
969
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
970
+ </ul>
948
971
  */
949
972
  Status?: string;
950
973
  /**
@@ -1117,11 +1140,16 @@ export interface TemplateInfo {
1117
1140
  */
1118
1141
  export interface CreateDocumentResponse {
1119
1142
  /**
1120
- * 签署流程电子文档ID
1143
+ * 合同流程的底层电子文档ID,为32位字符串。
1144
+
1145
+ 注:
1146
+ 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
1121
1147
  */
1122
1148
  DocumentId?: string;
1123
1149
  /**
1124
- * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
1150
+ * 合同预览链接URL。
1151
+
1152
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1125
1153
  注意:此字段可能返回 null,表示取不到有效值。
1126
1154
  */
1127
1155
  PreviewFileUrl?: string;
@@ -1187,73 +1215,103 @@ export interface CreateIntegrationUserRolesResponse {
1187
1215
  */
1188
1216
  export interface CreateFlowRequest {
1189
1217
  /**
1190
- * 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
1218
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
1219
+ 支持填入集团子公司经办人 userId 代发合同。
1220
+
1221
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1191
1222
  */
1192
1223
  Operator: UserInfo;
1193
1224
  /**
1194
- * 签署流程名称,最大长度200个字符
1225
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1226
+
1227
+ 该名称还将用于合同签署完成后的下载文件名。
1195
1228
  */
1196
1229
  FlowName: string;
1197
1230
  /**
1198
- * 签署流程参与者信息,最大限制50
1199
- 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
1231
+ * 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
1232
+
1233
+ 注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
1200
1234
  */
1201
1235
  Approvers: Array<FlowCreateApprover>;
1202
1236
  /**
1203
- * 签署流程描述,最大长度1000个字符
1237
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1204
1238
  */
1205
1239
  FlowDescription?: string;
1206
1240
  /**
1207
- * 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
1241
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
1208
1242
  */
1209
1243
  FlowType?: string;
1210
1244
  /**
1211
- * 客户端Token,保持接口幂等性,最大长度64个字符
1245
+ * 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
1212
1246
  */
1213
1247
  ClientToken?: string;
1214
1248
  /**
1215
- * 签署流程的签署截止时间。
1216
-
1217
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1249
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
1250
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1218
1251
  */
1219
1252
  DeadLine?: number;
1220
1253
  /**
1221
- * 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
1254
+ * 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
1255
+
1256
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
1222
1257
  */
1223
1258
  RemindedOn?: number;
1224
1259
  /**
1225
- * 用户自定义字段,回调的时候会进行透传,长度需要小于20480
1260
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
1261
+
1262
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1226
1263
  */
1227
1264
  UserData?: string;
1228
1265
  /**
1229
- * 发送类型:
1230
- true:无序签
1231
- false:有序签
1232
- 注:默认为false(有序签),请和模板中的配置保持一致
1266
+ * 合同流程的签署顺序类型:
1267
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1268
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1269
+ 注:`请和模板中的配置保持一致`
1233
1270
  */
1234
1271
  Unordered?: boolean;
1235
1272
  /**
1236
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1273
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
1274
+ <ul><li>{合同名称} </li>
1275
+ <li>{发起方企业} </li>
1276
+ <li>{发起方姓名} </li>
1277
+ <li>{签署方N企业}</li>
1278
+ <li>{签署方N姓名}</li></ul>
1279
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
1280
+
1281
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
1282
+
1283
+ 合同名称:租房合同
1284
+ 发起方:腾讯公司(张三)
1285
+ 签署方:李四
1286
+
1287
+
1237
1288
  */
1238
1289
  CustomShowMap?: string;
1239
1290
  /**
1240
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1241
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
1242
-
1243
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1291
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1292
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1293
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1294
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1295
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1296
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1297
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1244
1298
  */
1245
1299
  NeedSignReview?: boolean;
1246
1300
  /**
1247
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1301
+ * 代理企业和员工的信息。
1302
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1248
1303
  */
1249
1304
  Agent?: Agent;
1250
1305
  /**
1251
- * 被抄送人的信息列表。
1252
- 注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
1306
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1307
+
1308
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
1253
1309
  */
1254
1310
  CcInfos?: Array<CcInfo>;
1255
1311
  /**
1256
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1312
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1313
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
1314
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
1257
1315
  */
1258
1316
  AutoSignScene?: string;
1259
1317
  /**
@@ -1352,50 +1410,49 @@ export interface DeleteIntegrationDepartmentResponse {
1352
1410
  */
1353
1411
  export interface AutoSignConfig {
1354
1412
  /**
1355
- * 自动签开通个人用户的三要素
1413
+ * 自动签开通个人用户信息, 包括名字,身份证等
1356
1414
  */
1357
1415
  UserInfo: UserThreeFactor;
1358
1416
  /**
1359
- * 接受回调URL地址。支持http://或者https://协议
1360
-
1361
- Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
1362
- */
1363
- CallbackUrl: string;
1364
- /**
1365
- * 是否回调证书信息
1366
- false-不需要 (默认值)
1367
- true-需要
1417
+ * 是否回调证书信息:
1418
+ <ul><li>**false**: 不需要(默认)</li>
1419
+ <li>**true**:需要</li></ul>
1368
1420
  */
1369
1421
  CertInfoCallback?: boolean;
1370
1422
  /**
1371
- * 是否支持用户自定义签名印章
1372
- false-不需要(默认)
1373
- true-需要
1423
+ * 是否支持用户自定义签名印章:
1424
+ <ul><li>**false**: 不能自己定义(默认)</li>
1425
+ <li>**true**: 可以自己定义</li></ul>
1374
1426
  */
1375
1427
  UserDefineSeal?: boolean;
1376
1428
  /**
1377
- * 是否需要回调的时候返回印章(签名) 图片的 base64
1378
-
1379
- false-不需要(默认)
1380
- true-需要
1429
+ * 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
1430
+ <ul><li>**false**: 不需要(默认)</li>
1431
+ <li>**true**: 需要</li></ul>
1381
1432
  */
1382
1433
  SealImgCallback?: boolean;
1383
1434
  /**
1384
- * 开通时候的验证方式, 分布为
1385
-
1386
- WEIXINAPP : 微信人脸识别
1387
- INSIGHT : 慧眼人脸认别
1388
- TELECOM : 运营商三要素验证
1389
-
1390
- 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
1391
-
1392
- 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1435
+ * 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
1436
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
1437
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1438
+ * @deprecated
1439
+ */
1440
+ CallbackUrl?: string;
1441
+ /**
1442
+ * 开通时候的身份验证方式, 取值为:
1443
+ <ul><li>**WEIXINAPP** : 微信人脸识别</li>
1444
+ <li>**INSIGHT** : 慧眼人脸认别</li>
1445
+ <li>**TELECOM** : 运营商三要素验证</li></ul>
1446
+ 注:
1447
+ <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
1448
+ <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li>
1393
1449
  */
1394
1450
  VerifyChannels?: Array<string>;
1395
1451
  /**
1396
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
1397
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
1398
- 1-不绑定,发起合同时将按标准合同套餐进行扣减
1452
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
1453
+
1454
+ <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1455
+ <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
1399
1456
 
1400
1457
  */
1401
1458
  LicenseType?: number;
@@ -1432,6 +1489,7 @@ export interface DescribeIntegrationMainOrganizationUserRequest {
1432
1489
  export interface CreateReleaseFlowResponse {
1433
1490
  /**
1434
1491
  * 解除协议流程编号
1492
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
1435
1493
 
1436
1494
  */
1437
1495
  FlowId?: string;
@@ -1676,20 +1734,23 @@ export interface DescribeUserAutoSignStatusResponse {
1676
1734
  */
1677
1735
  IsOpen?: boolean;
1678
1736
  /**
1679
- * 自动签许可生效时间。当且仅当已开通自动签时有值。
1737
+ * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
1680
1738
 
1681
1739
  值为unix时间戳,单位为秒。
1682
1740
  */
1683
1741
  LicenseFrom?: number;
1684
1742
  /**
1685
- * 自动签许可到期时间。当且仅当已开通自动签时有值。
1743
+ * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
1744
+
1686
1745
  值为unix时间戳,单位为秒。
1687
1746
  */
1688
1747
  LicenseTo?: number;
1689
1748
  /**
1690
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
1691
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
1692
- 1-不绑定,发起合同时将按标准合同套餐进行扣减
1749
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
1750
+
1751
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1752
+ <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
1753
+
1693
1754
  */
1694
1755
  LicenseType?: number;
1695
1756
  /**
@@ -1917,18 +1978,22 @@ export interface CreateBatchCancelFlowUrlResponse {
1917
1978
  */
1918
1979
  export interface UserThreeFactor {
1919
1980
  /**
1920
- * 姓名
1981
+ * 签署方经办人的姓名。
1982
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1921
1983
  */
1922
1984
  Name: string;
1923
1985
  /**
1924
- * 证件类型:
1925
- ID_CARD 身份证
1926
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
1927
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1986
+ * 证件类型,支持以下类型
1987
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
1988
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
1989
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
1928
1990
  */
1929
1991
  IdCardType: string;
1930
1992
  /**
1931
- * 证件号,如果有 X 请大写
1993
+ * 证件号码,应符合以下规则
1994
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1995
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1996
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1932
1997
  */
1933
1998
  IdCardNumber: string;
1934
1999
  }
@@ -1968,20 +2033,22 @@ export interface CreateSealPolicyResponse {
1968
2033
  */
1969
2034
  export interface DisableUserAutoSignRequest {
1970
2035
  /**
1971
- * 操作人信息,UserId必填
2036
+ * 执行本接口操作的员工信息。
2037
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1972
2038
  */
1973
2039
  Operator: UserInfo;
1974
2040
  /**
1975
- * 自动签场景:
1976
- E_PRESCRIPTION_AUTO_SIGN 电子处方
2041
+ * 自动签使用的场景值, 可以选择的场景值如下:
2042
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
1977
2043
  */
1978
2044
  SceneKey: string;
1979
2045
  /**
1980
- * 关闭自动签的个人的三要素
2046
+ * 需要关闭自动签的个人的信息,如姓名,证件信息等。
1981
2047
  */
1982
2048
  UserInfo: UserThreeFactor;
1983
2049
  /**
1984
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2050
+ * 代理企业和员工的信息。
2051
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1985
2052
  */
1986
2053
  Agent?: Agent;
1987
2054
  }
@@ -2034,7 +2101,7 @@ export interface SuccessDeleteStaffData {
2034
2101
  */
2035
2102
  export interface CreateConvertTaskApiResponse {
2036
2103
  /**
2037
- * 转换任务Id
2104
+ * 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
2038
2105
  */
2039
2106
  TaskId?: string;
2040
2107
  /**
@@ -2129,27 +2196,37 @@ export interface CreateSchemeUrlResponse {
2129
2196
  */
2130
2197
  export interface CreateUserAutoSignEnableUrlResponse {
2131
2198
  /**
2132
- * 跳转短链
2199
+ * 个人用户自动签的开通链接, 短链形式
2133
2200
  */
2134
2201
  Url?: string;
2135
2202
  /**
2136
- * 小程序AppId
2203
+ * 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2204
+
2205
+ 注: `如果获取的是H5链接, 则不会返回此值`
2137
2206
  */
2138
2207
  AppId?: string;
2139
2208
  /**
2140
- * 小程序 原始 Id
2209
+ * 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2210
+
2211
+ 注: `如果获取的是H5链接, 则不会返回此值`
2141
2212
  */
2142
2213
  AppOriginalId?: string;
2143
2214
  /**
2144
- * 跳转路径
2215
+ * 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
2216
+
2217
+ 注: `如果获取的是H5链接, 则不会返回此值`
2145
2218
  */
2146
2219
  Path?: string;
2147
2220
  /**
2148
- * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
2221
+ * base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
2222
+
2223
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
2149
2224
  */
2150
2225
  QrCode?: string;
2151
2226
  /**
2152
- * 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
2227
+ * 返回的链接类型
2228
+ <ul><li> 空: 默认小程序端链接</li>
2229
+ <li> **H5SIGN** : h5端链接</li></ul>
2153
2230
  */
2154
2231
  UrlType?: string;
2155
2232
  /**
@@ -2586,46 +2663,52 @@ export interface ModifyIntegrationRoleResponse {
2586
2663
  */
2587
2664
  export interface FlowCreateApprover {
2588
2665
  /**
2589
- * 参与者类型:
2666
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
2590
2667
  0:企业
2591
2668
  1:个人
2592
- 3:企业自动签署
2593
- 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
2594
- 自动签署仅进行盖章操作,不能是手写签名。
2595
- 本方企业自动签署的签署人会默认是当前的发起人
2596
- 他方企业自动签署的签署人是自动签模板的他方企业授权人
2669
+ 3:企业静默签署
2670
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
2597
2671
  7: 个人自动签署,适用于个人自动签场景。
2598
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
2672
+ 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
2599
2673
  */
2600
2674
  ApproverType: number;
2601
2675
  /**
2602
- * 签署人企业名称
2603
- 当approverType=0 或 approverType=3时,必须指定
2676
+ * 组织机构名称。
2677
+ 请确认该名称与企业营业执照中注册的名称一致。
2678
+ 如果名称中包含英文括号(),请使用中文括号()代替。
2679
+
2680
+ 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
2604
2681
 
2605
2682
 
2606
2683
  */
2607
2684
  OrganizationName?: string;
2608
2685
  /**
2609
- * 签署方经办人姓名
2610
- <br/>在未指定签署人电子签UserId情况下,为必填参数
2686
+ * 签署方经办人的姓名。
2687
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2688
+
2689
+ 在未指定签署人电子签UserId情况下,为必填参数
2611
2690
  */
2612
2691
  ApproverName?: string;
2613
2692
  /**
2614
- * 签署方经办人手机号码
2615
- <br/>在未指定签署人电子签UserId情况下,为必填参数
2693
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2694
+ 请确认手机号所有方为此合同签署方。
2695
+
2696
+ 在未指定签署人电子签UserId情况下,为必填参数
2616
2697
 
2617
2698
  */
2618
2699
  ApproverMobile?: string;
2619
2700
  /**
2620
- * 签署人的证件类型
2621
- ID_CARD 身份证
2622
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2623
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2624
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
2701
+ * 证件类型,支持以下类型
2702
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
2703
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
2704
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
2625
2705
  */
2626
2706
  ApproverIdCardType?: string;
2627
2707
  /**
2628
- * 签署人证件号(长度不超过18位)
2708
+ * 证件号码,应符合以下规则
2709
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
2710
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
2711
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
2629
2712
  */
2630
2713
  ApproverIdCardNumber?: string;
2631
2714
  /**
@@ -2636,15 +2719,17 @@ export interface FlowCreateApprover {
2636
2719
  */
2637
2720
  RecipientId?: string;
2638
2721
  /**
2639
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
2722
+ * 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
2723
+
2724
+ 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
2640
2725
  */
2641
2726
  VerifyChannel?: Array<string>;
2642
2727
  /**
2643
- * 是否发送短信
2644
- <br/>sms--短信通知
2645
- <br/>none--不通知
2646
- <br/>默认为sms
2647
- <br/>发起方=签署方时不发送短信
2728
+ * 通知签署方经办人的方式, 有以下途径:
2729
+ <ul><li> **sms** : (默认)短信</li>
2730
+ <li> **none** : 不通知</li></ul>
2731
+
2732
+ 注: `发起方也是签署方时不给此签署方发送短信`
2648
2733
  */
2649
2734
  NotifyType?: string;
2650
2735
  /**
@@ -2658,32 +2743,30 @@ export interface FlowCreateApprover {
2658
2743
  /**
2659
2744
  * 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
2660
2745
 
2661
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
2746
+ 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
2662
2747
  */
2663
2748
  UserId?: string;
2664
2749
  /**
2665
- * 当前只支持true,默认为true
2750
+ * 字段已经废弃,当前只支持true,默认为true
2666
2751
  */
2667
2752
  Required?: boolean;
2668
2753
  /**
2669
- * 签署人用户来源,此参数仅针对企微用户开放
2670
-
2671
- 企微侧用户请传入:WEWORKAPP
2754
+ * 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
2672
2755
  */
2673
2756
  ApproverSource?: string;
2674
2757
  /**
2675
- * 企业签署方或签标识,客户自定义,64位长度
2676
- <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
2677
- <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
2678
- <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
2758
+ * 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
2759
+ 所有参与或签的人员均需具备该标识。
2760
+ 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
2761
+ 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP
2679
2762
  */
2680
2763
  CustomApproverTag?: string;
2681
2764
  /**
2682
- * 快速注册相关信息,目前暂未开放!
2765
+ * 已经废弃, 快速注册相关信息
2683
2766
  */
2684
2767
  RegisterInfo?: RegisterInfo;
2685
2768
  /**
2686
- * 签署人个性化能力值
2769
+ * 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
2687
2770
  */
2688
2771
  ApproverOption?: ApproverOption;
2689
2772
  /**
@@ -2698,20 +2781,39 @@ export interface FlowCreateApprover {
2698
2781
  */
2699
2782
  SignId?: string;
2700
2783
  /**
2701
- * 当前签署方进行签署操作是否需要企业内部审批
2702
- <br>true 则为需要
2703
- <br/>false,无序企业内部审批(默认)
2704
- <br/>为个人签署方时则由发起方企业审核。
2784
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2785
+ <ul><li>**false**:(默认)不需要审批,直接签署。</li>
2786
+ <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2787
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2788
+ <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2789
+ <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2790
+
2791
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2705
2792
  */
2706
2793
  ApproverNeedSignReview?: boolean;
2707
2794
  /**
2708
2795
  * 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
2709
- <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
2796
+
2797
+ 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
2798
+ <ul><li> 个人签名/印章</li>
2799
+ <li> 企业印章</li>
2800
+ <li> 骑缝章等签署控件</li></ul>
2801
+
2802
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
2710
2803
  */
2711
2804
  SignComponents?: Array<Component>;
2712
2805
  /**
2713
2806
  * 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
2714
- <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
2807
+
2808
+ 合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2809
+ <ul><li>单行文本控件</li>
2810
+ <li>多行文本控件</li>
2811
+ <li>勾选框控件</li>
2812
+ <li>数字控件</li>
2813
+ <li>图片控件</li>
2814
+ <li>动态表格等填写控件</li></ul>
2815
+
2816
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
2715
2817
  */
2716
2818
  Components?: Array<Component>;
2717
2819
  /**
@@ -2723,15 +2825,30 @@ export interface FlowCreateApprover {
2723
2825
  */
2724
2826
  ComponentLimitType?: Array<string>;
2725
2827
  /**
2726
- * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
2828
+ * 指定个人签署方查看合同的校验方式,可以传值如下:
2829
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
2830
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
2831
+ </li></ul>
2832
+ 注:
2833
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
2834
+ <li>此字段不可传多个校验方式</li></ul>
2727
2835
 
2728
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2836
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
2837
+
2838
+ .
2729
2839
  */
2730
2840
  ApproverVerifyTypes?: Array<number | bigint>;
2731
2841
  /**
2732
- * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
2842
+ * 您可以指定签署方签署合同的认证校验方式,可传递以下值:
2843
+ <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
2844
+ <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
2845
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
2846
+ 注:
2847
+ <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
2848
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
2733
2849
 
2734
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
2850
+ 注:
2851
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
2735
2852
  */
2736
2853
  ApproverSignTypes?: Array<number | bigint>;
2737
2854
  }
@@ -3020,11 +3137,13 @@ export interface CreateDocumentRequest {
3020
3137
  */
3021
3138
  Operator: UserInfo;
3022
3139
  /**
3023
- * 签署流程编号,由CreateFlow接口返回
3140
+ * 合同流程ID,为32位字符串。
3141
+ 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
3024
3142
  */
3025
3143
  FlowId: string;
3026
3144
  /**
3027
- * 用户上传的模板ID
3145
+ * 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
3146
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
3028
3147
  */
3029
3148
  TemplateId: string;
3030
3149
  /**
@@ -3032,24 +3151,30 @@ export interface CreateDocumentRequest {
3032
3151
  */
3033
3152
  FileNames?: Array<string>;
3034
3153
  /**
3035
- * 内容控件信息数组
3154
+ * 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
3036
3155
  */
3037
3156
  FormFields?: Array<FormField>;
3038
3157
  /**
3039
- * 是否需要生成预览文件 默认不生成;
3040
- 预览链接有效期300秒;
3158
+ * 是否为预览模式,取值如下:
3159
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
3160
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
3041
3161
  */
3042
3162
  NeedPreview?: boolean;
3043
3163
  /**
3044
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
3164
+ * 预览模式下产生的预览链接类型
3165
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
3166
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
3167
+ 注: `此参数在NeedPreview 为true时有效`
3168
+
3045
3169
  */
3046
3170
  PreviewType?: number;
3047
3171
  /**
3048
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3172
+ * 代理企业和员工的信息。
3173
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3049
3174
  */
3050
3175
  Agent?: Agent;
3051
3176
  /**
3052
- * 客户端Token,保持接口幂等性,最大长度64个字符
3177
+ * 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
3053
3178
  */
3054
3179
  ClientToken?: string;
3055
3180
  }
@@ -3515,21 +3640,27 @@ export interface CreateFlowByFilesRequest {
3515
3640
  */
3516
3641
  export interface CreateFlowSignUrlRequest {
3517
3642
  /**
3518
- * 流程编号
3643
+ * 合同流程ID,为32位字符串。
3644
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3645
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3519
3646
  */
3520
3647
  FlowId: string;
3521
3648
  /**
3522
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
3649
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
3523
3650
 
3524
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
3651
+ 注:
3652
+ `1. ApproverType目前只支持个人类型的签署人。`
3653
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
3525
3654
  */
3526
3655
  FlowApproverInfos: Array<FlowCreateApprover>;
3527
3656
  /**
3528
- * 用户信息,此结构体UserId必填
3657
+ * 执行本接口操作的员工信息。
3658
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3529
3659
  */
3530
3660
  Operator?: UserInfo;
3531
3661
  /**
3532
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3662
+ * 代理企业和员工的信息。
3663
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3533
3664
  */
3534
3665
  Agent?: Agent;
3535
3666
  /**
@@ -3538,7 +3669,7 @@ export interface CreateFlowSignUrlRequest {
3538
3669
  */
3539
3670
  Organization?: OrganizationInfo;
3540
3671
  /**
3541
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
3672
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
3542
3673
  */
3543
3674
  JumpUrl?: string;
3544
3675
  }
@@ -3547,31 +3678,44 @@ export interface CreateFlowSignUrlRequest {
3547
3678
  */
3548
3679
  export interface CreateReleaseFlowRequest {
3549
3680
  /**
3550
- * 调用方用户信息,userId 必填
3681
+ * 执行本接口操作的员工信息。
3682
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3551
3683
  */
3552
3684
  Operator: UserInfo;
3553
3685
  /**
3554
- * 待解除的签署流程编号(即原签署流程的编号)
3686
+ * 待解除的签署流程编号(即原签署流程的编号)。
3555
3687
  */
3556
3688
  NeedRelievedFlowId: string;
3557
3689
  /**
3558
- * 解除协议内容
3690
+ * 解除协议内容。
3559
3691
  */
3560
3692
  ReliveInfo: RelieveInfo;
3561
3693
  /**
3562
- * 非必须,解除协议的本企业签署人列表,
3563
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
3564
- 解除协议的签署人数量不能多于原流程的签署人数量
3694
+ * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3695
+ */
3696
+ Agent?: Agent;
3697
+ /**
3698
+ * 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
3699
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
3700
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
3701
+
3702
+ `注意:只能更换同企业的签署人。`<br/>
3703
+ `注意:不支持更换个人类型的签署人。`<br/>
3565
3704
  */
3566
3705
  ReleasedApprovers?: Array<ReleasedApprover>;
3567
3706
  /**
3568
- * 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
3707
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
3708
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3569
3709
  */
3570
3710
  Deadline?: number;
3571
3711
  /**
3572
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3712
+ * 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
3713
+
3714
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
3715
+
3716
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3573
3717
  */
3574
- Agent?: Agent;
3718
+ UserData?: string;
3575
3719
  }
3576
3720
  /**
3577
3721
  * CreateIntegrationUserRoles请求参数结构体
@@ -4036,29 +4180,31 @@ export interface CreateStaffResult {
4036
4180
  */
4037
4181
  export interface CreateUserAutoSignEnableUrlRequest {
4038
4182
  /**
4039
- * 操作人信息,UserId必填
4183
+ * 执行本接口操作的员工信息。
4184
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4040
4185
  */
4041
4186
  Operator: UserInfo;
4042
4187
  /**
4043
- * 自动签场景:
4044
- E_PRESCRIPTION_AUTO_SIGN 电子处方
4188
+ * 自动签使用的场景值, 可以选择的场景值如下:
4189
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4190
+
4191
+ 注: `现在仅支持电子处方场景`
4045
4192
  */
4046
4193
  SceneKey: string;
4047
4194
  /**
4048
- * 自动签开通,签署相关配置
4195
+ * 自动签开通配置信息, 包括开通的人员的信息等
4049
4196
  */
4050
4197
  AutoSignConfig: AutoSignConfig;
4051
4198
  /**
4052
- * 链接类型,
4053
- 空-默认小程序端链接
4054
- H5SIGN-h5端链接
4199
+ * 生成的链接类型:
4200
+ <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
4201
+ <li> **H5SIGN** : 生成H5端开通链接</li><ul>
4055
4202
  */
4056
4203
  UrlType?: string;
4057
4204
  /**
4058
- * 通知类型
4059
-
4060
- 默认不设置为不通知开通方,
4061
- SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
4205
+ * 是否通知开通方,通知类型:
4206
+ <ul><li>默认不设置为不通知开通方</li>
4207
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
4062
4208
  */
4063
4209
  NotifyType?: string;
4064
4210
  /**
@@ -4066,11 +4212,12 @@ export interface CreateUserAutoSignEnableUrlRequest {
4066
4212
  */
4067
4213
  NotifyAddress?: string;
4068
4214
  /**
4069
- * 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
4215
+ * 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
4070
4216
  */
4071
4217
  ExpiredTime?: number;
4072
4218
  /**
4073
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4219
+ * 代理企业和员工的信息。
4220
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4074
4221
  */
4075
4222
  Agent?: Agent;
4076
4223
  }
@@ -4129,18 +4276,27 @@ export interface RemindFlowRecords {
4129
4276
  */
4130
4277
  export interface CancelUserAutoSignEnableUrlRequest {
4131
4278
  /**
4132
- * 操作人信息,UseId必填
4279
+ * 执行本接口操作的员工信息。
4280
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4133
4281
  */
4134
4282
  Operator: UserInfo;
4135
4283
  /**
4136
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
4284
+ * 自动签使用的场景值, 可以选择的场景值如下:
4285
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4286
+
4287
+ 注: `现在仅支持电子处方场景`
4137
4288
  */
4138
4289
  SceneKey: string;
4139
4290
  /**
4140
- * 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
4291
+ * 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
4141
4292
 
4142
4293
  */
4143
4294
  UserInfo: UserThreeFactor;
4295
+ /**
4296
+ * 代理企业和员工的信息。
4297
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4298
+ */
4299
+ Agent?: Agent;
4144
4300
  }
4145
4301
  /**
4146
4302
  * 创建员工的失败数据
@@ -4351,15 +4507,17 @@ export interface GetTaskResultApiResponse {
4351
4507
  */
4352
4508
  export interface CancelMultiFlowSignQRCodeRequest {
4353
4509
  /**
4354
- * 调用方用户信息,userId 必填
4510
+ * 执行本接口操作的员工信息。
4511
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
4355
4512
  */
4356
4513
  Operator: UserInfo;
4357
4514
  /**
4358
- * 二维码id
4515
+ * 二维码ID,为32位字符串。
4359
4516
  */
4360
4517
  QrCodeId: string;
4361
4518
  /**
4362
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4519
+ * 代理企业和员工的信息。
4520
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4363
4521
  */
4364
4522
  Agent?: Agent;
4365
4523
  }
@@ -4474,8 +4632,8 @@ export interface StartFlowRequest {
4474
4632
  Agent?: Agent;
4475
4633
  /**
4476
4634
  * 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
4477
- 0 - 合同发起时通知(默认)
4478
- 1 - 签署完成后通知
4635
+ <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
4636
+ <li> **1** : 签署完成后通知对方来查看合同</li></ul>
4479
4637
  */
4480
4638
  CcNotifyType?: number;
4481
4639
  }
@@ -4737,19 +4895,22 @@ export interface PermissionGroup {
4737
4895
  */
4738
4896
  export interface CancelFlowRequest {
4739
4897
  /**
4740
- * 调用方用户信息,userId 必填
4898
+ * 执行本接口操作的员工信息。
4899
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4741
4900
  */
4742
4901
  Operator: UserInfo;
4743
4902
  /**
4744
- * 签署流程id
4903
+ * 合同流程ID, 为32位字符串。
4904
+ 建议开发者保存此流程ID方便后续其他操作。
4745
4905
  */
4746
4906
  FlowId: string;
4747
4907
  /**
4748
- * 撤销原因,最长200个字符;
4908
+ * 撤销此合同(流程)的原因,最长200个字。
4749
4909
  */
4750
4910
  CancelMessage: string;
4751
4911
  /**
4752
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4912
+ * 代理企业和员工的信息。
4913
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4753
4914
  */
4754
4915
  Agent?: Agent;
4755
4916
  }
@@ -5580,11 +5741,13 @@ export interface CancelMultiFlowSignQRCodeResponse {
5580
5741
  */
5581
5742
  export interface CreateFlowResponse {
5582
5743
  /**
5583
- * 签署流程编号,
5744
+ * 合同流程ID,为32位字符串。
5745
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
5746
+
5747
+ 注:
5748
+ 此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节
5584
5749
 
5585
- 返回的流程编号,需要在CreateDocument,StartFlow中使用,
5586
5750
 
5587
- 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
5588
5751
  */
5589
5752
  FlowId?: string;
5590
5753
  /**
@@ -5597,20 +5760,24 @@ export interface CreateFlowResponse {
5597
5760
  */
5598
5761
  export interface DescribeUserAutoSignStatusRequest {
5599
5762
  /**
5600
- * 操作人信息,UserId必填
5763
+ * 执行本接口操作的员工信息。
5764
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5601
5765
  */
5602
5766
  Operator: UserInfo;
5603
5767
  /**
5604
- * 自动签场景:
5605
- E_PRESCRIPTION_AUTO_SIGN 电子处方
5768
+ * 自动签使用的场景值, 可以选择的场景值如下:
5769
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5770
+
5771
+ 注: `现在仅支持电子处方场景`
5606
5772
  */
5607
5773
  SceneKey: string;
5608
5774
  /**
5609
- * 要查询开启状态的用户信息
5775
+ * 要查询状态的用户信息, 包括名字,身份证等
5610
5776
  */
5611
5777
  UserInfo: UserThreeFactor;
5612
5778
  /**
5613
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5779
+ * 代理企业和员工的信息。
5780
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5614
5781
  */
5615
5782
  Agent?: Agent;
5616
5783
  }