tencentcloud-sdk-nodejs-essbasic 4.0.724 → 4.0.726
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 +16 -16
- package/src/services/essbasic/v20210526/essbasic_client.ts +39 -17
- package/src/services/essbasic/v20210526/essbasic_models.ts +325 -128
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +30 -17
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +322 -128
- package/CHANGELOG.md +0 -154893
- package/SERVICE_CHANGELOG.md +0 -141228
|
@@ -7,6 +7,97 @@ export interface SyncProxyOrganizationResponse {
|
|
|
7
7
|
*/
|
|
8
8
|
RequestId?: string;
|
|
9
9
|
}
|
|
10
|
+
/**
|
|
11
|
+
* 用户计费使用情况详情
|
|
12
|
+
*/
|
|
13
|
+
export interface BillUsageDetail {
|
|
14
|
+
/**
|
|
15
|
+
* 合同流程ID,为32位字符串。
|
|
16
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
17
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
18
|
+
*/
|
|
19
|
+
FlowId?: string;
|
|
20
|
+
/**
|
|
21
|
+
* 合同经办人名称
|
|
22
|
+
如果有多个经办人用分号隔开。
|
|
23
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
24
|
+
*/
|
|
25
|
+
OperatorName?: string;
|
|
26
|
+
/**
|
|
27
|
+
* 发起方组织机构名称
|
|
28
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
29
|
+
*/
|
|
30
|
+
CreateOrganizationName?: string;
|
|
31
|
+
/**
|
|
32
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
33
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
34
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
35
|
+
*/
|
|
36
|
+
FlowName?: string;
|
|
37
|
+
/**
|
|
38
|
+
* 当前合同状态,如下是状态码对应的状态。
|
|
39
|
+
0-还没有发起
|
|
40
|
+
1-等待签署
|
|
41
|
+
2-部分签署
|
|
42
|
+
3-拒签
|
|
43
|
+
4-已签署
|
|
44
|
+
5-已过期
|
|
45
|
+
6-已撤销
|
|
46
|
+
7-还没有预发起
|
|
47
|
+
8-等待填写
|
|
48
|
+
9-部分填写
|
|
49
|
+
10-拒填
|
|
50
|
+
11-已解除
|
|
51
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
52
|
+
*/
|
|
53
|
+
Status?: number;
|
|
54
|
+
/**
|
|
55
|
+
* 套餐类型
|
|
56
|
+
对应关系如下
|
|
57
|
+
CloudEnterprise-企业版合同
|
|
58
|
+
SingleSignature-单方签章
|
|
59
|
+
CloudProve-签署报告
|
|
60
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
61
|
+
ChannelWeCard-微工卡
|
|
62
|
+
SignFlow-合同套餐
|
|
63
|
+
SignFace-签署意愿(人脸识别)
|
|
64
|
+
SignPassword-签署意愿(密码)
|
|
65
|
+
SignSMS-签署意愿(短信)
|
|
66
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
67
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
68
|
+
OrgEssAuth-签署企业实名
|
|
69
|
+
FlowNotify-短信通知
|
|
70
|
+
AuthService-企业工商信息查询
|
|
71
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
72
|
+
*/
|
|
73
|
+
QuotaType?: string;
|
|
74
|
+
/**
|
|
75
|
+
* 合同使用量
|
|
76
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
77
|
+
*/
|
|
78
|
+
UseCount?: number;
|
|
79
|
+
/**
|
|
80
|
+
* 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
81
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
82
|
+
*/
|
|
83
|
+
CostTime?: number;
|
|
84
|
+
/**
|
|
85
|
+
* 消耗的套餐名称
|
|
86
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
87
|
+
*/
|
|
88
|
+
QuotaName?: string;
|
|
89
|
+
/**
|
|
90
|
+
* 消耗类型
|
|
91
|
+
1.扣费 2.撤销返还
|
|
92
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
93
|
+
*/
|
|
94
|
+
CostType?: number;
|
|
95
|
+
/**
|
|
96
|
+
* 备注
|
|
97
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
98
|
+
*/
|
|
99
|
+
Remark?: string;
|
|
100
|
+
}
|
|
10
101
|
/**
|
|
11
102
|
* ChannelCreateConvertTaskApi返回参数结构体
|
|
12
103
|
*/
|
|
@@ -923,7 +1014,7 @@ export interface ReleasedApprover {
|
|
|
923
1014
|
ApproverNumber: number;
|
|
924
1015
|
/**
|
|
925
1016
|
* 指定签署人类型,目前支持
|
|
926
|
-
<ul><li> **ORGANIZATION
|
|
1017
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
927
1018
|
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
928
1019
|
*/
|
|
929
1020
|
ApproverType: string;
|
|
@@ -933,15 +1024,15 @@ export interface ReleasedApprover {
|
|
|
933
1024
|
Name?: string;
|
|
934
1025
|
/**
|
|
935
1026
|
* 签署方经办人的证件类型,支持以下类型
|
|
936
|
-
<ul><li>ID_CARD : 居民身份证
|
|
1027
|
+
<ul><li>ID_CARD : 居民身份证(默认值)</li>
|
|
937
1028
|
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
938
1029
|
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
939
1030
|
*/
|
|
940
1031
|
IdCardType?: string;
|
|
941
1032
|
/**
|
|
942
1033
|
* 证件号码,应符合以下规则
|
|
943
|
-
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X
|
|
944
|
-
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2
|
|
1034
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1035
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
945
1036
|
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
946
1037
|
*/
|
|
947
1038
|
IdCardNumber?: string;
|
|
@@ -1095,7 +1186,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
1095
1186
|
ProxyLegalIdCardType?: string;
|
|
1096
1187
|
/**
|
|
1097
1188
|
* 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
|
|
1098
|
-
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1189
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
1099
1190
|
*/
|
|
1100
1191
|
ProxyLegalIdCardNumber?: string;
|
|
1101
1192
|
/**
|
|
@@ -1162,14 +1253,15 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
1162
1253
|
|
|
1163
1254
|
此接口下面信息必填。
|
|
1164
1255
|
<ul>
|
|
1165
|
-
<li>渠道应用标识: Agent.
|
|
1166
|
-
<li>第三方平台子客企业标识: Agent.
|
|
1167
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
1256
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1257
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1258
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1168
1259
|
</ul>
|
|
1260
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1169
1261
|
*/
|
|
1170
1262
|
Agent: Agent;
|
|
1171
1263
|
/**
|
|
1172
|
-
*
|
|
1264
|
+
* 需执行催办的合同流程ID数组,最多支持100个。
|
|
1173
1265
|
*/
|
|
1174
1266
|
FlowIds: Array<string>;
|
|
1175
1267
|
}
|
|
@@ -1478,11 +1570,16 @@ export interface UploadFilesResponse {
|
|
|
1478
1570
|
RequestId?: string;
|
|
1479
1571
|
}
|
|
1480
1572
|
/**
|
|
1481
|
-
*
|
|
1573
|
+
* 应用相关信息, 整体应用的层级图如下
|
|
1574
|
+
|
|
1575
|
+
注:
|
|
1576
|
+
1. `不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
|
|
1482
1577
|
*/
|
|
1483
1578
|
export interface Agent {
|
|
1484
1579
|
/**
|
|
1485
|
-
*
|
|
1580
|
+
* 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
|
|
1581
|
+
|
|
1582
|
+

|
|
1486
1583
|
*/
|
|
1487
1584
|
AppId: string;
|
|
1488
1585
|
/**
|
|
@@ -1494,7 +1591,7 @@ export interface Agent {
|
|
|
1494
1591
|
*/
|
|
1495
1592
|
ProxyOperator?: UserInfo;
|
|
1496
1593
|
/**
|
|
1497
|
-
*
|
|
1594
|
+
* **不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1498
1595
|
*/
|
|
1499
1596
|
ProxyAppId?: string;
|
|
1500
1597
|
/**
|
|
@@ -1508,7 +1605,9 @@ export interface Agent {
|
|
|
1508
1605
|
*/
|
|
1509
1606
|
export interface ChannelCreatePreparedPersonalEsignResponse {
|
|
1510
1607
|
/**
|
|
1511
|
-
*
|
|
1608
|
+
* 电子印章ID,为32位字符串。
|
|
1609
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
1610
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
1512
1611
|
*/
|
|
1513
1612
|
SealId?: string;
|
|
1514
1613
|
/**
|
|
@@ -1521,20 +1620,20 @@ export interface ChannelCreatePreparedPersonalEsignResponse {
|
|
|
1521
1620
|
*/
|
|
1522
1621
|
export interface FlowApproverDetail {
|
|
1523
1622
|
/**
|
|
1524
|
-
*
|
|
1623
|
+
* 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
|
|
1525
1624
|
*/
|
|
1526
1625
|
ReceiptId?: string;
|
|
1527
1626
|
/**
|
|
1528
|
-
*
|
|
1627
|
+
* 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
1529
1628
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1530
1629
|
*/
|
|
1531
1630
|
ProxyOrganizationOpenId?: string;
|
|
1532
1631
|
/**
|
|
1533
|
-
*
|
|
1632
|
+
* 第三方平台子客企业员工的唯一标识
|
|
1534
1633
|
*/
|
|
1535
1634
|
ProxyOperatorOpenId?: string;
|
|
1536
1635
|
/**
|
|
1537
|
-
*
|
|
1636
|
+
* 第三方平台子客企业名称,与企业营业执照中注册的名称一致。
|
|
1538
1637
|
*/
|
|
1539
1638
|
ProxyOrganizationName?: string;
|
|
1540
1639
|
/**
|
|
@@ -1542,34 +1641,34 @@ export interface FlowApproverDetail {
|
|
|
1542
1641
|
*/
|
|
1543
1642
|
Mobile?: string;
|
|
1544
1643
|
/**
|
|
1545
|
-
*
|
|
1644
|
+
* 签署顺序,如果是有序签署,签署顺序从小到大
|
|
1546
1645
|
*/
|
|
1547
1646
|
SignOrder?: number;
|
|
1548
1647
|
/**
|
|
1549
|
-
*
|
|
1648
|
+
* 签署方经办人的姓名。
|
|
1649
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1550
1650
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1551
1651
|
*/
|
|
1552
1652
|
ApproveName?: string;
|
|
1553
1653
|
/**
|
|
1554
1654
|
* 当前签署人的状态, 状态如下
|
|
1555
|
-
<
|
|
1556
|
-
<
|
|
1557
|
-
<
|
|
1558
|
-
<
|
|
1559
|
-
<
|
|
1560
|
-
<
|
|
1561
|
-
<
|
|
1562
|
-
<
|
|
1563
|
-
<
|
|
1564
|
-
<
|
|
1565
|
-
<
|
|
1566
|
-
<
|
|
1567
|
-
|
|
1655
|
+
<ul><li> **PENDING** :待签署</li>
|
|
1656
|
+
<li> **FILLPENDING** :待填写</li>
|
|
1657
|
+
<li> **FILLACCEPT** :填写完成</li>
|
|
1658
|
+
<li> **FILLREJECT** :拒绝填写</li>
|
|
1659
|
+
<li> **WAITPICKUP** :待领取</li>
|
|
1660
|
+
<li> **ACCEPT** :已签署</li>
|
|
1661
|
+
<li> **REJECT** :拒签</li>
|
|
1662
|
+
<li> **DEADLINE** :过期没人处理</li>
|
|
1663
|
+
<li> **CANCEL** :流程已撤回</li>
|
|
1664
|
+
<li> **FORWARD** :已经转他人处理</li>
|
|
1665
|
+
<li> **STOP** :流程已终止</li>
|
|
1666
|
+
<li> **RELIEVED** :解除协议(已解除)</li></ul>
|
|
1568
1667
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1569
1668
|
*/
|
|
1570
1669
|
ApproveStatus?: string;
|
|
1571
1670
|
/**
|
|
1572
|
-
*
|
|
1671
|
+
* 签署人拒签等情况的时候填写的原因
|
|
1573
1672
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1574
1673
|
*/
|
|
1575
1674
|
ApproveMessage?: string;
|
|
@@ -1579,13 +1678,13 @@ export interface FlowApproverDetail {
|
|
|
1579
1678
|
ApproveTime?: number;
|
|
1580
1679
|
/**
|
|
1581
1680
|
* 参与者类型
|
|
1582
|
-
<
|
|
1583
|
-
<
|
|
1681
|
+
<ul><li> **ORGANIZATION** :企业签署人</li>
|
|
1682
|
+
<li> **PERSON** :个人签署人</li></ul>
|
|
1584
1683
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1585
1684
|
*/
|
|
1586
1685
|
ApproveType?: string;
|
|
1587
1686
|
/**
|
|
1588
|
-
*
|
|
1687
|
+
* 自定义签署人的角色名, 如: 收款人、开具人、见证人等
|
|
1589
1688
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1590
1689
|
*/
|
|
1591
1690
|
ApproverRoleName?: string;
|
|
@@ -2215,6 +2314,101 @@ export interface Permission {
|
|
|
2215
2314
|
*/
|
|
2216
2315
|
Children?: Array<Permission>;
|
|
2217
2316
|
}
|
|
2317
|
+
/**
|
|
2318
|
+
* DescribeTemplates请求参数结构体
|
|
2319
|
+
*/
|
|
2320
|
+
export interface DescribeTemplatesRequest {
|
|
2321
|
+
/**
|
|
2322
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2323
|
+
|
|
2324
|
+
此接口下面信息必填。
|
|
2325
|
+
<ul>
|
|
2326
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2327
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2328
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2329
|
+
</ul>
|
|
2330
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2331
|
+
*/
|
|
2332
|
+
Agent: Agent;
|
|
2333
|
+
/**
|
|
2334
|
+
* 合同模板ID,为32位字符串。
|
|
2335
|
+
|
|
2336
|
+
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
2337
|
+
*/
|
|
2338
|
+
TemplateId?: string;
|
|
2339
|
+
/**
|
|
2340
|
+
* 查询模版的内容
|
|
2341
|
+
|
|
2342
|
+
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
2343
|
+
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
2344
|
+
*/
|
|
2345
|
+
ContentType?: number;
|
|
2346
|
+
/**
|
|
2347
|
+
* 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
|
|
2348
|
+
|
|
2349
|
+
注意:
|
|
2350
|
+
1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
|
2351
|
+
2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
|
2352
|
+
4. `若传递此参数,分页参数(Limit,Offset)无效`
|
|
2353
|
+
|
|
2354
|
+
*/
|
|
2355
|
+
TemplateIds?: Array<string>;
|
|
2356
|
+
/**
|
|
2357
|
+
* 指定每页返回的数据条数,和Offset参数配合使用。
|
|
2358
|
+
|
|
2359
|
+
注:`1.默认值为20,单页做大值为200。`
|
|
2360
|
+
*/
|
|
2361
|
+
Limit?: number;
|
|
2362
|
+
/**
|
|
2363
|
+
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
2364
|
+
|
|
2365
|
+
注:`1.offset从0开始,即第一页为0。`
|
|
2366
|
+
`2.默认从第一页返回。`
|
|
2367
|
+
*/
|
|
2368
|
+
Offset?: number;
|
|
2369
|
+
/**
|
|
2370
|
+
* 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
|
|
2371
|
+
*/
|
|
2372
|
+
TemplateName?: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
|
2375
|
+
*/
|
|
2376
|
+
ChannelTemplateId?: string;
|
|
2377
|
+
/**
|
|
2378
|
+
* 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
2379
|
+
|
|
2380
|
+
<ul><li>**false**:(默认)只返回发起方控件</li>
|
|
2381
|
+
<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
2382
|
+
*/
|
|
2383
|
+
QueryAllComponents?: boolean;
|
|
2384
|
+
/**
|
|
2385
|
+
* 是否获取模板预览链接。
|
|
2386
|
+
|
|
2387
|
+
<ul><li>**false**:不获取(默认)</li>
|
|
2388
|
+
<li>**true**:获取</li></ul>
|
|
2389
|
+
|
|
2390
|
+
设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
|
2391
|
+
|
|
2392
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
2393
|
+
*/
|
|
2394
|
+
WithPreviewUrl?: boolean;
|
|
2395
|
+
/**
|
|
2396
|
+
* 是否获取模板的PDF文件链接。
|
|
2397
|
+
|
|
2398
|
+
<ul><li>**false**:不获取(默认)</li>
|
|
2399
|
+
<li>**true**:获取</li></ul>
|
|
2400
|
+
|
|
2401
|
+
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
2402
|
+
|
|
2403
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
2404
|
+
*/
|
|
2405
|
+
WithPdfUrl?: boolean;
|
|
2406
|
+
/**
|
|
2407
|
+
* 操作者的信息
|
|
2408
|
+
* @deprecated
|
|
2409
|
+
*/
|
|
2410
|
+
Operator?: UserInfo;
|
|
2411
|
+
}
|
|
2218
2412
|
/**
|
|
2219
2413
|
* 企业员工信息
|
|
2220
2414
|
*/
|
|
@@ -3363,11 +3557,18 @@ export interface FlowInfo {
|
|
|
3363
3557
|
AutoSignScene?: string;
|
|
3364
3558
|
}
|
|
3365
3559
|
/**
|
|
3366
|
-
*
|
|
3560
|
+
* 接口调用的员工信息
|
|
3367
3561
|
*/
|
|
3368
3562
|
export interface UserInfo {
|
|
3369
3563
|
/**
|
|
3370
|
-
*
|
|
3564
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
|
|
3565
|
+
|
|
3566
|
+
|
|
3567
|
+
注意:
|
|
3568
|
+
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
3569
|
+
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
3570
|
+
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
3571
|
+

|
|
3371
3572
|
*/
|
|
3372
3573
|
OpenId?: string;
|
|
3373
3574
|
/**
|
|
@@ -3658,6 +3859,23 @@ export interface ChannelCreateFlowApproversResponse {
|
|
|
3658
3859
|
*/
|
|
3659
3860
|
RequestId?: string;
|
|
3660
3861
|
}
|
|
3862
|
+
/**
|
|
3863
|
+
* DescribeBillUsageDetail返回参数结构体
|
|
3864
|
+
*/
|
|
3865
|
+
export interface DescribeBillUsageDetailResponse {
|
|
3866
|
+
/**
|
|
3867
|
+
* 返回查询记录总数
|
|
3868
|
+
*/
|
|
3869
|
+
Total?: number;
|
|
3870
|
+
/**
|
|
3871
|
+
* 消耗记录详情
|
|
3872
|
+
*/
|
|
3873
|
+
Details?: Array<BillUsageDetail>;
|
|
3874
|
+
/**
|
|
3875
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3876
|
+
*/
|
|
3877
|
+
RequestId?: string;
|
|
3878
|
+
}
|
|
3661
3879
|
/**
|
|
3662
3880
|
* CreateSignUrls请求参数结构体
|
|
3663
3881
|
*/
|
|
@@ -4161,7 +4379,7 @@ export interface FillError {
|
|
|
4161
4379
|
*/
|
|
4162
4380
|
export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
4163
4381
|
/**
|
|
4164
|
-
*
|
|
4382
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4165
4383
|
*/
|
|
4166
4384
|
Agent: Agent;
|
|
4167
4385
|
/**
|
|
@@ -4169,23 +4387,36 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4169
4387
|
*/
|
|
4170
4388
|
UserName: string;
|
|
4171
4389
|
/**
|
|
4172
|
-
*
|
|
4390
|
+
* 证件号码, 应符合以下规则
|
|
4391
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
4392
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
4393
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
4173
4394
|
*/
|
|
4174
4395
|
IdCardNumber: string;
|
|
4175
4396
|
/**
|
|
4176
|
-
*
|
|
4397
|
+
* 电子印章名字,1-50个中文字符
|
|
4398
|
+
注:`同一企业下电子印章名字不能相同`
|
|
4177
4399
|
*/
|
|
4178
4400
|
SealName: string;
|
|
4179
4401
|
/**
|
|
4180
|
-
*
|
|
4402
|
+
* 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。
|
|
4403
|
+
|
|
4404
|
+
|
|
4181
4405
|
*/
|
|
4182
4406
|
SealImage: string;
|
|
4183
4407
|
/**
|
|
4184
|
-
*
|
|
4408
|
+
* 执行本接口操作的员工信息。
|
|
4409
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4185
4410
|
*/
|
|
4186
4411
|
Operator?: UserInfo;
|
|
4187
4412
|
/**
|
|
4188
|
-
*
|
|
4413
|
+
* 证件类型,支持以下类型
|
|
4414
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
4415
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
4416
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
4417
|
+
<li>OTHER_CARD_TYPE : 其他</li></ul>
|
|
4418
|
+
|
|
4419
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
4189
4420
|
*/
|
|
4190
4421
|
IdCardType?: string;
|
|
4191
4422
|
/**
|
|
@@ -4804,13 +5035,13 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
4804
5035
|
*/
|
|
4805
5036
|
ReliveInfo: RelieveInfo;
|
|
4806
5037
|
/**
|
|
4807
|
-
*
|
|
4808
|
-
|
|
5038
|
+
* 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
|
|
5039
|
+
如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
|
|
4809
5040
|
|
|
4810
5041
|
注意:
|
|
4811
5042
|
<ul>
|
|
4812
|
-
<li
|
|
4813
|
-
<li
|
|
5043
|
+
<li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
|
|
5044
|
+
<li>可以不指定替换签署人,使用原流程的签署人</li>
|
|
4814
5045
|
</ul>
|
|
4815
5046
|
*/
|
|
4816
5047
|
ReleasedApprovers?: Array<ReleasedApprover>;
|
|
@@ -5441,99 +5672,48 @@ export interface ChannelCancelFlowRequest {
|
|
|
5441
5672
|
Operator?: UserInfo;
|
|
5442
5673
|
}
|
|
5443
5674
|
/**
|
|
5444
|
-
*
|
|
5675
|
+
* DescribeBillUsageDetail请求参数结构体
|
|
5445
5676
|
*/
|
|
5446
|
-
export interface
|
|
5677
|
+
export interface DescribeBillUsageDetailRequest {
|
|
5447
5678
|
/**
|
|
5448
5679
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5449
|
-
|
|
5450
|
-
此接口下面信息必填。
|
|
5451
|
-
<ul>
|
|
5452
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
5453
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5454
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5455
|
-
</ul>
|
|
5456
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
5457
5680
|
*/
|
|
5458
5681
|
Agent: Agent;
|
|
5459
5682
|
/**
|
|
5460
|
-
*
|
|
5461
|
-
|
|
5462
|
-
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
5463
|
-
*/
|
|
5464
|
-
TemplateId?: string;
|
|
5465
|
-
/**
|
|
5466
|
-
* 查询模版的内容
|
|
5467
|
-
|
|
5468
|
-
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
5469
|
-
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
5683
|
+
* 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
5470
5684
|
*/
|
|
5471
|
-
|
|
5685
|
+
StartTime: string;
|
|
5472
5686
|
/**
|
|
5473
|
-
*
|
|
5474
|
-
|
|
5475
|
-
注意:
|
|
5476
|
-
1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
|
5477
|
-
2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
|
5478
|
-
4. `若传递此参数,分页参数(Limit,Offset)无效`
|
|
5479
|
-
|
|
5687
|
+
* 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
5480
5688
|
*/
|
|
5481
|
-
|
|
5689
|
+
EndTime: string;
|
|
5482
5690
|
/**
|
|
5483
|
-
*
|
|
5484
|
-
|
|
5485
|
-
|
|
5691
|
+
* 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
5692
|
+
对应关系如下
|
|
5693
|
+
CloudEnterprise-企业版合同
|
|
5694
|
+
SingleSignature-单方签章
|
|
5695
|
+
CloudProve-签署报告
|
|
5696
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
5697
|
+
ChannelWeCard-微工卡
|
|
5698
|
+
SignFlow-合同套餐
|
|
5699
|
+
SignFace-签署意愿(人脸识别)
|
|
5700
|
+
SignPassword-签署意愿(密码)
|
|
5701
|
+
SignSMS-签署意愿(短信)
|
|
5702
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
5703
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
5704
|
+
OrgEssAuth-签署企业实名
|
|
5705
|
+
FlowNotify-短信通知
|
|
5706
|
+
AuthService-企业工商信息查询
|
|
5486
5707
|
*/
|
|
5487
|
-
|
|
5708
|
+
QuotaType?: string;
|
|
5488
5709
|
/**
|
|
5489
|
-
*
|
|
5490
|
-
|
|
5491
|
-
注:`1.offset从0开始,即第一页为0。`
|
|
5492
|
-
`2.默认从第一页返回。`
|
|
5710
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
5493
5711
|
*/
|
|
5494
5712
|
Offset?: number;
|
|
5495
5713
|
/**
|
|
5496
|
-
*
|
|
5714
|
+
* 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
5497
5715
|
*/
|
|
5498
|
-
|
|
5499
|
-
/**
|
|
5500
|
-
* 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
|
5501
|
-
*/
|
|
5502
|
-
ChannelTemplateId?: string;
|
|
5503
|
-
/**
|
|
5504
|
-
* 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
5505
|
-
|
|
5506
|
-
<ul><li>**false**:(默认)只返回发起方控件</li>
|
|
5507
|
-
<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
5508
|
-
*/
|
|
5509
|
-
QueryAllComponents?: boolean;
|
|
5510
|
-
/**
|
|
5511
|
-
* 是否获取模板预览链接。
|
|
5512
|
-
|
|
5513
|
-
<ul><li>**false**:不获取(默认)</li>
|
|
5514
|
-
<li>**true**:获取</li></ul>
|
|
5515
|
-
|
|
5516
|
-
设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
|
5517
|
-
|
|
5518
|
-
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5519
|
-
*/
|
|
5520
|
-
WithPreviewUrl?: boolean;
|
|
5521
|
-
/**
|
|
5522
|
-
* 是否获取模板的PDF文件链接。
|
|
5523
|
-
|
|
5524
|
-
<ul><li>**false**:不获取(默认)</li>
|
|
5525
|
-
<li>**true**:获取</li></ul>
|
|
5526
|
-
|
|
5527
|
-
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
5528
|
-
|
|
5529
|
-
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5530
|
-
*/
|
|
5531
|
-
WithPdfUrl?: boolean;
|
|
5532
|
-
/**
|
|
5533
|
-
* 操作者的信息
|
|
5534
|
-
* @deprecated
|
|
5535
|
-
*/
|
|
5536
|
-
Operator?: UserInfo;
|
|
5716
|
+
Limit?: number;
|
|
5537
5717
|
}
|
|
5538
5718
|
/**
|
|
5539
5719
|
* 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
|
|
@@ -5565,15 +5745,29 @@ export interface RelieveInfo {
|
|
|
5565
5745
|
*/
|
|
5566
5746
|
export interface ChannelCreateSealPolicyRequest {
|
|
5567
5747
|
/**
|
|
5568
|
-
*
|
|
5748
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5749
|
+
|
|
5750
|
+
此接口下面信息必填。
|
|
5751
|
+
|
|
5752
|
+
渠道应用标识: Agent.AppId
|
|
5753
|
+
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
|
|
5754
|
+
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
|
|
5755
|
+
第三方平台子客企业和员工必须已经经过实名认证。
|
|
5569
5756
|
*/
|
|
5570
5757
|
Agent: Agent;
|
|
5571
5758
|
/**
|
|
5572
|
-
*
|
|
5759
|
+
* 电子印章ID,为32位字符串。
|
|
5760
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
5761
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
5573
5762
|
*/
|
|
5574
5763
|
SealId: string;
|
|
5575
5764
|
/**
|
|
5576
|
-
*
|
|
5765
|
+
*
|
|
5766
|
+
员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
|
5767
|
+
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
5768
|
+
员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
|
|
5769
|
+
该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
|
|
5770
|
+
指定待授权的用户ID数组,电子签的用户ID
|
|
5577
5771
|
可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
|
|
5578
5772
|
*/
|
|
5579
5773
|
UserIds: Array<string>;
|