tencentcloud-sdk-nodejs-essbasic 4.0.721 → 4.0.723
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 +246 -0
- package/SERVICE_CHANGELOG.md +229 -110
- package/package.json +1 -1
- package/products.md +23 -23
- package/src/services/essbasic/v20210526/essbasic_client.ts +44 -16
- package/src/services/essbasic/v20210526/essbasic_models.ts +236 -155
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +44 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +44 -16
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +236 -155
|
@@ -352,6 +352,8 @@ export interface ChannelDeleteSealPoliciesRequest {
|
|
|
352
352
|
export interface ChannelBatchCancelFlowsResponse {
|
|
353
353
|
/**
|
|
354
354
|
* 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
|
|
355
|
+
|
|
356
|
+
注: `如果全部撤销成功, 此数组为空数组`
|
|
355
357
|
*/
|
|
356
358
|
FailMessages?: Array<string>;
|
|
357
359
|
/**
|
|
@@ -475,17 +477,26 @@ export interface AuthFailMessage {
|
|
|
475
477
|
*/
|
|
476
478
|
export interface DescribeFlowDetailInfoRequest {
|
|
477
479
|
/**
|
|
478
|
-
*
|
|
480
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
481
|
+
|
|
482
|
+
此接口下面信息必填。
|
|
483
|
+
<ul>
|
|
484
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
485
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
486
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
487
|
+
</ul>
|
|
488
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
479
489
|
*/
|
|
480
490
|
Agent: Agent;
|
|
481
491
|
/**
|
|
482
|
-
*
|
|
483
|
-
|
|
492
|
+
* 需要查询的流程ID列表,最多可传入100个ID。
|
|
493
|
+
如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
|
|
484
494
|
*/
|
|
485
495
|
FlowIds?: Array<string>;
|
|
486
496
|
/**
|
|
487
|
-
*
|
|
488
|
-
|
|
497
|
+
* 需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。
|
|
498
|
+
|
|
499
|
+
合同组由<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles" target="_blank">通过多文件创建合同组签署流程</a>等接口创建。
|
|
489
500
|
*/
|
|
490
501
|
FlowGroupId?: string;
|
|
491
502
|
/**
|
|
@@ -826,7 +837,7 @@ export interface ChannelCreateRoleRequest {
|
|
|
826
837
|
*/
|
|
827
838
|
Description?: string;
|
|
828
839
|
/**
|
|
829
|
-
* 权限树,权限树内容 PermissionGroups 可参考接口
|
|
840
|
+
* 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
|
|
830
841
|
*/
|
|
831
842
|
PermissionGroups?: Array<PermissionGroup>;
|
|
832
843
|
}
|
|
@@ -892,68 +903,78 @@ export interface BaseFlowInfo {
|
|
|
892
903
|
Components?: Array<Component>;
|
|
893
904
|
}
|
|
894
905
|
/**
|
|
895
|
-
*
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
906
|
+
* 解除协议的签署人,如不指定,默认使用待解除流程(原流程)中的签署人。</br>
|
|
907
|
+
`注意`:
|
|
908
|
+
- 不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
|
|
909
|
+
- 目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
|
|
910
|
+
- 当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只传参数ApproverSignRole。
|
|
899
911
|
|
|
900
|
-
如果需要指定B
|
|
901
|
-
ApproverNumber
|
|
902
|
-
|
|
903
|
-
-
|
|
904
|
-
-
|
|
912
|
+
如果需要指定B端(企业身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
|
913
|
+
`ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br>
|
|
914
|
+
对于其他身份标识:
|
|
915
|
+
- **子客企业指定经办人**:OpenId必传,OrganizationOpenId必传;
|
|
916
|
+
- **非子客企业经办人**:Name、Mobile必传。
|
|
905
917
|
*/
|
|
906
918
|
export interface ReleasedApprover {
|
|
907
919
|
/**
|
|
908
|
-
*
|
|
909
|
-
|
|
910
|
-
OrganizationName: string;
|
|
911
|
-
/**
|
|
912
|
-
* 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
|
|
920
|
+
* 签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。</br>
|
|
921
|
+
可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
|
|
913
922
|
*/
|
|
914
923
|
ApproverNumber: number;
|
|
915
924
|
/**
|
|
916
|
-
*
|
|
917
|
-
ORGANIZATION
|
|
918
|
-
ENTERPRISESERVER
|
|
925
|
+
* 指定签署人类型,目前支持
|
|
926
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
927
|
+
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
919
928
|
*/
|
|
920
929
|
ApproverType: string;
|
|
921
930
|
/**
|
|
922
|
-
* 签署人姓名,最大长度50
|
|
931
|
+
* 签署人姓名,最大长度50个字。
|
|
923
932
|
*/
|
|
924
933
|
Name?: string;
|
|
925
934
|
/**
|
|
926
|
-
*
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
935
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
936
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
937
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
938
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
930
939
|
*/
|
|
931
940
|
IdCardType?: string;
|
|
932
941
|
/**
|
|
933
|
-
*
|
|
942
|
+
* 证件号码,应符合以下规则
|
|
943
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
944
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
945
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
934
946
|
*/
|
|
935
947
|
IdCardNumber?: string;
|
|
936
948
|
/**
|
|
937
|
-
*
|
|
949
|
+
* 签署人手机号。
|
|
938
950
|
*/
|
|
939
951
|
Mobile?: string;
|
|
940
952
|
/**
|
|
941
|
-
*
|
|
953
|
+
* 组织机构名称。
|
|
954
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
955
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
956
|
+
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
957
|
+
*/
|
|
958
|
+
OrganizationName?: string;
|
|
959
|
+
/**
|
|
960
|
+
* 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
|
|
961
|
+
当为子客企业指定经办人时,此OrganizationOpenId必传。
|
|
942
962
|
*/
|
|
943
963
|
OrganizationOpenId?: string;
|
|
944
964
|
/**
|
|
945
|
-
*
|
|
946
|
-
|
|
965
|
+
* 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。</br>
|
|
966
|
+
当签署方为同一第三方平台下的员工时,此OpenId必传。
|
|
947
967
|
*/
|
|
948
968
|
OpenId?: string;
|
|
949
969
|
/**
|
|
950
|
-
*
|
|
951
|
-
|
|
952
|
-
|
|
970
|
+
* 签署控件类型,支持自定义企业签署方的签署控件类型
|
|
971
|
+
<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
|
972
|
+
<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
|
953
973
|
*/
|
|
954
974
|
ApproverSignComponentType?: string;
|
|
955
975
|
/**
|
|
956
|
-
*
|
|
976
|
+
* 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。</br>
|
|
977
|
+
如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
|
|
957
978
|
*/
|
|
958
979
|
ApproverSignRole?: string;
|
|
959
980
|
}
|
|
@@ -1173,27 +1194,34 @@ export interface DownloadFlowInfo {
|
|
|
1173
1194
|
FlowIdList: Array<string>;
|
|
1174
1195
|
}
|
|
1175
1196
|
/**
|
|
1176
|
-
*
|
|
1197
|
+
* 签署人签署链接信息。
|
|
1177
1198
|
*/
|
|
1178
1199
|
export interface FlowApproverUrlInfo {
|
|
1179
1200
|
/**
|
|
1180
|
-
*
|
|
1201
|
+
* 签署短链接。</br>
|
|
1202
|
+
注意:
|
|
1203
|
+
- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1204
|
+
- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1181
1205
|
*/
|
|
1182
|
-
SignUrl
|
|
1206
|
+
SignUrl?: string;
|
|
1183
1207
|
/**
|
|
1184
|
-
*
|
|
1208
|
+
* 签署人类型。
|
|
1209
|
+
- **PERSON**: 个人
|
|
1185
1210
|
*/
|
|
1186
|
-
ApproverType
|
|
1211
|
+
ApproverType?: string;
|
|
1187
1212
|
/**
|
|
1188
|
-
*
|
|
1213
|
+
* 签署人姓名。
|
|
1189
1214
|
*/
|
|
1190
|
-
Name
|
|
1215
|
+
Name?: string;
|
|
1191
1216
|
/**
|
|
1192
|
-
*
|
|
1217
|
+
* 签署人手机号。
|
|
1193
1218
|
*/
|
|
1194
|
-
Mobile
|
|
1219
|
+
Mobile?: string;
|
|
1195
1220
|
/**
|
|
1196
|
-
*
|
|
1221
|
+
* 签署长链接。</br>
|
|
1222
|
+
注意:
|
|
1223
|
+
- 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
1224
|
+
- 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
1197
1225
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1198
1226
|
*/
|
|
1199
1227
|
LongUrl?: string;
|
|
@@ -1641,25 +1669,26 @@ export interface ChannelCreateFlowByFilesResponse {
|
|
|
1641
1669
|
*/
|
|
1642
1670
|
export interface DescribeFlowDetailInfoResponse {
|
|
1643
1671
|
/**
|
|
1644
|
-
*
|
|
1672
|
+
* 合同归属的第三方平台应用号ID
|
|
1645
1673
|
*/
|
|
1646
1674
|
ApplicationId?: string;
|
|
1647
1675
|
/**
|
|
1648
|
-
*
|
|
1676
|
+
* 合同归属的第三方平台子客企业OpenId
|
|
1649
1677
|
*/
|
|
1650
1678
|
ProxyOrganizationOpenId?: string;
|
|
1651
1679
|
/**
|
|
1652
|
-
*
|
|
1680
|
+
* 合同流程的详细信息。
|
|
1681
|
+
如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
|
|
1653
1682
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1654
1683
|
*/
|
|
1655
1684
|
FlowInfo?: Array<FlowDetailInfo>;
|
|
1656
1685
|
/**
|
|
1657
|
-
*
|
|
1686
|
+
* 合同组ID,只有在查询合同组信息时才会返回。
|
|
1658
1687
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1659
1688
|
*/
|
|
1660
1689
|
FlowGroupId?: string;
|
|
1661
1690
|
/**
|
|
1662
|
-
*
|
|
1691
|
+
* 合同组名称,只有在查询合同组信息时才会返回。
|
|
1663
1692
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1664
1693
|
*/
|
|
1665
1694
|
FlowGroupName?: string;
|
|
@@ -2042,12 +2071,18 @@ export interface StaffRole {
|
|
|
2042
2071
|
export interface ChannelVerifyPdfRequest {
|
|
2043
2072
|
/**
|
|
2044
2073
|
* 合同流程ID,为32位字符串。
|
|
2045
|
-
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
2046
2074
|
*/
|
|
2047
2075
|
FlowId: string;
|
|
2048
2076
|
/**
|
|
2049
|
-
*
|
|
2050
|
-
|
|
2077
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2078
|
+
|
|
2079
|
+
此接口下面信息必填。
|
|
2080
|
+
<ul>
|
|
2081
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2082
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2083
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2084
|
+
</ul>
|
|
2085
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2051
2086
|
*/
|
|
2052
2087
|
Agent?: Agent;
|
|
2053
2088
|
/**
|
|
@@ -2061,14 +2096,15 @@ export interface ChannelVerifyPdfRequest {
|
|
|
2061
2096
|
*/
|
|
2062
2097
|
export interface CreateChannelFlowEvidenceReportRequest {
|
|
2063
2098
|
/**
|
|
2064
|
-
*
|
|
2099
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2065
2100
|
|
|
2066
2101
|
此接口下面信息必填。
|
|
2067
2102
|
<ul>
|
|
2068
|
-
<li>渠道应用标识: Agent.
|
|
2069
|
-
<li>第三方平台子客企业标识: Agent.
|
|
2070
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
2103
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2104
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2105
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2071
2106
|
</ul>
|
|
2107
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2072
2108
|
*/
|
|
2073
2109
|
Agent: Agent;
|
|
2074
2110
|
/**
|
|
@@ -2254,17 +2290,12 @@ export interface ChannelVerifyPdfResponse {
|
|
|
2254
2290
|
<ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
|
|
2255
2291
|
<li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
|
|
2256
2292
|
<li>**3**:文件被篡改。</li>
|
|
2257
|
-
<li>**4
|
|
2293
|
+
<li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
|
|
2258
2294
|
<li>**5**:异常:文件签名格式错误。</li></ul>
|
|
2259
2295
|
*/
|
|
2260
2296
|
VerifyResult?: number;
|
|
2261
2297
|
/**
|
|
2262
|
-
*
|
|
2263
|
-
<ul><li> **1** :验签成功,在电子签签署</li>
|
|
2264
|
-
<li> **2** :验签成功,在其他平台签署</li>
|
|
2265
|
-
<li> **3** :验签失败</li>
|
|
2266
|
-
<li> **4** :pdf文件没有签名域</li>
|
|
2267
|
-
<li> **5** :文件签名格式错误</li></ul>
|
|
2298
|
+
* 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
|
|
2268
2299
|
*/
|
|
2269
2300
|
PdfVerifyResults?: Array<PdfVerifyResult>;
|
|
2270
2301
|
/**
|
|
@@ -2620,65 +2651,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
|
|
|
2620
2651
|
ExpiredTime?: number;
|
|
2621
2652
|
}
|
|
2622
2653
|
/**
|
|
2623
|
-
*
|
|
2654
|
+
* 合同验签每个签署区的信息
|
|
2624
2655
|
*/
|
|
2625
2656
|
export interface PdfVerifyResult {
|
|
2626
2657
|
/**
|
|
2627
|
-
*
|
|
2658
|
+
* 验签结果详情,每个签名域对应的验签结果。状态值如下
|
|
2659
|
+
<ul><li> **1** :验签成功,在电子签签署</li>
|
|
2660
|
+
<li> **2** :验签成功,在其他平台签署</li>
|
|
2661
|
+
<li> **3** :验签失败</li>
|
|
2662
|
+
<li> **4** :pdf文件没有签名域</li>
|
|
2663
|
+
<li> **5** :文件签名格式错误</li></ul>
|
|
2628
2664
|
*/
|
|
2629
|
-
VerifyResult
|
|
2665
|
+
VerifyResult?: number;
|
|
2630
2666
|
/**
|
|
2631
|
-
*
|
|
2667
|
+
* 签署平台
|
|
2668
|
+
如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
|
|
2669
|
+
如果文件不在腾讯电子签平台签署,则为**其他平台**。
|
|
2632
2670
|
*/
|
|
2633
|
-
SignPlatform
|
|
2671
|
+
SignPlatform?: string;
|
|
2634
2672
|
/**
|
|
2635
|
-
*
|
|
2673
|
+
* 申请证书的主体的名字
|
|
2674
|
+
|
|
2675
|
+
如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
|
|
2676
|
+
**企业**: ESS@企业名称@编码
|
|
2677
|
+
**个人**: ESS@个人姓名@证件号@808854
|
|
2678
|
+
|
|
2679
|
+
如果在其他平台签署的, 主体的名字参考其他平台的说明
|
|
2636
2680
|
*/
|
|
2637
|
-
SignerName
|
|
2681
|
+
SignerName?: string;
|
|
2638
2682
|
/**
|
|
2639
|
-
*
|
|
2683
|
+
* 签署时间的Unix时间戳,单位毫秒
|
|
2640
2684
|
*/
|
|
2641
|
-
SignTime
|
|
2685
|
+
SignTime?: number;
|
|
2642
2686
|
/**
|
|
2643
|
-
*
|
|
2687
|
+
* 证书签名算法, 如SHA1withRSA等算法
|
|
2644
2688
|
*/
|
|
2645
|
-
SignAlgorithm
|
|
2689
|
+
SignAlgorithm?: string;
|
|
2646
2690
|
/**
|
|
2647
|
-
*
|
|
2691
|
+
* CA供应商下发给用户的证书编号
|
|
2692
|
+
|
|
2693
|
+
注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
|
|
2648
2694
|
*/
|
|
2649
|
-
CertSn
|
|
2695
|
+
CertSn?: string;
|
|
2650
2696
|
/**
|
|
2651
|
-
*
|
|
2697
|
+
* 证书起始时间的Unix时间戳,单位毫秒
|
|
2652
2698
|
*/
|
|
2653
|
-
CertNotBefore
|
|
2699
|
+
CertNotBefore?: number;
|
|
2654
2700
|
/**
|
|
2655
|
-
*
|
|
2701
|
+
* 证书过期时间的时间戳,单位毫秒
|
|
2656
2702
|
*/
|
|
2657
|
-
CertNotAfter
|
|
2703
|
+
CertNotAfter?: number;
|
|
2658
2704
|
/**
|
|
2659
|
-
*
|
|
2705
|
+
* 签名类型, 保留字段, 现在全部为0
|
|
2706
|
+
|
|
2707
|
+
|
|
2660
2708
|
*/
|
|
2661
|
-
SignType
|
|
2709
|
+
SignType?: number;
|
|
2662
2710
|
/**
|
|
2663
2711
|
* 签名域横坐标,单位px
|
|
2664
2712
|
*/
|
|
2665
|
-
ComponentPosX
|
|
2713
|
+
ComponentPosX?: number;
|
|
2666
2714
|
/**
|
|
2667
2715
|
* 签名域纵坐标,单位px
|
|
2668
2716
|
*/
|
|
2669
|
-
ComponentPosY
|
|
2717
|
+
ComponentPosY?: number;
|
|
2670
2718
|
/**
|
|
2671
2719
|
* 签名域宽度,单位px
|
|
2672
2720
|
*/
|
|
2673
|
-
ComponentWidth
|
|
2721
|
+
ComponentWidth?: number;
|
|
2674
2722
|
/**
|
|
2675
2723
|
* 签名域高度,单位px
|
|
2676
2724
|
*/
|
|
2677
|
-
ComponentHeight
|
|
2725
|
+
ComponentHeight?: number;
|
|
2678
2726
|
/**
|
|
2679
2727
|
* 签名域所在页码,1~N
|
|
2680
2728
|
*/
|
|
2681
|
-
ComponentPage
|
|
2729
|
+
ComponentPage?: number;
|
|
2682
2730
|
}
|
|
2683
2731
|
/**
|
|
2684
2732
|
* 用户的三要素:姓名,证件号,证件类型
|
|
@@ -3550,15 +3598,25 @@ export interface ChannelDeleteRoleUsersResponse {
|
|
|
3550
3598
|
*/
|
|
3551
3599
|
export interface SyncProxyOrganizationOperatorsRequest {
|
|
3552
3600
|
/**
|
|
3553
|
-
*
|
|
3601
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3602
|
+
|
|
3603
|
+
此接口下面信息必填。
|
|
3604
|
+
<ul>
|
|
3605
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3606
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3607
|
+
</ul>
|
|
3608
|
+
第三方平台子客企业必须已经经过实名认证
|
|
3554
3609
|
*/
|
|
3555
3610
|
Agent: Agent;
|
|
3556
3611
|
/**
|
|
3557
|
-
*
|
|
3612
|
+
* 操作类型,对应的操作
|
|
3613
|
+
<ul><li> **CREATE** :新增员工</li>
|
|
3614
|
+
<li> **UPDATE** :修改员工</li>
|
|
3615
|
+
<li> **RESIGN** :离职员工</li></ul>
|
|
3558
3616
|
*/
|
|
3559
3617
|
OperatorType: string;
|
|
3560
3618
|
/**
|
|
3561
|
-
*
|
|
3619
|
+
* 员工信息列表,最多支持200个
|
|
3562
3620
|
*/
|
|
3563
3621
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
|
|
3564
3622
|
/**
|
|
@@ -4134,56 +4192,58 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4134
4192
|
*/
|
|
4135
4193
|
export interface FlowDetailInfo {
|
|
4136
4194
|
/**
|
|
4137
|
-
*
|
|
4195
|
+
* 合同流程ID,为32位字符串。
|
|
4138
4196
|
*/
|
|
4139
|
-
FlowId
|
|
4197
|
+
FlowId?: string;
|
|
4140
4198
|
/**
|
|
4141
|
-
*
|
|
4199
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
4142
4200
|
*/
|
|
4143
|
-
FlowName
|
|
4201
|
+
FlowName?: string;
|
|
4144
4202
|
/**
|
|
4145
|
-
*
|
|
4203
|
+
* 合同流程的类别分类(如销售合同/入职合同等)。
|
|
4146
4204
|
*/
|
|
4147
|
-
FlowType
|
|
4205
|
+
FlowType?: string;
|
|
4148
4206
|
/**
|
|
4149
|
-
*
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
|
|
4156
|
-
|
|
4157
|
-
RELIEVED 解除协议(已解除)
|
|
4207
|
+
* 合同流程当前的签署状态, 会存在下列的状态值
|
|
4208
|
+
<ul><li> **INIT** :合同创建</li>
|
|
4209
|
+
<li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
|
|
4210
|
+
<li> **REJECT** :合同拒签</li>
|
|
4211
|
+
<li> **ALL** :合同签署完成</li>
|
|
4212
|
+
<li> **DEADLINE** :合同流签(合同过期)</li>
|
|
4213
|
+
<li> **CANCEL** :合同撤回</li>
|
|
4214
|
+
<li> **RELIEVED** :解除协议(已解除)</li></ul>
|
|
4158
4215
|
|
|
4159
4216
|
*/
|
|
4160
|
-
FlowStatus
|
|
4217
|
+
FlowStatus?: string;
|
|
4161
4218
|
/**
|
|
4162
|
-
*
|
|
4219
|
+
* 当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。
|
|
4163
4220
|
*/
|
|
4164
|
-
FlowMessage
|
|
4221
|
+
FlowMessage?: string;
|
|
4165
4222
|
/**
|
|
4166
|
-
*
|
|
4223
|
+
* 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
|
|
4167
4224
|
*/
|
|
4168
|
-
CreateOn
|
|
4225
|
+
CreateOn?: number;
|
|
4169
4226
|
/**
|
|
4170
|
-
*
|
|
4227
|
+
* 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
|
|
4171
4228
|
*/
|
|
4172
|
-
DeadLine
|
|
4229
|
+
DeadLine?: number;
|
|
4173
4230
|
/**
|
|
4174
|
-
*
|
|
4231
|
+
* 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。
|
|
4232
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
4175
4233
|
*/
|
|
4176
|
-
CustomData
|
|
4234
|
+
CustomData?: string;
|
|
4177
4235
|
/**
|
|
4178
|
-
*
|
|
4236
|
+
* 合同流程的签署方数组
|
|
4179
4237
|
*/
|
|
4180
|
-
FlowApproverInfos
|
|
4238
|
+
FlowApproverInfos?: Array<FlowApproverDetail>;
|
|
4181
4239
|
/**
|
|
4182
|
-
*
|
|
4240
|
+
* 合同流程的关注方信息数组
|
|
4183
4241
|
*/
|
|
4184
4242
|
CcInfos?: Array<FlowApproverDetail>;
|
|
4185
4243
|
/**
|
|
4186
|
-
*
|
|
4244
|
+
* 是否需要发起前审批
|
|
4245
|
+
<ul><li>当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程</li>
|
|
4246
|
+
<li>当NeedCreateReview为false,不需要发起前审核的合同</li></ul>
|
|
4187
4247
|
*/
|
|
4188
4248
|
NeedCreateReview?: boolean;
|
|
4189
4249
|
}
|
|
@@ -4230,11 +4290,19 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
4230
4290
|
*/
|
|
4231
4291
|
export interface DescribeChannelFlowEvidenceReportRequest {
|
|
4232
4292
|
/**
|
|
4233
|
-
*
|
|
4293
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4294
|
+
|
|
4295
|
+
此接口下面信息必填。
|
|
4296
|
+
<ul>
|
|
4297
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4298
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4299
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4300
|
+
</ul>
|
|
4301
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4234
4302
|
*/
|
|
4235
4303
|
Agent: Agent;
|
|
4236
4304
|
/**
|
|
4237
|
-
*
|
|
4305
|
+
* 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
|
|
4238
4306
|
*/
|
|
4239
4307
|
ReportId: string;
|
|
4240
4308
|
/**
|
|
@@ -4261,14 +4329,15 @@ export interface ChannelCreateRoleResponse {
|
|
|
4261
4329
|
*/
|
|
4262
4330
|
export interface SyncProxyOrganizationOperatorsResponse {
|
|
4263
4331
|
/**
|
|
4264
|
-
*
|
|
4265
|
-
|
|
4266
|
-
|
|
4332
|
+
* 同步的状态, 全部同步失败接口是接口会直接报错
|
|
4333
|
+
|
|
4334
|
+
<ul><li> **1** :全部成功</li>
|
|
4335
|
+
<li> **2** :部分成功</li></ul>
|
|
4267
4336
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4268
4337
|
*/
|
|
4269
4338
|
Status?: number;
|
|
4270
4339
|
/**
|
|
4271
|
-
*
|
|
4340
|
+
* 同步失败员工ID及其失败原因
|
|
4272
4341
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4273
4342
|
*/
|
|
4274
4343
|
FailedList?: Array<SyncFailReason>;
|
|
@@ -4842,22 +4911,24 @@ export interface ApproverOption {
|
|
|
4842
4911
|
FlowReadLimit?: string;
|
|
4843
4912
|
}
|
|
4844
4913
|
/**
|
|
4845
|
-
*
|
|
4914
|
+
* 同步的员工的信息
|
|
4846
4915
|
*/
|
|
4847
4916
|
export interface ProxyOrganizationOperator {
|
|
4848
4917
|
/**
|
|
4849
|
-
*
|
|
4918
|
+
* 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
4850
4919
|
*/
|
|
4851
4920
|
Id: string;
|
|
4852
4921
|
/**
|
|
4853
|
-
*
|
|
4922
|
+
* 员工的姓名,最大长度50个字符
|
|
4923
|
+
员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
|
|
4854
4924
|
*/
|
|
4855
4925
|
Name?: string;
|
|
4856
4926
|
/**
|
|
4857
|
-
*
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4927
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
4928
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
4929
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
4930
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
4931
|
+
|
|
4861
4932
|
*/
|
|
4862
4933
|
IdCardType?: string;
|
|
4863
4934
|
/**
|
|
@@ -4865,14 +4936,12 @@ export interface ProxyOrganizationOperator {
|
|
|
4865
4936
|
*/
|
|
4866
4937
|
IdCardNumber?: string;
|
|
4867
4938
|
/**
|
|
4868
|
-
*
|
|
4939
|
+
* 员工的手机号,支持国内手机号11位数字(无需加+86前缀或其他字符),不支持海外手机号。
|
|
4869
4940
|
*/
|
|
4870
4941
|
Mobile?: string;
|
|
4871
4942
|
/**
|
|
4872
|
-
*
|
|
4873
|
-
|
|
4874
|
-
经办人:channel-normal-operator
|
|
4875
|
-
业务员:channel-sales-man
|
|
4943
|
+
* 预先分配员工的角色, 可以分配的角色如下:
|
|
4944
|
+
<table> <thead> <tr> <th>可以分配的角色</th> <th>角色名称</th> <th>角色描述</th> </tr> </thead> <tbody> <tr> <td>admin</td> <td>业务管理员(IT 系统负责人,e.g. CTO)</td> <td>有企业合同模块、印章模块、模板模块等全量功能及数据权限。</td> </tr> <tr> <td>channel-normal-operator</td> <td>经办人(企业法务负责人)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。</td> </tr> <tr> <td>channel-sales-man</td> <td>业务员(一般为销售员、采购员)</td> <td>有发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。</td> </tr> </tbody> </table>
|
|
4876
4945
|
*/
|
|
4877
4946
|
DefaultRole?: string;
|
|
4878
4947
|
}
|
|
@@ -5238,7 +5307,7 @@ export interface ChannelModifyRoleRequest {
|
|
|
5238
5307
|
*/
|
|
5239
5308
|
Description?: string;
|
|
5240
5309
|
/**
|
|
5241
|
-
* 权限树,权限树内容 PermissionGroups 可参考接口
|
|
5310
|
+
* 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
|
|
5242
5311
|
*/
|
|
5243
5312
|
PermissionGroups?: Array<PermissionGroup>;
|
|
5244
5313
|
}
|
|
@@ -5805,19 +5874,18 @@ export interface CreateChannelFlowEvidenceReportResponse {
|
|
|
5805
5874
|
RequestId?: string;
|
|
5806
5875
|
}
|
|
5807
5876
|
/**
|
|
5808
|
-
*
|
|
5877
|
+
* 同步员工失败原因
|
|
5809
5878
|
*/
|
|
5810
5879
|
export interface SyncFailReason {
|
|
5811
5880
|
/**
|
|
5812
|
-
*
|
|
5881
|
+
* 企业员工标识(即OpenId)
|
|
5813
5882
|
*/
|
|
5814
|
-
Id
|
|
5883
|
+
Id?: string;
|
|
5815
5884
|
/**
|
|
5816
|
-
*
|
|
5817
|
-
例如:Id不符合规范、证件号码不合法等
|
|
5885
|
+
* 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
|
|
5818
5886
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5819
5887
|
*/
|
|
5820
|
-
Message
|
|
5888
|
+
Message?: string;
|
|
5821
5889
|
}
|
|
5822
5890
|
/**
|
|
5823
5891
|
* ChannelDescribeEmployees返回参数结构体
|
|
@@ -5904,16 +5972,16 @@ export interface ChannelCreateReleaseFlowResponse {
|
|
|
5904
5972
|
*/
|
|
5905
5973
|
export interface DescribeChannelFlowEvidenceReportResponse {
|
|
5906
5974
|
/**
|
|
5907
|
-
*
|
|
5975
|
+
* 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
|
|
5908
5976
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5909
5977
|
*/
|
|
5910
5978
|
ReportUrl?: string;
|
|
5911
5979
|
/**
|
|
5912
|
-
*
|
|
5980
|
+
* 出证任务执行的状态, 状态含义如下:
|
|
5913
5981
|
|
|
5914
|
-
|
|
5915
|
-
|
|
5916
|
-
|
|
5982
|
+
<ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
|
|
5983
|
+
<li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
|
|
5984
|
+
<li>**EvidenceStatusFailed** : 出征任务执行失败</li></ul>
|
|
5917
5985
|
*/
|
|
5918
5986
|
Status?: string;
|
|
5919
5987
|
/**
|
|
@@ -6040,15 +6108,28 @@ export interface ChannelUpdateSealStatusResponse {
|
|
|
6040
6108
|
*/
|
|
6041
6109
|
export interface ChannelCreateFlowSignUrlRequest {
|
|
6042
6110
|
/**
|
|
6043
|
-
*
|
|
6111
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6112
|
+
|
|
6113
|
+
此接口下面信息必填。
|
|
6114
|
+
<ul>
|
|
6115
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6116
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6117
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6118
|
+
</ul>
|
|
6119
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6044
6120
|
*/
|
|
6045
6121
|
Agent: Agent;
|
|
6046
6122
|
/**
|
|
6047
|
-
*
|
|
6123
|
+
* 合同流程ID,为32位字符串。
|
|
6124
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
6125
|
+
可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
6048
6126
|
*/
|
|
6049
6127
|
FlowId: string;
|
|
6050
6128
|
/**
|
|
6051
|
-
*
|
|
6129
|
+
* 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
|
|
6130
|
+
注:
|
|
6131
|
+
`1. ApproverType目前只支持个人(PERSON)类型的签署人。`
|
|
6132
|
+
`2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
|
6052
6133
|
*/
|
|
6053
6134
|
FlowApproverInfos: Array<FlowApproverInfo>;
|
|
6054
6135
|
/**
|
|
@@ -6062,7 +6143,7 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
6062
6143
|
*/
|
|
6063
6144
|
Organization?: OrganizationInfo;
|
|
6064
6145
|
/**
|
|
6065
|
-
* 签署完之后的H5
|
|
6146
|
+
* 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
|
6066
6147
|
*/
|
|
6067
6148
|
JumpUrl?: string;
|
|
6068
6149
|
}
|