tencentcloud-sdk-nodejs-essbasic 4.0.723 → 4.0.725
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/CHANGELOG.md +340 -0
- package/SERVICE_CHANGELOG.md +455 -44
- package/package.json +1 -1
- package/products.md +25 -25
- package/src/services/essbasic/v20210526/essbasic_client.ts +59 -24
- package/src/services/essbasic/v20210526/essbasic_models.ts +354 -139
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +50 -24
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +51 -23
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +351 -139
|
@@ -25,6 +25,98 @@ export interface SyncProxyOrganizationResponse {
|
|
|
25
25
|
RequestId?: string
|
|
26
26
|
}
|
|
27
27
|
|
|
28
|
+
/**
|
|
29
|
+
* 用户计费使用情况详情
|
|
30
|
+
*/
|
|
31
|
+
export interface BillUsageDetail {
|
|
32
|
+
/**
|
|
33
|
+
* 合同流程ID,为32位字符串。
|
|
34
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
35
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
36
|
+
*/
|
|
37
|
+
FlowId?: string
|
|
38
|
+
/**
|
|
39
|
+
* 合同经办人名称
|
|
40
|
+
如果有多个经办人用分号隔开。
|
|
41
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
42
|
+
*/
|
|
43
|
+
OperatorName?: string
|
|
44
|
+
/**
|
|
45
|
+
* 发起方组织机构名称
|
|
46
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
47
|
+
*/
|
|
48
|
+
CreateOrganizationName?: string
|
|
49
|
+
/**
|
|
50
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
51
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
52
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
53
|
+
*/
|
|
54
|
+
FlowName?: string
|
|
55
|
+
/**
|
|
56
|
+
* 当前合同状态,如下是状态码对应的状态。
|
|
57
|
+
0-还没有发起
|
|
58
|
+
1-等待签署
|
|
59
|
+
2-部分签署
|
|
60
|
+
3-拒签
|
|
61
|
+
4-已签署
|
|
62
|
+
5-已过期
|
|
63
|
+
6-已撤销
|
|
64
|
+
7-还没有预发起
|
|
65
|
+
8-等待填写
|
|
66
|
+
9-部分填写
|
|
67
|
+
10-拒填
|
|
68
|
+
11-已解除
|
|
69
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
70
|
+
*/
|
|
71
|
+
Status?: number
|
|
72
|
+
/**
|
|
73
|
+
* 套餐类型
|
|
74
|
+
对应关系如下
|
|
75
|
+
CloudEnterprise-企业版合同
|
|
76
|
+
SingleSignature-单方签章
|
|
77
|
+
CloudProve-签署报告
|
|
78
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
79
|
+
ChannelWeCard-微工卡
|
|
80
|
+
SignFlow-合同套餐
|
|
81
|
+
SignFace-签署意愿(人脸识别)
|
|
82
|
+
SignPassword-签署意愿(密码)
|
|
83
|
+
SignSMS-签署意愿(短信)
|
|
84
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
85
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
86
|
+
OrgEssAuth-签署企业实名
|
|
87
|
+
FlowNotify-短信通知
|
|
88
|
+
AuthService-企业工商信息查询
|
|
89
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
90
|
+
*/
|
|
91
|
+
QuotaType?: string
|
|
92
|
+
/**
|
|
93
|
+
* 合同使用量
|
|
94
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
95
|
+
*/
|
|
96
|
+
UseCount?: number
|
|
97
|
+
/**
|
|
98
|
+
* 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
99
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
100
|
+
*/
|
|
101
|
+
CostTime?: number
|
|
102
|
+
/**
|
|
103
|
+
* 消耗的套餐名称
|
|
104
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
105
|
+
*/
|
|
106
|
+
QuotaName?: string
|
|
107
|
+
/**
|
|
108
|
+
* 消耗类型
|
|
109
|
+
1.扣费 2.撤销返还
|
|
110
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
111
|
+
*/
|
|
112
|
+
CostType?: number
|
|
113
|
+
/**
|
|
114
|
+
* 备注
|
|
115
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
116
|
+
*/
|
|
117
|
+
Remark?: string
|
|
118
|
+
}
|
|
119
|
+
|
|
28
120
|
/**
|
|
29
121
|
* ChannelCreateConvertTaskApi返回参数结构体
|
|
30
122
|
*/
|
|
@@ -967,7 +1059,7 @@ export interface ReleasedApprover {
|
|
|
967
1059
|
ApproverNumber: number
|
|
968
1060
|
/**
|
|
969
1061
|
* 指定签署人类型,目前支持
|
|
970
|
-
<ul><li> **ORGANIZATION
|
|
1062
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
971
1063
|
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
972
1064
|
*/
|
|
973
1065
|
ApproverType: string
|
|
@@ -977,15 +1069,15 @@ export interface ReleasedApprover {
|
|
|
977
1069
|
Name?: string
|
|
978
1070
|
/**
|
|
979
1071
|
* 签署方经办人的证件类型,支持以下类型
|
|
980
|
-
<ul><li>ID_CARD : 居民身份证
|
|
1072
|
+
<ul><li>ID_CARD : 居民身份证(默认值)</li>
|
|
981
1073
|
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
982
1074
|
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
983
1075
|
*/
|
|
984
1076
|
IdCardType?: string
|
|
985
1077
|
/**
|
|
986
1078
|
* 证件号码,应符合以下规则
|
|
987
|
-
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X
|
|
988
|
-
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2
|
|
1079
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
1080
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
989
1081
|
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
990
1082
|
*/
|
|
991
1083
|
IdCardNumber?: string
|
|
@@ -1103,12 +1195,19 @@ export interface ChannelCreateUserRolesResponse {
|
|
|
1103
1195
|
*/
|
|
1104
1196
|
export interface SyncProxyOrganizationRequest {
|
|
1105
1197
|
/**
|
|
1106
|
-
*
|
|
1107
|
-
|
|
1198
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1199
|
+
|
|
1200
|
+
此接口下面信息必填。
|
|
1201
|
+
<ul>
|
|
1202
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1203
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1204
|
+
</ul>
|
|
1205
|
+
|
|
1108
1206
|
*/
|
|
1109
1207
|
Agent: Agent
|
|
1110
1208
|
/**
|
|
1111
|
-
*
|
|
1209
|
+
* 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
|
|
1210
|
+
注: `如果名称中包含英文括号(),请使用中文括号()代替。`
|
|
1112
1211
|
*/
|
|
1113
1212
|
ProxyOrganizationName: string
|
|
1114
1213
|
/**
|
|
@@ -1120,7 +1219,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
1120
1219
|
*/
|
|
1121
1220
|
UniformSocialCreditCode?: string
|
|
1122
1221
|
/**
|
|
1123
|
-
*
|
|
1222
|
+
* 第三方平台子客企业法定代表人的名字
|
|
1124
1223
|
*/
|
|
1125
1224
|
ProxyLegalName?: string
|
|
1126
1225
|
/**
|
|
@@ -1129,13 +1228,22 @@ export interface SyncProxyOrganizationRequest {
|
|
|
1129
1228
|
*/
|
|
1130
1229
|
Operator?: UserInfo
|
|
1131
1230
|
/**
|
|
1132
|
-
*
|
|
1231
|
+
* 第三方平台子客企业法定代表人的证件类型,支持以下类型
|
|
1232
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
|
|
1233
|
+
注: `现在仅支持ID_CARD居民身份证类型`
|
|
1133
1234
|
*/
|
|
1134
1235
|
ProxyLegalIdCardType?: string
|
|
1135
1236
|
/**
|
|
1136
|
-
*
|
|
1237
|
+
* 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
|
|
1238
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li></ul>
|
|
1137
1239
|
*/
|
|
1138
1240
|
ProxyLegalIdCardNumber?: string
|
|
1241
|
+
/**
|
|
1242
|
+
* 第三方平台子客企业详细住所,最大长度500个字符
|
|
1243
|
+
|
|
1244
|
+
注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
|
|
1245
|
+
*/
|
|
1246
|
+
ProxyAddress?: string
|
|
1139
1247
|
}
|
|
1140
1248
|
|
|
1141
1249
|
/**
|
|
@@ -1196,14 +1304,15 @@ export interface ChannelCreateFlowRemindsRequest {
|
|
|
1196
1304
|
|
|
1197
1305
|
此接口下面信息必填。
|
|
1198
1306
|
<ul>
|
|
1199
|
-
<li>渠道应用标识: Agent.
|
|
1200
|
-
<li>第三方平台子客企业标识: Agent.
|
|
1201
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
1307
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1308
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1309
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1202
1310
|
</ul>
|
|
1311
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1203
1312
|
*/
|
|
1204
1313
|
Agent: Agent
|
|
1205
1314
|
/**
|
|
1206
|
-
*
|
|
1315
|
+
* 需执行催办的合同流程ID数组,最多支持100个。
|
|
1207
1316
|
*/
|
|
1208
1317
|
FlowIds: Array<string>
|
|
1209
1318
|
}
|
|
@@ -1521,11 +1630,16 @@ export interface UploadFilesResponse {
|
|
|
1521
1630
|
}
|
|
1522
1631
|
|
|
1523
1632
|
/**
|
|
1524
|
-
*
|
|
1633
|
+
* 应用相关信息, 整体应用的层级图如下
|
|
1634
|
+
|
|
1635
|
+
注:
|
|
1636
|
+
1. `不同的业务系统可以采用不同的应用,不同应用下的数据是隔离的, 应用A中的某个企业已经实名, 在应用B中此企业还需要重新认证`
|
|
1525
1637
|
*/
|
|
1526
1638
|
export interface Agent {
|
|
1527
1639
|
/**
|
|
1528
|
-
*
|
|
1640
|
+
* 应用的唯一标识(由电子签平台自动生成)。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。位置如下:
|
|
1641
|
+
|
|
1642
|
+

|
|
1529
1643
|
*/
|
|
1530
1644
|
AppId: string
|
|
1531
1645
|
/**
|
|
@@ -1537,7 +1651,7 @@ export interface Agent {
|
|
|
1537
1651
|
*/
|
|
1538
1652
|
ProxyOperator?: UserInfo
|
|
1539
1653
|
/**
|
|
1540
|
-
*
|
|
1654
|
+
* **不用填写**,在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1541
1655
|
*/
|
|
1542
1656
|
ProxyAppId?: string
|
|
1543
1657
|
/**
|
|
@@ -1552,7 +1666,9 @@ export interface Agent {
|
|
|
1552
1666
|
*/
|
|
1553
1667
|
export interface ChannelCreatePreparedPersonalEsignResponse {
|
|
1554
1668
|
/**
|
|
1555
|
-
*
|
|
1669
|
+
* 电子印章ID,为32位字符串。
|
|
1670
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
1671
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
1556
1672
|
*/
|
|
1557
1673
|
SealId?: string
|
|
1558
1674
|
/**
|
|
@@ -1566,20 +1682,20 @@ export interface ChannelCreatePreparedPersonalEsignResponse {
|
|
|
1566
1682
|
*/
|
|
1567
1683
|
export interface FlowApproverDetail {
|
|
1568
1684
|
/**
|
|
1569
|
-
*
|
|
1685
|
+
* 模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色
|
|
1570
1686
|
*/
|
|
1571
1687
|
ReceiptId?: string
|
|
1572
1688
|
/**
|
|
1573
|
-
*
|
|
1689
|
+
* 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
1574
1690
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1575
1691
|
*/
|
|
1576
1692
|
ProxyOrganizationOpenId?: string
|
|
1577
1693
|
/**
|
|
1578
|
-
*
|
|
1694
|
+
* 第三方平台子客企业员工的唯一标识
|
|
1579
1695
|
*/
|
|
1580
1696
|
ProxyOperatorOpenId?: string
|
|
1581
1697
|
/**
|
|
1582
|
-
*
|
|
1698
|
+
* 第三方平台子客企业名称,与企业营业执照中注册的名称一致。
|
|
1583
1699
|
*/
|
|
1584
1700
|
ProxyOrganizationName?: string
|
|
1585
1701
|
/**
|
|
@@ -1587,34 +1703,34 @@ export interface FlowApproverDetail {
|
|
|
1587
1703
|
*/
|
|
1588
1704
|
Mobile?: string
|
|
1589
1705
|
/**
|
|
1590
|
-
*
|
|
1706
|
+
* 签署顺序,如果是有序签署,签署顺序从小到大
|
|
1591
1707
|
*/
|
|
1592
1708
|
SignOrder?: number
|
|
1593
1709
|
/**
|
|
1594
|
-
*
|
|
1710
|
+
* 签署方经办人的姓名。
|
|
1711
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
1595
1712
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1596
1713
|
*/
|
|
1597
1714
|
ApproveName?: string
|
|
1598
1715
|
/**
|
|
1599
1716
|
* 当前签署人的状态, 状态如下
|
|
1600
|
-
<
|
|
1601
|
-
<
|
|
1602
|
-
<
|
|
1603
|
-
<
|
|
1604
|
-
<
|
|
1605
|
-
<
|
|
1606
|
-
<
|
|
1607
|
-
<
|
|
1608
|
-
<
|
|
1609
|
-
<
|
|
1610
|
-
<
|
|
1611
|
-
<
|
|
1612
|
-
|
|
1717
|
+
<ul><li> **PENDING** :待签署</li>
|
|
1718
|
+
<li> **FILLPENDING** :待填写</li>
|
|
1719
|
+
<li> **FILLACCEPT** :填写完成</li>
|
|
1720
|
+
<li> **FILLREJECT** :拒绝填写</li>
|
|
1721
|
+
<li> **WAITPICKUP** :待领取</li>
|
|
1722
|
+
<li> **ACCEPT** :已签署</li>
|
|
1723
|
+
<li> **REJECT** :拒签</li>
|
|
1724
|
+
<li> **DEADLINE** :过期没人处理</li>
|
|
1725
|
+
<li> **CANCEL** :流程已撤回</li>
|
|
1726
|
+
<li> **FORWARD** :已经转他人处理</li>
|
|
1727
|
+
<li> **STOP** :流程已终止</li>
|
|
1728
|
+
<li> **RELIEVED** :解除协议(已解除)</li></ul>
|
|
1613
1729
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1614
1730
|
*/
|
|
1615
1731
|
ApproveStatus?: string
|
|
1616
1732
|
/**
|
|
1617
|
-
*
|
|
1733
|
+
* 签署人拒签等情况的时候填写的原因
|
|
1618
1734
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1619
1735
|
*/
|
|
1620
1736
|
ApproveMessage?: string
|
|
@@ -1624,13 +1740,13 @@ export interface FlowApproverDetail {
|
|
|
1624
1740
|
ApproveTime?: number
|
|
1625
1741
|
/**
|
|
1626
1742
|
* 参与者类型
|
|
1627
|
-
<
|
|
1628
|
-
<
|
|
1743
|
+
<ul><li> **ORGANIZATION** :企业签署人</li>
|
|
1744
|
+
<li> **PERSON** :个人签署人</li></ul>
|
|
1629
1745
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1630
1746
|
*/
|
|
1631
1747
|
ApproveType?: string
|
|
1632
1748
|
/**
|
|
1633
|
-
*
|
|
1749
|
+
* 自定义签署人的角色名, 如: 收款人、开具人、见证人等
|
|
1634
1750
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1635
1751
|
*/
|
|
1636
1752
|
ApproverRoleName?: string
|
|
@@ -2281,6 +2397,102 @@ export interface Permission {
|
|
|
2281
2397
|
Children?: Array<Permission>
|
|
2282
2398
|
}
|
|
2283
2399
|
|
|
2400
|
+
/**
|
|
2401
|
+
* DescribeTemplates请求参数结构体
|
|
2402
|
+
*/
|
|
2403
|
+
export interface DescribeTemplatesRequest {
|
|
2404
|
+
/**
|
|
2405
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2406
|
+
|
|
2407
|
+
此接口下面信息必填。
|
|
2408
|
+
<ul>
|
|
2409
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2410
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2411
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2412
|
+
</ul>
|
|
2413
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2414
|
+
*/
|
|
2415
|
+
Agent: Agent
|
|
2416
|
+
/**
|
|
2417
|
+
* 合同模板ID,为32位字符串。
|
|
2418
|
+
|
|
2419
|
+
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
2420
|
+
*/
|
|
2421
|
+
TemplateId?: string
|
|
2422
|
+
/**
|
|
2423
|
+
* 查询模版的内容
|
|
2424
|
+
|
|
2425
|
+
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
2426
|
+
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
2427
|
+
*/
|
|
2428
|
+
ContentType?: number
|
|
2429
|
+
/**
|
|
2430
|
+
* 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
|
|
2431
|
+
|
|
2432
|
+
注意:
|
|
2433
|
+
1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
|
2434
|
+
2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
|
2435
|
+
4. `若传递此参数,分页参数(Limit,Offset)无效`
|
|
2436
|
+
|
|
2437
|
+
*/
|
|
2438
|
+
TemplateIds?: Array<string>
|
|
2439
|
+
/**
|
|
2440
|
+
* 指定每页返回的数据条数,和Offset参数配合使用。
|
|
2441
|
+
|
|
2442
|
+
注:`1.默认值为20,单页做大值为200。`
|
|
2443
|
+
*/
|
|
2444
|
+
Limit?: number
|
|
2445
|
+
/**
|
|
2446
|
+
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
2447
|
+
|
|
2448
|
+
注:`1.offset从0开始,即第一页为0。`
|
|
2449
|
+
`2.默认从第一页返回。`
|
|
2450
|
+
*/
|
|
2451
|
+
Offset?: number
|
|
2452
|
+
/**
|
|
2453
|
+
* 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
|
|
2454
|
+
*/
|
|
2455
|
+
TemplateName?: string
|
|
2456
|
+
/**
|
|
2457
|
+
* 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
|
2458
|
+
*/
|
|
2459
|
+
ChannelTemplateId?: string
|
|
2460
|
+
/**
|
|
2461
|
+
* 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
2462
|
+
|
|
2463
|
+
<ul><li>**false**:(默认)只返回发起方控件</li>
|
|
2464
|
+
<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
2465
|
+
*/
|
|
2466
|
+
QueryAllComponents?: boolean
|
|
2467
|
+
/**
|
|
2468
|
+
* 是否获取模板预览链接。
|
|
2469
|
+
|
|
2470
|
+
<ul><li>**false**:不获取(默认)</li>
|
|
2471
|
+
<li>**true**:获取</li></ul>
|
|
2472
|
+
|
|
2473
|
+
设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
|
2474
|
+
|
|
2475
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
2476
|
+
*/
|
|
2477
|
+
WithPreviewUrl?: boolean
|
|
2478
|
+
/**
|
|
2479
|
+
* 是否获取模板的PDF文件链接。
|
|
2480
|
+
|
|
2481
|
+
<ul><li>**false**:不获取(默认)</li>
|
|
2482
|
+
<li>**true**:获取</li></ul>
|
|
2483
|
+
|
|
2484
|
+
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
2485
|
+
|
|
2486
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
2487
|
+
*/
|
|
2488
|
+
WithPdfUrl?: boolean
|
|
2489
|
+
/**
|
|
2490
|
+
* 操作者的信息
|
|
2491
|
+
* @deprecated
|
|
2492
|
+
*/
|
|
2493
|
+
Operator?: UserInfo
|
|
2494
|
+
}
|
|
2495
|
+
|
|
2284
2496
|
/**
|
|
2285
2497
|
* 企业员工信息
|
|
2286
2498
|
*/
|
|
@@ -2764,8 +2976,8 @@ export interface PdfVerifyResult {
|
|
|
2764
2976
|
* 申请证书的主体的名字
|
|
2765
2977
|
|
|
2766
2978
|
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
|
|
2767
|
-
**企业**: ESS
|
|
2768
|
-
**个人**: ESS
|
|
2979
|
+
**企业**: ESS@企业名称@平台生成的数字编码
|
|
2980
|
+
**个人**: ESS@个人姓名@证件号@平台生成的数字编码
|
|
2769
2981
|
|
|
2770
2982
|
如果在其他平台签署的, 主体的名字参考其他平台的说明
|
|
2771
2983
|
*/
|
|
@@ -3448,11 +3660,18 @@ export interface FlowInfo {
|
|
|
3448
3660
|
}
|
|
3449
3661
|
|
|
3450
3662
|
/**
|
|
3451
|
-
*
|
|
3663
|
+
* 接口调用的员工信息
|
|
3452
3664
|
*/
|
|
3453
3665
|
export interface UserInfo {
|
|
3454
3666
|
/**
|
|
3455
|
-
*
|
|
3667
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
|
|
3668
|
+
|
|
3669
|
+
|
|
3670
|
+
注意:
|
|
3671
|
+
1. OpenId在子客企业对应一个真实员工,**本应用唯一, 不可重复使用**,最大64位字符串
|
|
3672
|
+
2. 可使用用户在贵方企业系统中的Userid或者hash值作为子客企业的员工OpenId
|
|
3673
|
+
3. **员工加入企业后**, 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录子客控制台后, 在**组织架构**模块查看员工们的OpenId, 样式如下图
|
|
3674
|
+

|
|
3456
3675
|
*/
|
|
3457
3676
|
OpenId?: string
|
|
3458
3677
|
/**
|
|
@@ -3664,14 +3883,16 @@ export interface ChannelDescribeEmployeesRequest {
|
|
|
3664
3883
|
/**
|
|
3665
3884
|
* 查询的关键字段,支持Key-Values查询。可选键值如下:
|
|
3666
3885
|
<ul>
|
|
3667
|
-
<li>Key:**"Status"
|
|
3668
|
-
|
|
3669
|
-
<li>Key:**"StaffOpenId"
|
|
3886
|
+
<li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
|
|
3887
|
+
<li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
|
|
3888
|
+
<li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
|
|
3670
3889
|
</ul>
|
|
3890
|
+
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
|
|
3671
3891
|
*/
|
|
3672
3892
|
Filters?: Array<Filter>
|
|
3673
3893
|
/**
|
|
3674
|
-
*
|
|
3894
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页。
|
|
3895
|
+
页码从 0 开始,即首页为 0,最大20000。
|
|
3675
3896
|
*/
|
|
3676
3897
|
Offset?: number
|
|
3677
3898
|
/**
|
|
@@ -3754,6 +3975,24 @@ export interface ChannelCreateFlowApproversResponse {
|
|
|
3754
3975
|
RequestId?: string
|
|
3755
3976
|
}
|
|
3756
3977
|
|
|
3978
|
+
/**
|
|
3979
|
+
* DescribeBillUsageDetail返回参数结构体
|
|
3980
|
+
*/
|
|
3981
|
+
export interface DescribeBillUsageDetailResponse {
|
|
3982
|
+
/**
|
|
3983
|
+
* 返回查询记录总数
|
|
3984
|
+
*/
|
|
3985
|
+
Total?: number
|
|
3986
|
+
/**
|
|
3987
|
+
* 消耗记录详情
|
|
3988
|
+
*/
|
|
3989
|
+
Details?: Array<BillUsageDetail>
|
|
3990
|
+
/**
|
|
3991
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3992
|
+
*/
|
|
3993
|
+
RequestId?: string
|
|
3994
|
+
}
|
|
3995
|
+
|
|
3757
3996
|
/**
|
|
3758
3997
|
* CreateSignUrls请求参数结构体
|
|
3759
3998
|
*/
|
|
@@ -4264,7 +4503,7 @@ export interface FillError {
|
|
|
4264
4503
|
*/
|
|
4265
4504
|
export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
4266
4505
|
/**
|
|
4267
|
-
*
|
|
4506
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4268
4507
|
*/
|
|
4269
4508
|
Agent: Agent
|
|
4270
4509
|
/**
|
|
@@ -4272,23 +4511,36 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4272
4511
|
*/
|
|
4273
4512
|
UserName: string
|
|
4274
4513
|
/**
|
|
4275
|
-
*
|
|
4514
|
+
* 证件号码, 应符合以下规则
|
|
4515
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
4516
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
4517
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
4276
4518
|
*/
|
|
4277
4519
|
IdCardNumber: string
|
|
4278
4520
|
/**
|
|
4279
|
-
*
|
|
4521
|
+
* 电子印章名字,1-50个中文字符
|
|
4522
|
+
注:`同一企业下电子印章名字不能相同`
|
|
4280
4523
|
*/
|
|
4281
4524
|
SealName: string
|
|
4282
4525
|
/**
|
|
4283
|
-
*
|
|
4526
|
+
* 电子印章图片base64编码,大小不超过10M(原始图片不超过5M),只支持PNG或JPG图片格式。
|
|
4527
|
+
|
|
4528
|
+
|
|
4284
4529
|
*/
|
|
4285
4530
|
SealImage: string
|
|
4286
4531
|
/**
|
|
4287
|
-
*
|
|
4532
|
+
* 执行本接口操作的员工信息。
|
|
4533
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
4288
4534
|
*/
|
|
4289
4535
|
Operator?: UserInfo
|
|
4290
4536
|
/**
|
|
4291
|
-
*
|
|
4537
|
+
* 证件类型,支持以下类型
|
|
4538
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
4539
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
4540
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
4541
|
+
<li>OTHER_CARD_TYPE : 其他</li></ul>
|
|
4542
|
+
|
|
4543
|
+
注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
4292
4544
|
*/
|
|
4293
4545
|
IdCardType?: string
|
|
4294
4546
|
/**
|
|
@@ -4935,13 +5187,13 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
4935
5187
|
*/
|
|
4936
5188
|
ReliveInfo: RelieveInfo
|
|
4937
5189
|
/**
|
|
4938
|
-
*
|
|
4939
|
-
|
|
5190
|
+
* 指定解除协议的签署人,如不指定,则默认使用原流程的签署人。 <br/>
|
|
5191
|
+
如需更换原合同中的企业端签署人,可通过指定该签署人在原合同列表中的ApproverNumber编号来更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo/">DescribeFlowDetailInfo</a>查询签署人的ApproverNumber编号,默认从0开始,顺序递增)<br/>
|
|
4940
5192
|
|
|
4941
5193
|
注意:
|
|
4942
5194
|
<ul>
|
|
4943
|
-
<li
|
|
4944
|
-
<li
|
|
5195
|
+
<li>只能更换自己企业的签署人,不支持更换个人类型或者其他企业的签署人</li>
|
|
5196
|
+
<li>可以不指定替换签署人,使用原流程的签署人</li>
|
|
4945
5197
|
</ul>
|
|
4946
5198
|
*/
|
|
4947
5199
|
ReleasedApprovers?: Array<ReleasedApprover>
|
|
@@ -5595,99 +5847,48 @@ export interface ChannelCancelFlowRequest {
|
|
|
5595
5847
|
}
|
|
5596
5848
|
|
|
5597
5849
|
/**
|
|
5598
|
-
*
|
|
5850
|
+
* DescribeBillUsageDetail请求参数结构体
|
|
5599
5851
|
*/
|
|
5600
|
-
export interface
|
|
5852
|
+
export interface DescribeBillUsageDetailRequest {
|
|
5601
5853
|
/**
|
|
5602
5854
|
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5603
|
-
|
|
5604
|
-
此接口下面信息必填。
|
|
5605
|
-
<ul>
|
|
5606
|
-
<li>渠道应用标识: Agent.AppId</li>
|
|
5607
|
-
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5608
|
-
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5609
|
-
</ul>
|
|
5610
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
5611
5855
|
*/
|
|
5612
5856
|
Agent: Agent
|
|
5613
5857
|
/**
|
|
5614
|
-
*
|
|
5615
|
-
|
|
5616
|
-
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
5617
|
-
*/
|
|
5618
|
-
TemplateId?: string
|
|
5619
|
-
/**
|
|
5620
|
-
* 查询模版的内容
|
|
5621
|
-
|
|
5622
|
-
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
5623
|
-
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
5858
|
+
* 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
5624
5859
|
*/
|
|
5625
|
-
|
|
5860
|
+
StartTime: string
|
|
5626
5861
|
/**
|
|
5627
|
-
*
|
|
5628
|
-
|
|
5629
|
-
注意:
|
|
5630
|
-
1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
|
5631
|
-
2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
|
5632
|
-
4. `若传递此参数,分页参数(Limit,Offset)无效`
|
|
5633
|
-
|
|
5862
|
+
* 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
5634
5863
|
*/
|
|
5635
|
-
|
|
5864
|
+
EndTime: string
|
|
5636
5865
|
/**
|
|
5637
|
-
*
|
|
5638
|
-
|
|
5639
|
-
|
|
5866
|
+
* 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
5867
|
+
对应关系如下
|
|
5868
|
+
CloudEnterprise-企业版合同
|
|
5869
|
+
SingleSignature-单方签章
|
|
5870
|
+
CloudProve-签署报告
|
|
5871
|
+
CloudOnlineSign-腾讯会议在线签约
|
|
5872
|
+
ChannelWeCard-微工卡
|
|
5873
|
+
SignFlow-合同套餐
|
|
5874
|
+
SignFace-签署意愿(人脸识别)
|
|
5875
|
+
SignPassword-签署意愿(密码)
|
|
5876
|
+
SignSMS-签署意愿(短信)
|
|
5877
|
+
PersonalEssAuth-签署人实名(腾讯电子签认证)
|
|
5878
|
+
PersonalThirdAuth-签署人实名(信任第三方认证)
|
|
5879
|
+
OrgEssAuth-签署企业实名
|
|
5880
|
+
FlowNotify-短信通知
|
|
5881
|
+
AuthService-企业工商信息查询
|
|
5640
5882
|
*/
|
|
5641
|
-
|
|
5883
|
+
QuotaType?: string
|
|
5642
5884
|
/**
|
|
5643
|
-
*
|
|
5644
|
-
|
|
5645
|
-
注:`1.offset从0开始,即第一页为0。`
|
|
5646
|
-
`2.默认从第一页返回。`
|
|
5885
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
5647
5886
|
*/
|
|
5648
5887
|
Offset?: number
|
|
5649
5888
|
/**
|
|
5650
|
-
*
|
|
5651
|
-
*/
|
|
5652
|
-
TemplateName?: string
|
|
5653
|
-
/**
|
|
5654
|
-
* 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
|
|
5655
|
-
*/
|
|
5656
|
-
ChannelTemplateId?: string
|
|
5657
|
-
/**
|
|
5658
|
-
* 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
5659
|
-
|
|
5660
|
-
<ul><li>**false**:(默认)只返回发起方控件</li>
|
|
5661
|
-
<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
5889
|
+
* 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
5662
5890
|
*/
|
|
5663
|
-
|
|
5664
|
-
/**
|
|
5665
|
-
* 是否获取模板预览链接。
|
|
5666
|
-
|
|
5667
|
-
<ul><li>**false**:不获取(默认)</li>
|
|
5668
|
-
<li>**true**:获取</li></ul>
|
|
5669
|
-
|
|
5670
|
-
设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
|
5671
|
-
|
|
5672
|
-
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5673
|
-
*/
|
|
5674
|
-
WithPreviewUrl?: boolean
|
|
5675
|
-
/**
|
|
5676
|
-
* 是否获取模板的PDF文件链接。
|
|
5677
|
-
|
|
5678
|
-
<ul><li>**false**:不获取(默认)</li>
|
|
5679
|
-
<li>**true**:获取</li></ul>
|
|
5680
|
-
|
|
5681
|
-
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
5682
|
-
|
|
5683
|
-
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5684
|
-
*/
|
|
5685
|
-
WithPdfUrl?: boolean
|
|
5686
|
-
/**
|
|
5687
|
-
* 操作者的信息
|
|
5688
|
-
* @deprecated
|
|
5689
|
-
*/
|
|
5690
|
-
Operator?: UserInfo
|
|
5891
|
+
Limit?: number
|
|
5691
5892
|
}
|
|
5692
5893
|
|
|
5693
5894
|
/**
|
|
@@ -5721,15 +5922,29 @@ export interface RelieveInfo {
|
|
|
5721
5922
|
*/
|
|
5722
5923
|
export interface ChannelCreateSealPolicyRequest {
|
|
5723
5924
|
/**
|
|
5724
|
-
*
|
|
5925
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5926
|
+
|
|
5927
|
+
此接口下面信息必填。
|
|
5928
|
+
|
|
5929
|
+
渠道应用标识: Agent.AppId
|
|
5930
|
+
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
|
|
5931
|
+
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
|
|
5932
|
+
第三方平台子客企业和员工必须已经经过实名认证。
|
|
5725
5933
|
*/
|
|
5726
5934
|
Agent: Agent
|
|
5727
5935
|
/**
|
|
5728
|
-
*
|
|
5936
|
+
* 电子印章ID,为32位字符串。
|
|
5937
|
+
建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
|
|
5938
|
+
可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
|
|
5729
5939
|
*/
|
|
5730
5940
|
SealId: string
|
|
5731
5941
|
/**
|
|
5732
|
-
*
|
|
5942
|
+
*
|
|
5943
|
+
员工在腾讯电子签平台的唯一身份标识,为32位字符串。
|
|
5944
|
+
可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
|
|
5945
|
+
员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
|
|
5946
|
+
该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
|
|
5947
|
+
指定待授权的用户ID数组,电子签的用户ID
|
|
5733
5948
|
可以填写OpenId,系统会通过组织+渠道+OpenId查询得到UserId进行授权。
|
|
5734
5949
|
*/
|
|
5735
5950
|
UserIds: Array<string>
|