tencentcloud-sdk-nodejs-essbasic 4.0.998 → 4.0.1000
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 +46 -46
- package/src/services/essbasic/v20210526/essbasic_client.ts +79 -37
- package/src/services/essbasic/v20210526/essbasic_models.ts +265 -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 +257 -103
|
@@ -798,9 +798,9 @@ export interface DescribeFlowDetailInfoRequest {
|
|
|
798
798
|
}
|
|
799
799
|
|
|
800
800
|
/**
|
|
801
|
-
*
|
|
801
|
+
* ChannelCancelFlow返回参数结构体
|
|
802
802
|
*/
|
|
803
|
-
export interface
|
|
803
|
+
export interface ChannelCancelFlowResponse {
|
|
804
804
|
/**
|
|
805
805
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
806
806
|
*/
|
|
@@ -1141,6 +1141,20 @@ export interface OperateChannelTemplateResponse {
|
|
|
1141
1141
|
RequestId?: string
|
|
1142
1142
|
}
|
|
1143
1143
|
|
|
1144
|
+
/**
|
|
1145
|
+
* ChannelCreateDynamicFlowApprover返回参数结构体
|
|
1146
|
+
*/
|
|
1147
|
+
export interface ChannelCreateDynamicFlowApproverResponse {
|
|
1148
|
+
/**
|
|
1149
|
+
* 动态合同补充结果列表
|
|
1150
|
+
*/
|
|
1151
|
+
DynamicFlowResultList?: Array<DynamicFlowResult>
|
|
1152
|
+
/**
|
|
1153
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1154
|
+
*/
|
|
1155
|
+
RequestId?: string
|
|
1156
|
+
}
|
|
1157
|
+
|
|
1144
1158
|
/**
|
|
1145
1159
|
* 合同组中每个子合同的发起信息
|
|
1146
1160
|
*/
|
|
@@ -1664,9 +1678,9 @@ export interface ChannelCreatePrepareFlowRequest {
|
|
|
1664
1678
|
}
|
|
1665
1679
|
|
|
1666
1680
|
/**
|
|
1667
|
-
*
|
|
1681
|
+
* ChannelCreateFlowSignUrl请求参数结构体
|
|
1668
1682
|
*/
|
|
1669
|
-
export interface
|
|
1683
|
+
export interface ChannelCreateFlowSignUrlRequest {
|
|
1670
1684
|
/**
|
|
1671
1685
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1672
1686
|
|
|
@@ -1680,9 +1694,45 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
1680
1694
|
*/
|
|
1681
1695
|
Agent: Agent
|
|
1682
1696
|
/**
|
|
1683
|
-
*
|
|
1697
|
+
* 合同流程ID,为32位字符串。
|
|
1698
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
1699
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
1684
1700
|
*/
|
|
1685
|
-
|
|
1701
|
+
FlowId: string
|
|
1702
|
+
/**
|
|
1703
|
+
* 流程签署人列表,其中结构体的ApproverType必传。
|
|
1704
|
+
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
|
1705
|
+
若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。
|
|
1706
|
+
|
|
1707
|
+
注:
|
|
1708
|
+
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
1709
|
+
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
1710
|
+
*/
|
|
1711
|
+
FlowApproverInfos?: Array<FlowApproverInfo>
|
|
1712
|
+
/**
|
|
1713
|
+
* 用户信息,暂未开放
|
|
1714
|
+
* @deprecated
|
|
1715
|
+
*/
|
|
1716
|
+
Operator?: UserInfo
|
|
1717
|
+
/**
|
|
1718
|
+
* 机构信息,暂未开放
|
|
1719
|
+
* @deprecated
|
|
1720
|
+
*/
|
|
1721
|
+
Organization?: OrganizationInfo
|
|
1722
|
+
/**
|
|
1723
|
+
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
1724
|
+
|
|
1725
|
+
*/
|
|
1726
|
+
JumpUrl?: string
|
|
1727
|
+
/**
|
|
1728
|
+
* 链接类型,支持指定以下类型
|
|
1729
|
+
<ul><li>0 : 签署链接 (默认值)</li>
|
|
1730
|
+
<li>1 : 预览链接</li></ul>
|
|
1731
|
+
注:
|
|
1732
|
+
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
1733
|
+
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
1734
|
+
*/
|
|
1735
|
+
UrlType?: number
|
|
1686
1736
|
}
|
|
1687
1737
|
|
|
1688
1738
|
/**
|
|
@@ -1754,9 +1804,9 @@ export interface ChannelDescribeSignFaceVideoResponse {
|
|
|
1754
1804
|
}
|
|
1755
1805
|
|
|
1756
1806
|
/**
|
|
1757
|
-
*
|
|
1807
|
+
* ChannelCancelUserAutoSignEnableUrl返回参数结构体
|
|
1758
1808
|
*/
|
|
1759
|
-
export interface
|
|
1809
|
+
export interface ChannelCancelUserAutoSignEnableUrlResponse {
|
|
1760
1810
|
/**
|
|
1761
1811
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1762
1812
|
*/
|
|
@@ -2103,6 +2153,13 @@ MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverM
|
|
|
2103
2153
|
|
|
2104
2154
|
*/
|
|
2105
2155
|
PreviewType?: number
|
|
2156
|
+
/**
|
|
2157
|
+
* 是否开启动态合同(动态签署人2.0)
|
|
2158
|
+
<ul><li> **false** :(默认) 不开启动态合同(动态签署人2.0)</li>
|
|
2159
|
+
<li> **true** :开启动态合同(动态签署人2.0),发起后可继续追加合同签署人</li></ul>
|
|
2160
|
+
|
|
2161
|
+
*/
|
|
2162
|
+
OpenDynamicFlow?: boolean
|
|
2106
2163
|
}
|
|
2107
2164
|
|
|
2108
2165
|
/**
|
|
@@ -2446,31 +2503,28 @@ export interface ChannelRenewAutoSignLicenseResponse {
|
|
|
2446
2503
|
}
|
|
2447
2504
|
|
|
2448
2505
|
/**
|
|
2449
|
-
*
|
|
2506
|
+
* 签署方信息,发起合同后可获取到对应的签署方信息,如角色ID,角色名称
|
|
2450
2507
|
*/
|
|
2451
|
-
export interface
|
|
2508
|
+
export interface ApproverItem {
|
|
2452
2509
|
/**
|
|
2453
|
-
*
|
|
2454
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
2510
|
+
* 签署方唯一编号
|
|
2455
2511
|
|
|
2456
|
-
|
|
2512
|
+
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
2457
2513
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2458
2514
|
*/
|
|
2459
|
-
|
|
2515
|
+
SignId?: string
|
|
2460
2516
|
/**
|
|
2461
|
-
*
|
|
2517
|
+
* 签署方角色编号
|
|
2518
|
+
|
|
2519
|
+
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
2462
2520
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2463
2521
|
*/
|
|
2464
|
-
|
|
2465
|
-
/**
|
|
2466
|
-
* 预览链接,有效期5分钟
|
|
2467
|
-
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
2468
|
-
*/
|
|
2469
|
-
PreviewUrl?: string
|
|
2522
|
+
RecipientId?: string
|
|
2470
2523
|
/**
|
|
2471
|
-
*
|
|
2524
|
+
* 签署方角色名称
|
|
2525
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2472
2526
|
*/
|
|
2473
|
-
|
|
2527
|
+
ApproverRoleName?: string
|
|
2474
2528
|
}
|
|
2475
2529
|
|
|
2476
2530
|
/**
|
|
@@ -2840,6 +2894,24 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
|
|
|
2840
2894
|
Mobile?: string
|
|
2841
2895
|
}
|
|
2842
2896
|
|
|
2897
|
+
/**
|
|
2898
|
+
* 动态合同签署人结果
|
|
2899
|
+
*/
|
|
2900
|
+
export interface DynamicFlowApproverResult {
|
|
2901
|
+
/**
|
|
2902
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
2903
|
+
*/
|
|
2904
|
+
RecipientId?: string
|
|
2905
|
+
/**
|
|
2906
|
+
* 签署ID - 发起流程时系统自动补充 - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
2907
|
+
*/
|
|
2908
|
+
SignId?: string
|
|
2909
|
+
/**
|
|
2910
|
+
* 签署人状态信息
|
|
2911
|
+
*/
|
|
2912
|
+
ApproverStatus?: number
|
|
2913
|
+
}
|
|
2914
|
+
|
|
2843
2915
|
/**
|
|
2844
2916
|
* GetDownloadFlowUrl返回参数结构体
|
|
2845
2917
|
*/
|
|
@@ -3535,6 +3607,24 @@ export interface OrganizationCommonInfo {
|
|
|
3535
3607
|
OldAdminIdCardNumber?: string
|
|
3536
3608
|
}
|
|
3537
3609
|
|
|
3610
|
+
/**
|
|
3611
|
+
* ArchiveDynamicFlow返回参数结构体
|
|
3612
|
+
*/
|
|
3613
|
+
export interface ArchiveDynamicFlowResponse {
|
|
3614
|
+
/**
|
|
3615
|
+
* 合同流程ID
|
|
3616
|
+
*/
|
|
3617
|
+
FlowId?: string
|
|
3618
|
+
/**
|
|
3619
|
+
* 动态签署人的参与人信息
|
|
3620
|
+
*/
|
|
3621
|
+
Approvers?: Array<ChannelArchiveDynamicApproverData>
|
|
3622
|
+
/**
|
|
3623
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
3624
|
+
*/
|
|
3625
|
+
RequestId?: string
|
|
3626
|
+
}
|
|
3627
|
+
|
|
3538
3628
|
/**
|
|
3539
3629
|
* CreateConsoleLoginUrl请求参数结构体
|
|
3540
3630
|
*/
|
|
@@ -4045,6 +4135,20 @@ export interface CreateEmployeeQualificationSealQrCodeRequest {
|
|
|
4045
4135
|
HintText?: string
|
|
4046
4136
|
}
|
|
4047
4137
|
|
|
4138
|
+
/**
|
|
4139
|
+
* 动态签署2.0合同参与人信息
|
|
4140
|
+
*/
|
|
4141
|
+
export interface ChannelArchiveDynamicApproverData {
|
|
4142
|
+
/**
|
|
4143
|
+
* 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。 可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
|
|
4144
|
+
*/
|
|
4145
|
+
SignId?: string
|
|
4146
|
+
/**
|
|
4147
|
+
* 签署方角色编号,签署方角色编号是用于区分同一个流程中不同签署方的唯一标识。不同的流程会出现同样的签署方角色编号。 填写控件和签署控件都与特定的角色编号关联。
|
|
4148
|
+
*/
|
|
4149
|
+
RecipientId?: string
|
|
4150
|
+
}
|
|
4151
|
+
|
|
4048
4152
|
/**
|
|
4049
4153
|
* ChannelCreateUserAutoSignSealUrl请求参数结构体
|
|
4050
4154
|
*/
|
|
@@ -4473,6 +4577,28 @@ export interface CreatePartnerAutoSignAuthUrlResponse {
|
|
|
4473
4577
|
RequestId?: string
|
|
4474
4578
|
}
|
|
4475
4579
|
|
|
4580
|
+
/**
|
|
4581
|
+
* ArchiveDynamicFlow请求参数结构体
|
|
4582
|
+
*/
|
|
4583
|
+
export interface ArchiveDynamicFlowRequest {
|
|
4584
|
+
/**
|
|
4585
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4586
|
+
|
|
4587
|
+
此接口下面信息必填。
|
|
4588
|
+
<ul>
|
|
4589
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4590
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4591
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
4592
|
+
</ul>
|
|
4593
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
4594
|
+
*/
|
|
4595
|
+
Agent: Agent
|
|
4596
|
+
/**
|
|
4597
|
+
* 合同流程ID
|
|
4598
|
+
*/
|
|
4599
|
+
FlowId: string
|
|
4600
|
+
}
|
|
4601
|
+
|
|
4476
4602
|
/**
|
|
4477
4603
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
4478
4604
|
*/
|
|
@@ -4590,40 +4716,18 @@ export interface FlowInfo {
|
|
|
4590
4716
|
}
|
|
4591
4717
|
|
|
4592
4718
|
/**
|
|
4593
|
-
*
|
|
4719
|
+
* ChannelCreateDynamicFlowApprover请求参数结构体
|
|
4594
4720
|
*/
|
|
4595
|
-
export interface
|
|
4721
|
+
export interface ChannelCreateDynamicFlowApproverRequest {
|
|
4596
4722
|
/**
|
|
4597
|
-
*
|
|
4598
|
-
|
|
4723
|
+
* 动态合同信息
|
|
4599
4724
|
|
|
4600
|
-
注意:
|
|
4601
|
-
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
4602
|
-
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
4603
|
-
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
4604
|
-

|
|
4605
4725
|
*/
|
|
4606
|
-
|
|
4726
|
+
FillDynamicFlowList: Array<DynamicFlowInfo>
|
|
4607
4727
|
/**
|
|
4608
|
-
*
|
|
4609
|
-
* @deprecated
|
|
4728
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证
|
|
4610
4729
|
*/
|
|
4611
|
-
|
|
4612
|
-
/**
|
|
4613
|
-
* 内部参数,暂未开放使用
|
|
4614
|
-
* @deprecated
|
|
4615
|
-
*/
|
|
4616
|
-
CustomUserId?: string
|
|
4617
|
-
/**
|
|
4618
|
-
* 内部参数,暂未开放使用
|
|
4619
|
-
* @deprecated
|
|
4620
|
-
*/
|
|
4621
|
-
ClientIp?: string
|
|
4622
|
-
/**
|
|
4623
|
-
* 内部参数,暂未开放使用
|
|
4624
|
-
* @deprecated
|
|
4625
|
-
*/
|
|
4626
|
-
ProxyIp?: string
|
|
4730
|
+
Agent?: Agent
|
|
4627
4731
|
}
|
|
4628
4732
|
|
|
4629
4733
|
/**
|
|
@@ -5216,6 +5320,16 @@ export interface CreateSignUrlsRequest {
|
|
|
5216
5320
|
* 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
|
5217
5321
|
*/
|
|
5218
5322
|
FlowGroupUrlInfo?: FlowGroupUrlInfo
|
|
5323
|
+
/**
|
|
5324
|
+
* 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
|
|
5325
|
+
|
|
5326
|
+
在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
|
|
5327
|
+
|
|
5328
|
+
参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
|
|
5329
|
+
|
|
5330
|
+
|
|
5331
|
+
*/
|
|
5332
|
+
UrlUseEnv?: string
|
|
5219
5333
|
}
|
|
5220
5334
|
|
|
5221
5335
|
/**
|
|
@@ -6510,6 +6624,20 @@ export interface Filter {
|
|
|
6510
6624
|
Values: Array<string>
|
|
6511
6625
|
}
|
|
6512
6626
|
|
|
6627
|
+
/**
|
|
6628
|
+
* 动态合同补充签署人结果
|
|
6629
|
+
*/
|
|
6630
|
+
export interface DynamicFlowResult {
|
|
6631
|
+
/**
|
|
6632
|
+
* 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
|
6633
|
+
*/
|
|
6634
|
+
FlowId?: string
|
|
6635
|
+
/**
|
|
6636
|
+
* 动态合同签署人补充结果信息列表
|
|
6637
|
+
*/
|
|
6638
|
+
DynamicFlowApproverList?: Array<DynamicFlowApproverResult>
|
|
6639
|
+
}
|
|
6640
|
+
|
|
6513
6641
|
/**
|
|
6514
6642
|
* 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
|
|
6515
6643
|
*/
|
|
@@ -6871,28 +6999,31 @@ export interface IntentionAction {
|
|
|
6871
6999
|
}
|
|
6872
7000
|
|
|
6873
7001
|
/**
|
|
6874
|
-
*
|
|
7002
|
+
* ChannelCreateFlowByFiles返回参数结构体
|
|
6875
7003
|
*/
|
|
6876
|
-
export interface
|
|
7004
|
+
export interface ChannelCreateFlowByFilesResponse {
|
|
6877
7005
|
/**
|
|
6878
|
-
*
|
|
7006
|
+
* 合同流程ID,为32位字符串。
|
|
7007
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
6879
7008
|
|
|
6880
|
-
|
|
7009
|
+
[点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
|
|
6881
7010
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6882
7011
|
*/
|
|
6883
|
-
|
|
7012
|
+
FlowId?: string
|
|
6884
7013
|
/**
|
|
6885
|
-
*
|
|
6886
|
-
|
|
6887
|
-
在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
|
|
7014
|
+
* 签署方信息,如角色ID、角色名称等
|
|
6888
7015
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6889
7016
|
*/
|
|
6890
|
-
|
|
7017
|
+
Approvers?: Array<ApproverItem>
|
|
6891
7018
|
/**
|
|
6892
|
-
*
|
|
6893
|
-
|
|
7019
|
+
* 预览链接,有效期5分钟
|
|
7020
|
+
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
6894
7021
|
*/
|
|
6895
|
-
|
|
7022
|
+
PreviewUrl?: string
|
|
7023
|
+
/**
|
|
7024
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
7025
|
+
*/
|
|
7026
|
+
RequestId?: string
|
|
6896
7027
|
}
|
|
6897
7028
|
|
|
6898
7029
|
/**
|
|
@@ -6992,6 +7123,28 @@ export interface CreateSealByImageResponse {
|
|
|
6992
7123
|
RequestId?: string
|
|
6993
7124
|
}
|
|
6994
7125
|
|
|
7126
|
+
/**
|
|
7127
|
+
* 动态合同信息
|
|
7128
|
+
*/
|
|
7129
|
+
export interface DynamicFlowInfo {
|
|
7130
|
+
/**
|
|
7131
|
+
* 合同流程ID,为32位字符串。 - 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 - 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>,请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
|
|
7132
|
+
*/
|
|
7133
|
+
FlowId: string
|
|
7134
|
+
/**
|
|
7135
|
+
* 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
|
|
7136
|
+
*/
|
|
7137
|
+
FlowApprovers: Array<FlowApproverInfo>
|
|
7138
|
+
/**
|
|
7139
|
+
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传: <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:电子处方单(医疗自动签) </li><li> **OTHER** : 通用场景</li></ul> 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
7140
|
+
*/
|
|
7141
|
+
AutoSignScene?: string
|
|
7142
|
+
/**
|
|
7143
|
+
* 签署人校验方式 VerifyCheck: 人脸识别(默认) MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证) 参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
|
|
7144
|
+
*/
|
|
7145
|
+
ApproverVerifyType?: string
|
|
7146
|
+
}
|
|
7147
|
+
|
|
6995
7148
|
/**
|
|
6996
7149
|
* ChannelCancelMultiFlowSignQRCode返回参数结构体
|
|
6997
7150
|
*/
|
|
@@ -7598,6 +7751,14 @@ export interface ChannelCreateBatchSignUrlRequest {
|
|
|
7598
7751
|
3. <font color="red">电子签小程序跳转贵方APP,不支持自动跳转,必需用户手动点击完成按钮(微信的限制)</font>
|
|
7599
7752
|
*/
|
|
7600
7753
|
AutoJumpBack?: boolean
|
|
7754
|
+
/**
|
|
7755
|
+
* 签署完成后,如需“返回应用”功能,在获取签署链接接口的 UrlUseEnv 参数需设置为 **WeChatOfficialAccounts**,小程序签署成功的结果页面中才会出现“返回应用”按钮。
|
|
7756
|
+
|
|
7757
|
+
在用户点击“返回应用”按钮之后,会返回到公众号 H5。 此时,公众号 H5 可以处理页面的 [visibilitychange](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event) 事件 与 [visibilityState](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) 属性 来判断已经返回到当前页面。再通过电子签后台接口查询合同的签署状态,继续自己的业务流程。
|
|
7758
|
+
|
|
7759
|
+
参考 [微信网页开发-开放标签跳转小程序](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_Open_Tag.html#%E5%BC%80%E6%94%BE%E6%A0%87%E7%AD%BE) 或 [自有 H5 跳转电子签小程序](https://test.qian.tencent.cn/developers/company/openwxminiprogram/#4%E8%87%AA%E6%9C%89-h5-%E8%B7%B3%E8%BD%AC%E7%94%B5%E5%AD%90%E7%AD%BE%E5%B0%8F%E7%A8%8B%E5%BA%8F)。
|
|
7760
|
+
*/
|
|
7761
|
+
UrlUseEnv?: string
|
|
7601
7762
|
}
|
|
7602
7763
|
|
|
7603
7764
|
/**
|
|
@@ -7889,6 +8050,43 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
|
|
|
7889
8050
|
FlowGroupName: string
|
|
7890
8051
|
}
|
|
7891
8052
|
|
|
8053
|
+
/**
|
|
8054
|
+
* 接口调用的员工信息
|
|
8055
|
+
*/
|
|
8056
|
+
export interface UserInfo {
|
|
8057
|
+
/**
|
|
8058
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
|
|
8059
|
+
|
|
8060
|
+
|
|
8061
|
+
注意:
|
|
8062
|
+
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
8063
|
+
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
8064
|
+
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
8065
|
+

|
|
8066
|
+
*/
|
|
8067
|
+
OpenId?: string
|
|
8068
|
+
/**
|
|
8069
|
+
* 内部参数,暂未开放使用
|
|
8070
|
+
* @deprecated
|
|
8071
|
+
*/
|
|
8072
|
+
Channel?: string
|
|
8073
|
+
/**
|
|
8074
|
+
* 内部参数,暂未开放使用
|
|
8075
|
+
* @deprecated
|
|
8076
|
+
*/
|
|
8077
|
+
CustomUserId?: string
|
|
8078
|
+
/**
|
|
8079
|
+
* 内部参数,暂未开放使用
|
|
8080
|
+
* @deprecated
|
|
8081
|
+
*/
|
|
8082
|
+
ClientIp?: string
|
|
8083
|
+
/**
|
|
8084
|
+
* 内部参数,暂未开放使用
|
|
8085
|
+
* @deprecated
|
|
8086
|
+
*/
|
|
8087
|
+
ProxyIp?: string
|
|
8088
|
+
}
|
|
8089
|
+
|
|
7892
8090
|
/**
|
|
7893
8091
|
* CreateBatchInitOrganizationUrl请求参数结构体
|
|
7894
8092
|
*/
|
|
@@ -8881,9 +9079,9 @@ export interface ChannelUpdateSealStatusResponse {
|
|
|
8881
9079
|
}
|
|
8882
9080
|
|
|
8883
9081
|
/**
|
|
8884
|
-
*
|
|
9082
|
+
* ChannelCreateFlowReminds请求参数结构体
|
|
8885
9083
|
*/
|
|
8886
|
-
export interface
|
|
9084
|
+
export interface ChannelCreateFlowRemindsRequest {
|
|
8887
9085
|
/**
|
|
8888
9086
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
8889
9087
|
|
|
@@ -8897,45 +9095,9 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
8897
9095
|
*/
|
|
8898
9096
|
Agent: Agent
|
|
8899
9097
|
/**
|
|
8900
|
-
*
|
|
8901
|
-
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
8902
|
-
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
8903
|
-
*/
|
|
8904
|
-
FlowId: string
|
|
8905
|
-
/**
|
|
8906
|
-
* 流程签署人列表,其中结构体的ApproverType必传。
|
|
8907
|
-
若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。
|
|
8908
|
-
若为子客企业签署方则需传OpenId、OrganizationOpenId,其他可不传。
|
|
8909
|
-
|
|
8910
|
-
注:
|
|
8911
|
-
`1. 签署人只能有手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件,其他类型的签署控件暂时未支持。`
|
|
8912
|
-
`2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
|
|
8913
|
-
*/
|
|
8914
|
-
FlowApproverInfos?: Array<FlowApproverInfo>
|
|
8915
|
-
/**
|
|
8916
|
-
* 用户信息,暂未开放
|
|
8917
|
-
* @deprecated
|
|
8918
|
-
*/
|
|
8919
|
-
Operator?: UserInfo
|
|
8920
|
-
/**
|
|
8921
|
-
* 机构信息,暂未开放
|
|
8922
|
-
* @deprecated
|
|
8923
|
-
*/
|
|
8924
|
-
Organization?: OrganizationInfo
|
|
8925
|
-
/**
|
|
8926
|
-
* 签署完之后的H5页面的跳转链接,最大长度1000个字符。链接类型请参考 <a href="https://qian.tencent.com/developers/company/openqianh5" target="_blank">跳转电子签H5</a>
|
|
8927
|
-
|
|
8928
|
-
*/
|
|
8929
|
-
JumpUrl?: string
|
|
8930
|
-
/**
|
|
8931
|
-
* 链接类型,支持指定以下类型
|
|
8932
|
-
<ul><li>0 : 签署链接 (默认值)</li>
|
|
8933
|
-
<li>1 : 预览链接</li></ul>
|
|
8934
|
-
注:
|
|
8935
|
-
`1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
|
|
8936
|
-
`2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
|
|
9098
|
+
* 需执行催办的合同流程ID数组,最多支持100个。
|
|
8937
9099
|
*/
|
|
8938
|
-
|
|
9100
|
+
FlowIds: Array<string>
|
|
8939
9101
|
}
|
|
8940
9102
|
|
|
8941
9103
|
/**
|