tencentcloud-sdk-nodejs-essbasic 4.0.998 → 4.0.999
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/package.json +1 -1
- package/products.md +30 -30
- package/src/services/essbasic/v20210526/essbasic_client.ts +79 -37
- package/src/services/essbasic/v20210526/essbasic_models.ts +247 -103
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +45 -23
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +50 -24
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +239 -103
|
@@ -437,6 +437,25 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
437
437
|
async ChannelDescribeOrganizationSeals(req, cb) {
|
|
438
438
|
return this.request("ChannelDescribeOrganizationSeals", req, cb);
|
|
439
439
|
}
|
|
440
|
+
/**
|
|
441
|
+
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
|
|
442
|
+
|
|
443
|
+
注意:
|
|
444
|
+
|
|
445
|
+
- **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
|
|
446
|
+
- **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
|
|
447
|
+
|
|
448
|
+

|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
- **企业统一社会信用代码**: 对应上图中的**1**
|
|
452
|
+
- **第三方平台子客企业名称**: 对应上图中的**2**
|
|
453
|
+
- **企业法定代表人的名字**:对应上图中的**3**
|
|
454
|
+
- **企业详细住所**:对应上图中的**4**
|
|
455
|
+
*/
|
|
456
|
+
async SyncProxyOrganization(req, cb) {
|
|
457
|
+
return this.request("SyncProxyOrganization", req, cb);
|
|
458
|
+
}
|
|
440
459
|
/**
|
|
441
460
|
* 通过此接口,删除员工绑定的角色,支持以电子签userId、客户系统userId两种方式调用。
|
|
442
461
|
|
|
@@ -701,19 +720,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
701
720
|
return this.request("ChannelGetTaskResultApi", req, cb);
|
|
702
721
|
}
|
|
703
722
|
/**
|
|
704
|
-
*
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-

|
|
723
|
+
* 接口(ChannelCreateDynamicFlowApprover)用来补充<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>发起的动态合同的签署人信息
|
|
724
|
+
**注**:
|
|
725
|
+
<ul>
|
|
726
|
+
<li>此接口需要保证:渠道企业已开启:模块化计费能力,</li>
|
|
727
|
+
<li>此接口需要保证:渠道应用已开启:动态签署人2.0能力</li>
|
|
728
|
+
<li>此接口需要保证:合同发起时指定开启了动态合同</li>
|
|
729
|
+
<li>此接口补充的动态签署人传参规则,请参考接口:<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>的签署人传参规则</li>
|
|
730
|
+
</ul>
|
|
714
731
|
*/
|
|
715
|
-
async
|
|
716
|
-
return this.request("
|
|
732
|
+
async ChannelCreateDynamicFlowApprover(req, cb) {
|
|
733
|
+
return this.request("ChannelCreateDynamicFlowApprover", req, cb);
|
|
717
734
|
}
|
|
718
735
|
/**
|
|
719
736
|
* 此接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态。
|
|
@@ -882,6 +899,19 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
882
899
|
async ChannelBatchCancelFlows(req, cb) {
|
|
883
900
|
return this.request("ChannelBatchCancelFlows", req, cb);
|
|
884
901
|
}
|
|
902
|
+
/**
|
|
903
|
+
* 该接口用于结束动态签署方2.0的合同流程。
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
**功能开通**
|
|
907
|
+
- 动态签署方2.0功能的使用需要先<font color="red">联系产品经理开通模块化计费功能</font>,然后到控制台中打开此功能。详细的使用说明请参考<a href="https://qian.tencent.com/developers/company/dynamic_signer_v2" target="_blank">动态签署方2.0</a>文档。
|
|
908
|
+
|
|
909
|
+
**使用条件**
|
|
910
|
+
- 此接口只能在<font color="red">合同处于非终态且<b>所有的签署方都已经完成签署</b></font>。一旦合同进入终态(例如:过期、拒签、撤销或者调用过此接口成功过),将无法通过此接口结束合同流程。
|
|
911
|
+
*/
|
|
912
|
+
async ArchiveDynamicFlow(req, cb) {
|
|
913
|
+
return this.request("ArchiveDynamicFlow", req, cb);
|
|
914
|
+
}
|
|
885
915
|
/**
|
|
886
916
|
* 该接口 (PrepareFlows) 用于创建待发起文件
|
|
887
917
|
用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
|
@@ -1088,23 +1118,19 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
1088
1118
|
return this.request("ChannelCreateFlowReminds", req, cb);
|
|
1089
1119
|
}
|
|
1090
1120
|
/**
|
|
1091
|
-
*
|
|
1121
|
+
* 提交申请出证报告任务并返回报告ID。
|
|
1092
1122
|
|
|
1093
1123
|
注意:
|
|
1094
|
-
|
|
1095
|
-
-
|
|
1096
|
-
-
|
|
1097
|
-
|
|
1098
|
-

|
|
1124
|
+
- 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
|
|
1125
|
+
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
1126
|
+
- 合同流程必须**所有参与方已经签署完成**。
|
|
1127
|
+
- 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
1099
1128
|
|
|
1100
1129
|
|
|
1101
|
-
-
|
|
1102
|
-
- **第三方平台子客企业名称**: 对应上图中的**2**
|
|
1103
|
-
- **企业法定代表人的名字**:对应上图中的**3**
|
|
1104
|
-
- **企业详细住所**:对应上图中的**4**
|
|
1130
|
+

|
|
1105
1131
|
*/
|
|
1106
|
-
async
|
|
1107
|
-
return this.request("
|
|
1132
|
+
async CreateChannelFlowEvidenceReport(req, cb) {
|
|
1133
|
+
return this.request("CreateChannelFlowEvidenceReport", req, cb);
|
|
1108
1134
|
}
|
|
1109
1135
|
/**
|
|
1110
1136
|
* 接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。
|
|
@@ -760,9 +760,9 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
760
760
|
Operator?: UserInfo;
|
|
761
761
|
}
|
|
762
762
|
/**
|
|
763
|
-
*
|
|
763
|
+
* ChannelCancelFlow返回参数结构体
|
|
764
764
|
*/
|
|
765
|
-
export interface
|
|
765
|
+
export interface ChannelCancelFlowResponse {
|
|
766
766
|
/**
|
|
767
767
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
768
768
|
*/
|
|
@@ -1089,6 +1089,19 @@ export interface OperateChannelTemplateResponse {
|
|
|
1089
1089
|
*/
|
|
1090
1090
|
RequestId?: string;
|
|
1091
1091
|
}
|
|
1092
|
+
/**
|
|
1093
|
+
* ChannelCreateDynamicFlowApprover返回参数结构体
|
|
1094
|
+
*/
|
|
1095
|
+
export interface ChannelCreateDynamicFlowApproverResponse {
|
|
1096
|
+
/**
|
|
1097
|
+
* 动态合同补充结果列表
|
|
1098
|
+
*/
|
|
1099
|
+
DynamicFlowResultList?: Array<DynamicFlowResult>;
|
|
1100
|
+
/**
|
|
1101
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1102
|
+
*/
|
|
1103
|
+
RequestId?: string;
|
|
1104
|
+
}
|
|
1092
1105
|
/**
|
|
1093
1106
|
* 合同组中每个子合同的发起信息
|
|
1094
1107
|
*/
|
|
@@ -1601,9 +1614,9 @@ export interface ChannelCreatePrepareFlowRequest {
|
|
|
1601
1614
|
Operator?: UserInfo;
|
|
1602
1615
|
}
|
|
1603
1616
|
/**
|
|
1604
|
-
*
|
|
1617
|
+
* ChannelCreateFlowSignUrl请求参数结构体
|
|
1605
1618
|
*/
|
|
1606
|
-
export interface
|
|
1619
|
+
export interface ChannelCreateFlowSignUrlRequest {
|
|
1607
1620
|
/**
|
|
1608
1621
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1609
1622
|
|
|
@@ -1617,9 +1630,45 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
1617
1630
|
*/
|
|
1618
1631
|
Agent: Agent;
|
|
1619
1632
|
/**
|
|
1620
|
-
*
|
|
1633
|
+
* 合同流程ID,为32位字符串。
|
|
1634
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
1635
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
1621
1636
|
*/
|
|
1622
|
-
|
|
1637
|
+
FlowId: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* 流程签署人列表,其中结构体的ApproverType必传。
|
|
1640
|
+
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
|
1641
|
+
若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。
|
|
1642
|
+
|
|
1643
|
+
注:
|
|
1644
|
+
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
1645
|
+
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
1646
|
+
*/
|
|
1647
|
+
FlowApproverInfos?: Array<FlowApproverInfo>;
|
|
1648
|
+
/**
|
|
1649
|
+
* 用户信息,暂未开放
|
|
1650
|
+
* @deprecated
|
|
1651
|
+
*/
|
|
1652
|
+
Operator?: UserInfo;
|
|
1653
|
+
/**
|
|
1654
|
+
* 机构信息,暂未开放
|
|
1655
|
+
* @deprecated
|
|
1656
|
+
*/
|
|
1657
|
+
Organization?: OrganizationInfo;
|
|
1658
|
+
/**
|
|
1659
|
+
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
1660
|
+
|
|
1661
|
+
*/
|
|
1662
|
+
JumpUrl?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* 链接类型,支持指定以下类型
|
|
1665
|
+
<ul><li>0 : 签署链接 (默认值)</li>
|
|
1666
|
+
<li>1 : 预览链接</li></ul>
|
|
1667
|
+
注:
|
|
1668
|
+
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
1669
|
+
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
1670
|
+
*/
|
|
1671
|
+
UrlType?: number;
|
|
1623
1672
|
}
|
|
1624
1673
|
/**
|
|
1625
1674
|
* ChannelCreateSealPolicy返回参数结构体
|
|
@@ -1687,9 +1736,9 @@ export interface ChannelDescribeSignFaceVideoResponse {
|
|
|
1687
1736
|
RequestId?: string;
|
|
1688
1737
|
}
|
|
1689
1738
|
/**
|
|
1690
|
-
*
|
|
1739
|
+
* ChannelCancelUserAutoSignEnableUrl返回参数结构体
|
|
1691
1740
|
*/
|
|
1692
|
-
export interface
|
|
1741
|
+
export interface ChannelCancelUserAutoSignEnableUrlResponse {
|
|
1693
1742
|
/**
|
|
1694
1743
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1695
1744
|
*/
|
|
@@ -2029,6 +2078,13 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
2029
2078
|
|
|
2030
2079
|
*/
|
|
2031
2080
|
PreviewType?: number;
|
|
2081
|
+
/**
|
|
2082
|
+
* 是否开启动态合同(动态签署人2.0)
|
|
2083
|
+
<ul><li> **false** :(默认) 不开启动态合同(动态签署人2.0)</li>
|
|
2084
|
+
<li> **true** :开启动态合同(动态签署人2.0),发起后可继续追加合同签署人</li></ul>
|
|
2085
|
+
|
|
2086
|
+
*/
|
|
2087
|
+
OpenDynamicFlow?: boolean;
|
|
2032
2088
|
}
|
|
2033
2089
|
/**
|
|
2034
2090
|
* UploadFiles返回参数结构体
|
|
@@ -2361,31 +2417,28 @@ export interface ChannelRenewAutoSignLicenseResponse {
|
|
|
2361
2417
|
RequestId?: string;
|
|
2362
2418
|
}
|
|
2363
2419
|
/**
|
|
2364
|
-
*
|
|
2420
|
+
* 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
|
|
2365
2421
|
*/
|
|
2366
|
-
export interface
|
|
2422
|
+
export interface ApproverItem {
|
|
2367
2423
|
/**
|
|
2368
|
-
*
|
|
2369
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
2424
|
+
* 签署方唯一编号
|
|
2370
2425
|
|
|
2371
|
-
|
|
2426
|
+
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
2372
2427
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2373
2428
|
*/
|
|
2374
|
-
|
|
2429
|
+
SignId?: string;
|
|
2375
2430
|
/**
|
|
2376
|
-
*
|
|
2431
|
+
* 签署方角色编号
|
|
2432
|
+
|
|
2433
|
+
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
2377
2434
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2378
2435
|
*/
|
|
2379
|
-
|
|
2380
|
-
/**
|
|
2381
|
-
* 预览链接,有效期5分钟
|
|
2382
|
-
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
2383
|
-
*/
|
|
2384
|
-
PreviewUrl?: string;
|
|
2436
|
+
RecipientId?: string;
|
|
2385
2437
|
/**
|
|
2386
|
-
*
|
|
2438
|
+
* 签署方角色名称
|
|
2439
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2387
2440
|
*/
|
|
2388
|
-
|
|
2441
|
+
ApproverRoleName?: string;
|
|
2389
2442
|
}
|
|
2390
2443
|
/**
|
|
2391
2444
|
* DescribeFlowDetailInfo返回参数结构体
|
|
@@ -2744,6 +2797,23 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
|
|
|
2744
2797
|
*/
|
|
2745
2798
|
Mobile?: string;
|
|
2746
2799
|
}
|
|
2800
|
+
/**
|
|
2801
|
+
* 动态合同签署人结果
|
|
2802
|
+
*/
|
|
2803
|
+
export interface DynamicFlowApproverResult {
|
|
2804
|
+
/**
|
|
2805
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
2806
|
+
*/
|
|
2807
|
+
RecipientId?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* 签署ID - 发起流程时系统自动补充 - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
2810
|
+
*/
|
|
2811
|
+
SignId?: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* 签署人状态信息
|
|
2814
|
+
*/
|
|
2815
|
+
ApproverStatus?: number;
|
|
2816
|
+
}
|
|
2747
2817
|
/**
|
|
2748
2818
|
* GetDownloadFlowUrl返回参数结构体
|
|
2749
2819
|
*/
|
|
@@ -3419,6 +3489,23 @@ export interface OrganizationCommonInfo {
|
|
|
3419
3489
|
*/
|
|
3420
3490
|
OldAdminIdCardNumber?: string;
|
|
3421
3491
|
}
|
|
3492
|
+
/**
|
|
3493
|
+
* ArchiveDynamicFlow返回参数结构体
|
|
3494
|
+
*/
|
|
3495
|
+
export interface ArchiveDynamicFlowResponse {
|
|
3496
|
+
/**
|
|
3497
|
+
* 合同流程ID
|
|
3498
|
+
*/
|
|
3499
|
+
FlowId?: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* 动态签署人的参与人信息
|
|
3502
|
+
*/
|
|
3503
|
+
Approvers?: Array<ChannelArchiveDynamicApproverData>;
|
|
3504
|
+
/**
|
|
3505
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3506
|
+
*/
|
|
3507
|
+
RequestId?: string;
|
|
3508
|
+
}
|
|
3422
3509
|
/**
|
|
3423
3510
|
* CreateConsoleLoginUrl请求参数结构体
|
|
3424
3511
|
*/
|
|
@@ -3920,6 +4007,19 @@ export interface CreateEmployeeQualificationSealQrCodeRequest {
|
|
|
3920
4007
|
*/
|
|
3921
4008
|
HintText?: string;
|
|
3922
4009
|
}
|
|
4010
|
+
/**
|
|
4011
|
+
* 动态签署2.0合同参与人信息
|
|
4012
|
+
*/
|
|
4013
|
+
export interface ChannelArchiveDynamicApproverData {
|
|
4014
|
+
/**
|
|
4015
|
+
* 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
|
|
4016
|
+
*/
|
|
4017
|
+
SignId?: string;
|
|
4018
|
+
/**
|
|
4019
|
+
* 签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。
|
|
4020
|
+
*/
|
|
4021
|
+
RecipientId?: string;
|
|
4022
|
+
}
|
|
3923
4023
|
/**
|
|
3924
4024
|
* ChannelCreateUserAutoSignSealUrl请求参数结构体
|
|
3925
4025
|
*/
|
|
@@ -4336,6 +4436,27 @@ export interface CreatePartnerAutoSignAuthUrlResponse {
|
|
|
4336
4436
|
*/
|
|
4337
4437
|
RequestId?: string;
|
|
4338
4438
|
}
|
|
4439
|
+
/**
|
|
4440
|
+
* ArchiveDynamicFlow请求参数结构体
|
|
4441
|
+
*/
|
|
4442
|
+
export interface ArchiveDynamicFlowRequest {
|
|
4443
|
+
/**
|
|
4444
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4445
|
+
|
|
4446
|
+
此接口下面信息必填。
|
|
4447
|
+
<ul>
|
|
4448
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4449
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4450
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
4451
|
+
</ul>
|
|
4452
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
4453
|
+
*/
|
|
4454
|
+
Agent: Agent;
|
|
4455
|
+
/**
|
|
4456
|
+
* 合同流程ID
|
|
4457
|
+
*/
|
|
4458
|
+
FlowId: string;
|
|
4459
|
+
}
|
|
4339
4460
|
/**
|
|
4340
4461
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
4341
4462
|
*/
|
|
@@ -4452,40 +4573,18 @@ export interface FlowInfo {
|
|
|
4452
4573
|
FlowDisplayType?: number;
|
|
4453
4574
|
}
|
|
4454
4575
|
/**
|
|
4455
|
-
*
|
|
4576
|
+
* ChannelCreateDynamicFlowApprover请求参数结构体
|
|
4456
4577
|
*/
|
|
4457
|
-
export interface
|
|
4578
|
+
export interface ChannelCreateDynamicFlowApproverRequest {
|
|
4458
4579
|
/**
|
|
4459
|
-
*
|
|
4460
|
-
|
|
4580
|
+
* 动态合同信息
|
|
4461
4581
|
|
|
4462
|
-
注意:
|
|
4463
|
-
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
4464
|
-
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
4465
|
-
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
4466
|
-

|
|
4467
|
-
*/
|
|
4468
|
-
OpenId?: string;
|
|
4469
|
-
/**
|
|
4470
|
-
* 内部参数,暂未开放使用
|
|
4471
|
-
* @deprecated
|
|
4472
4582
|
*/
|
|
4473
|
-
|
|
4583
|
+
FillDynamicFlowList: Array<DynamicFlowInfo>;
|
|
4474
4584
|
/**
|
|
4475
|
-
*
|
|
4476
|
-
* @deprecated
|
|
4477
|
-
*/
|
|
4478
|
-
CustomUserId?: string;
|
|
4479
|
-
/**
|
|
4480
|
-
* 内部参数,暂未开放使用
|
|
4481
|
-
* @deprecated
|
|
4482
|
-
*/
|
|
4483
|
-
ClientIp?: string;
|
|
4484
|
-
/**
|
|
4485
|
-
* 内部参数,暂未开放使用
|
|
4486
|
-
* @deprecated
|
|
4585
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证
|
|
4487
4586
|
*/
|
|
4488
|
-
|
|
4587
|
+
Agent?: Agent;
|
|
4489
4588
|
}
|
|
4490
4589
|
/**
|
|
4491
4590
|
* ModifyFlowDeadline返回参数结构体
|
|
@@ -6326,6 +6425,19 @@ export interface Filter {
|
|
|
6326
6425
|
*/
|
|
6327
6426
|
Values: Array<string>;
|
|
6328
6427
|
}
|
|
6428
|
+
/**
|
|
6429
|
+
* 动态合同补充签署人结果
|
|
6430
|
+
*/
|
|
6431
|
+
export interface DynamicFlowResult {
|
|
6432
|
+
/**
|
|
6433
|
+
* 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
|
6434
|
+
*/
|
|
6435
|
+
FlowId?: string;
|
|
6436
|
+
/**
|
|
6437
|
+
* 动态合同签署人补充结果信息列表
|
|
6438
|
+
*/
|
|
6439
|
+
DynamicFlowApproverList?: Array<DynamicFlowApproverResult>;
|
|
6440
|
+
}
|
|
6329
6441
|
/**
|
|
6330
6442
|
* 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
|
|
6331
6443
|
*/
|
|
@@ -6675,28 +6787,31 @@ export interface IntentionAction {
|
|
|
6675
6787
|
Text?: string;
|
|
6676
6788
|
}
|
|
6677
6789
|
/**
|
|
6678
|
-
*
|
|
6790
|
+
* ChannelCreateFlowByFiles返回参数结构体
|
|
6679
6791
|
*/
|
|
6680
|
-
export interface
|
|
6792
|
+
export interface ChannelCreateFlowByFilesResponse {
|
|
6681
6793
|
/**
|
|
6682
|
-
*
|
|
6794
|
+
* 合同流程ID,为32位字符串。
|
|
6795
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
6683
6796
|
|
|
6684
|
-
|
|
6797
|
+
[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
|
6685
6798
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6686
6799
|
*/
|
|
6687
|
-
|
|
6800
|
+
FlowId?: string;
|
|
6688
6801
|
/**
|
|
6689
|
-
*
|
|
6690
|
-
|
|
6691
|
-
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
6802
|
+
* 签署方信息,如角色ID、角色名称等
|
|
6692
6803
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6693
6804
|
*/
|
|
6694
|
-
|
|
6805
|
+
Approvers?: Array<ApproverItem>;
|
|
6695
6806
|
/**
|
|
6696
|
-
*
|
|
6697
|
-
|
|
6807
|
+
* 预览链接,有效期5分钟
|
|
6808
|
+
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
6698
6809
|
*/
|
|
6699
|
-
|
|
6810
|
+
PreviewUrl?: string;
|
|
6811
|
+
/**
|
|
6812
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
6813
|
+
*/
|
|
6814
|
+
RequestId?: string;
|
|
6700
6815
|
}
|
|
6701
6816
|
/**
|
|
6702
6817
|
* ChannelCreateFlowSignReview返回参数结构体
|
|
@@ -6790,6 +6905,27 @@ export interface CreateSealByImageResponse {
|
|
|
6790
6905
|
*/
|
|
6791
6906
|
RequestId?: string;
|
|
6792
6907
|
}
|
|
6908
|
+
/**
|
|
6909
|
+
* 动态合同信息
|
|
6910
|
+
*/
|
|
6911
|
+
export interface DynamicFlowInfo {
|
|
6912
|
+
/**
|
|
6913
|
+
* 合同流程ID,为32位字符串。 - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
|
|
6914
|
+
*/
|
|
6915
|
+
FlowId: string;
|
|
6916
|
+
/**
|
|
6917
|
+
* 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
|
|
6918
|
+
*/
|
|
6919
|
+
FlowApprovers: Array<FlowApproverInfo>;
|
|
6920
|
+
/**
|
|
6921
|
+
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
6922
|
+
*/
|
|
6923
|
+
AutoSignScene?: string;
|
|
6924
|
+
/**
|
|
6925
|
+
* 签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
6926
|
+
*/
|
|
6927
|
+
ApproverVerifyType?: string;
|
|
6928
|
+
}
|
|
6793
6929
|
/**
|
|
6794
6930
|
* ChannelCancelMultiFlowSignQRCode返回参数结构体
|
|
6795
6931
|
*/
|
|
@@ -7657,6 +7793,42 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
|
7657
7793
|
*/
|
|
7658
7794
|
FlowGroupName: string;
|
|
7659
7795
|
}
|
|
7796
|
+
/**
|
|
7797
|
+
* 接口调用的员工信息
|
|
7798
|
+
*/
|
|
7799
|
+
export interface UserInfo {
|
|
7800
|
+
/**
|
|
7801
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
|
|
7802
|
+
|
|
7803
|
+
|
|
7804
|
+
注意:
|
|
7805
|
+
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
7806
|
+
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
7807
|
+
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
7808
|
+

|
|
7809
|
+
*/
|
|
7810
|
+
OpenId?: string;
|
|
7811
|
+
/**
|
|
7812
|
+
* 内部参数,暂未开放使用
|
|
7813
|
+
* @deprecated
|
|
7814
|
+
*/
|
|
7815
|
+
Channel?: string;
|
|
7816
|
+
/**
|
|
7817
|
+
* 内部参数,暂未开放使用
|
|
7818
|
+
* @deprecated
|
|
7819
|
+
*/
|
|
7820
|
+
CustomUserId?: string;
|
|
7821
|
+
/**
|
|
7822
|
+
* 内部参数,暂未开放使用
|
|
7823
|
+
* @deprecated
|
|
7824
|
+
*/
|
|
7825
|
+
ClientIp?: string;
|
|
7826
|
+
/**
|
|
7827
|
+
* 内部参数,暂未开放使用
|
|
7828
|
+
* @deprecated
|
|
7829
|
+
*/
|
|
7830
|
+
ProxyIp?: string;
|
|
7831
|
+
}
|
|
7660
7832
|
/**
|
|
7661
7833
|
* CreateBatchInitOrganizationUrl请求参数结构体
|
|
7662
7834
|
*/
|
|
@@ -8621,9 +8793,9 @@ export interface ChannelUpdateSealStatusResponse {
|
|
|
8621
8793
|
RequestId?: string;
|
|
8622
8794
|
}
|
|
8623
8795
|
/**
|
|
8624
|
-
*
|
|
8796
|
+
* ChannelCreateFlowReminds请求参数结构体
|
|
8625
8797
|
*/
|
|
8626
|
-
export interface
|
|
8798
|
+
export interface ChannelCreateFlowRemindsRequest {
|
|
8627
8799
|
/**
|
|
8628
8800
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
8629
8801
|
|
|
@@ -8637,45 +8809,9 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
8637
8809
|
*/
|
|
8638
8810
|
Agent: Agent;
|
|
8639
8811
|
/**
|
|
8640
|
-
*
|
|
8641
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
8642
|
-
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
8643
|
-
*/
|
|
8644
|
-
FlowId: string;
|
|
8645
|
-
/**
|
|
8646
|
-
* 流程签署人列表,其中结构体的ApproverType必传。
|
|
8647
|
-
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
|
8648
|
-
若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。
|
|
8649
|
-
|
|
8650
|
-
注:
|
|
8651
|
-
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
8652
|
-
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
8653
|
-
*/
|
|
8654
|
-
FlowApproverInfos?: Array<FlowApproverInfo>;
|
|
8655
|
-
/**
|
|
8656
|
-
* 用户信息,暂未开放
|
|
8657
|
-
* @deprecated
|
|
8658
|
-
*/
|
|
8659
|
-
Operator?: UserInfo;
|
|
8660
|
-
/**
|
|
8661
|
-
* 机构信息,暂未开放
|
|
8662
|
-
* @deprecated
|
|
8663
|
-
*/
|
|
8664
|
-
Organization?: OrganizationInfo;
|
|
8665
|
-
/**
|
|
8666
|
-
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
8667
|
-
|
|
8668
|
-
*/
|
|
8669
|
-
JumpUrl?: string;
|
|
8670
|
-
/**
|
|
8671
|
-
* 链接类型,支持指定以下类型
|
|
8672
|
-
<ul><li>0 : 签署链接 (默认值)</li>
|
|
8673
|
-
<li>1 : 预览链接</li></ul>
|
|
8674
|
-
注:
|
|
8675
|
-
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
8676
|
-
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
8812
|
+
* 需执行催办的合同流程ID数组,最多支持100个。
|
|
8677
8813
|
*/
|
|
8678
|
-
|
|
8814
|
+
FlowIds: Array<string>;
|
|
8679
8815
|
}
|
|
8680
8816
|
/**
|
|
8681
8817
|
* DescribeExtendedServiceAuthInfo返回参数结构体
|