tencentcloud-sdk-nodejs-essbasic 4.0.566 → 4.0.568
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 +524 -0
- package/SERVICE_CHANGELOG.md +535 -170
- package/package.json +1 -1
- package/products.md +37 -37
- package/src/services/essbasic/v20210526/essbasic_client.ts +49 -11
- package/src/services/essbasic/v20210526/essbasic_models.ts +472 -290
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +15 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +21 -3
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +361 -206
|
@@ -493,6 +493,46 @@ export interface CreateConsoleLoginUrlResponse {
|
|
|
493
493
|
RequestId?: string
|
|
494
494
|
}
|
|
495
495
|
|
|
496
|
+
/**
|
|
497
|
+
* ChannelDeleteRoleUsers请求参数结构体
|
|
498
|
+
*/
|
|
499
|
+
export interface ChannelDeleteRoleUsersRequest {
|
|
500
|
+
/**
|
|
501
|
+
* 操作人信息
|
|
502
|
+
*/
|
|
503
|
+
Operator: UserInfo
|
|
504
|
+
|
|
505
|
+
/**
|
|
506
|
+
* 角色Id
|
|
507
|
+
*/
|
|
508
|
+
RoleId: string
|
|
509
|
+
|
|
510
|
+
/**
|
|
511
|
+
* 用户列表
|
|
512
|
+
*/
|
|
513
|
+
UserIds: Array<string>
|
|
514
|
+
|
|
515
|
+
/**
|
|
516
|
+
* 代理信息
|
|
517
|
+
*/
|
|
518
|
+
Agent: Agent
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* ChannelCreateUserRoles返回参数结构体
|
|
523
|
+
*/
|
|
524
|
+
export interface ChannelCreateUserRolesResponse {
|
|
525
|
+
/**
|
|
526
|
+
* 绑定失败的用户角色列表
|
|
527
|
+
*/
|
|
528
|
+
FailedCreateRoleData?: Array<FailedCreateRoleData>
|
|
529
|
+
|
|
530
|
+
/**
|
|
531
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
532
|
+
*/
|
|
533
|
+
RequestId?: string
|
|
534
|
+
}
|
|
535
|
+
|
|
496
536
|
/**
|
|
497
537
|
* SyncProxyOrganization请求参数结构体
|
|
498
538
|
*/
|
|
@@ -798,33 +838,26 @@ MobileCheck:手机号验证
|
|
|
798
838
|
}
|
|
799
839
|
|
|
800
840
|
/**
|
|
801
|
-
*
|
|
841
|
+
* 渠道角色信息
|
|
802
842
|
*/
|
|
803
|
-
export interface
|
|
804
|
-
/**
|
|
805
|
-
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
806
|
-
*/
|
|
807
|
-
AppId: string
|
|
808
|
-
|
|
843
|
+
export interface ChannelRole {
|
|
809
844
|
/**
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
/**
|
|
815
|
-
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
816
|
-
*/
|
|
817
|
-
ProxyOperator?: UserInfo
|
|
845
|
+
* 角色id
|
|
846
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
847
|
+
*/
|
|
848
|
+
RoleId?: string
|
|
818
849
|
|
|
819
850
|
/**
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
851
|
+
* 角色名
|
|
852
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
853
|
+
*/
|
|
854
|
+
RoleName?: string
|
|
823
855
|
|
|
824
856
|
/**
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
857
|
+
* 角色状态:1-启用;2-禁用
|
|
858
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
859
|
+
*/
|
|
860
|
+
RoleStatus?: number
|
|
828
861
|
}
|
|
829
862
|
|
|
830
863
|
/**
|
|
@@ -893,33 +926,24 @@ export interface FlowApproverDetail {
|
|
|
893
926
|
}
|
|
894
927
|
|
|
895
928
|
/**
|
|
896
|
-
*
|
|
929
|
+
* DescribeResourceUrlsByFlows返回参数结构体
|
|
897
930
|
*/
|
|
898
|
-
export interface
|
|
899
|
-
/**
|
|
900
|
-
* 解除理由,最大支持200个字
|
|
901
|
-
*/
|
|
902
|
-
Reason: string
|
|
903
|
-
|
|
904
|
-
/**
|
|
905
|
-
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
906
|
-
*/
|
|
907
|
-
RemainInForceItem?: string
|
|
908
|
-
|
|
931
|
+
export interface DescribeResourceUrlsByFlowsResponse {
|
|
909
932
|
/**
|
|
910
|
-
*
|
|
933
|
+
* 签署流程资源对应链接信息
|
|
911
934
|
*/
|
|
912
|
-
|
|
935
|
+
FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>
|
|
913
936
|
|
|
914
937
|
/**
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
938
|
+
* 创建消息,对应多个合同ID,
|
|
939
|
+
成功为“”,创建失败则对应失败消息
|
|
940
|
+
*/
|
|
941
|
+
ErrorMessages?: Array<string>
|
|
918
942
|
|
|
919
943
|
/**
|
|
920
|
-
*
|
|
944
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
921
945
|
*/
|
|
922
|
-
|
|
946
|
+
RequestId?: string
|
|
923
947
|
}
|
|
924
948
|
|
|
925
949
|
/**
|
|
@@ -1017,130 +1041,35 @@ export interface ResourceUrlInfo {
|
|
|
1017
1041
|
}
|
|
1018
1042
|
|
|
1019
1043
|
/**
|
|
1020
|
-
*
|
|
1021
|
-
|
|
1022
|
-
其中签署方FlowApproverInfo需要传递的参数
|
|
1023
|
-
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
1024
|
-
1-个人:Name、Mobile必传
|
|
1025
|
-
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
1026
|
-
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
1027
|
-
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
1028
|
-
|
|
1029
|
-
RecipientId参数:
|
|
1030
|
-
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
1044
|
+
* ChannelDescribeRoles请求参数结构体
|
|
1031
1045
|
*/
|
|
1032
|
-
export interface
|
|
1046
|
+
export interface ChannelDescribeRolesRequest {
|
|
1033
1047
|
/**
|
|
1034
|
-
*
|
|
1048
|
+
* 操作人信息
|
|
1035
1049
|
*/
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
/**
|
|
1039
|
-
* 签署人身份证件类型
|
|
1040
|
-
1.ID_CARD 居民身份证
|
|
1041
|
-
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
1042
|
-
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
1043
|
-
*/
|
|
1044
|
-
IdCardType?: string
|
|
1050
|
+
Operator: UserInfo
|
|
1045
1051
|
|
|
1046
1052
|
/**
|
|
1047
|
-
*
|
|
1053
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
1048
1054
|
*/
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
/**
|
|
1052
|
-
* 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
|
|
1053
|
-
*/
|
|
1054
|
-
Mobile?: string
|
|
1055
|
-
|
|
1056
|
-
/**
|
|
1057
|
-
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
1058
|
-
*/
|
|
1059
|
-
OrganizationName?: string
|
|
1060
|
-
|
|
1061
|
-
/**
|
|
1062
|
-
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
1063
|
-
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
1064
|
-
*/
|
|
1065
|
-
NotChannelOrganization?: boolean
|
|
1066
|
-
|
|
1067
|
-
/**
|
|
1068
|
-
* 用户侧第三方id,最大长度64个字符
|
|
1069
|
-
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
1070
|
-
*/
|
|
1071
|
-
OpenId?: string
|
|
1072
|
-
|
|
1073
|
-
/**
|
|
1074
|
-
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
1075
|
-
*/
|
|
1076
|
-
OrganizationOpenId?: string
|
|
1077
|
-
|
|
1078
|
-
/**
|
|
1079
|
-
* 签署人类型
|
|
1080
|
-
PERSON-个人/自然人;
|
|
1081
|
-
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
1082
|
-
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
1083
|
-
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
1084
|
-
*/
|
|
1085
|
-
ApproverType?: string
|
|
1086
|
-
|
|
1087
|
-
/**
|
|
1088
|
-
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
1089
|
-
*/
|
|
1090
|
-
RecipientId?: string
|
|
1091
|
-
|
|
1092
|
-
/**
|
|
1093
|
-
* 签署截止时间,默认一年
|
|
1094
|
-
*/
|
|
1095
|
-
Deadline?: number
|
|
1096
|
-
|
|
1097
|
-
/**
|
|
1098
|
-
* 签署完回调url,最大长度1000个字符
|
|
1099
|
-
*/
|
|
1100
|
-
CallbackUrl?: string
|
|
1101
|
-
|
|
1102
|
-
/**
|
|
1103
|
-
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
1104
|
-
*/
|
|
1105
|
-
SignComponents?: Array<Component>
|
|
1106
|
-
|
|
1107
|
-
/**
|
|
1108
|
-
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
1109
|
-
HANDWRITE -手写签名
|
|
1110
|
-
*/
|
|
1111
|
-
ComponentLimitType?: Array<string>
|
|
1112
|
-
|
|
1113
|
-
/**
|
|
1114
|
-
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
1115
|
-
*/
|
|
1116
|
-
PreReadTime?: number
|
|
1117
|
-
|
|
1118
|
-
/**
|
|
1119
|
-
* 签署完前端跳转的url,暂未使用
|
|
1120
|
-
*/
|
|
1121
|
-
JumpUrl?: string
|
|
1055
|
+
Agent: Agent
|
|
1122
1056
|
|
|
1123
1057
|
/**
|
|
1124
|
-
*
|
|
1058
|
+
* 查询起始偏移,最大2000
|
|
1125
1059
|
*/
|
|
1126
|
-
|
|
1060
|
+
Offset: number
|
|
1127
1061
|
|
|
1128
1062
|
/**
|
|
1129
|
-
*
|
|
1063
|
+
* 查询数量,最大200
|
|
1130
1064
|
*/
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
/**
|
|
1134
|
-
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
1135
|
-
查看合同的签署方式 Flow层级的优先于approver层级的
|
|
1136
|
-
*/
|
|
1137
|
-
ApproverVerifyTypes?: Array<number>
|
|
1065
|
+
Limit: string
|
|
1138
1066
|
|
|
1139
1067
|
/**
|
|
1140
|
-
*
|
|
1141
|
-
1
|
|
1068
|
+
* 查询的关键字段:
|
|
1069
|
+
Key:"RoleType",Vales:["1"]查询系统角色,Values:["2]查询自定义角色
|
|
1070
|
+
Key:"RoleStatus",Values:["1"]查询启用角色,Values:["2"]查询禁用角色
|
|
1142
1071
|
*/
|
|
1143
|
-
|
|
1072
|
+
Filters?: Array<Filter>
|
|
1144
1073
|
}
|
|
1145
1074
|
|
|
1146
1075
|
/**
|
|
@@ -1263,6 +1192,36 @@ export interface GetDownloadFlowUrlResponse {
|
|
|
1263
1192
|
RequestId?: string
|
|
1264
1193
|
}
|
|
1265
1194
|
|
|
1195
|
+
/**
|
|
1196
|
+
* 应用相关信息
|
|
1197
|
+
*/
|
|
1198
|
+
export interface Agent {
|
|
1199
|
+
/**
|
|
1200
|
+
* 应用的唯一标识。不同的业务系统可以采用不同的AppId,不同AppId下的数据是隔离的。可以由控制台开发者中心-应用集成自主生成。
|
|
1201
|
+
*/
|
|
1202
|
+
AppId: string
|
|
1203
|
+
|
|
1204
|
+
/**
|
|
1205
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
1206
|
+
*/
|
|
1207
|
+
ProxyOrganizationOpenId?: string
|
|
1208
|
+
|
|
1209
|
+
/**
|
|
1210
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
1211
|
+
*/
|
|
1212
|
+
ProxyOperator?: UserInfo
|
|
1213
|
+
|
|
1214
|
+
/**
|
|
1215
|
+
* 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
1216
|
+
*/
|
|
1217
|
+
ProxyAppId?: string
|
|
1218
|
+
|
|
1219
|
+
/**
|
|
1220
|
+
* 内部参数,暂未开放使用
|
|
1221
|
+
*/
|
|
1222
|
+
ProxyOrganizationId?: string
|
|
1223
|
+
}
|
|
1224
|
+
|
|
1266
1225
|
/**
|
|
1267
1226
|
* 签署参与者信息
|
|
1268
1227
|
*/
|
|
@@ -1365,7 +1324,7 @@ export interface StaffRole {
|
|
|
1365
1324
|
*/
|
|
1366
1325
|
export interface ChannelVerifyPdfRequest {
|
|
1367
1326
|
/**
|
|
1368
|
-
*
|
|
1327
|
+
* 流程ID
|
|
1369
1328
|
*/
|
|
1370
1329
|
FlowId: string
|
|
1371
1330
|
|
|
@@ -1410,9 +1369,8 @@ export interface ChannelVerifyPdfResponse {
|
|
|
1410
1369
|
VerifyResult?: number
|
|
1411
1370
|
|
|
1412
1371
|
/**
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
*/
|
|
1372
|
+
* 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
|
|
1373
|
+
*/
|
|
1416
1374
|
PdfVerifyResults?: Array<PdfVerifyResult>
|
|
1417
1375
|
|
|
1418
1376
|
/**
|
|
@@ -1512,6 +1470,91 @@ export interface OrganizationInfo {
|
|
|
1512
1470
|
Channel?: string
|
|
1513
1471
|
}
|
|
1514
1472
|
|
|
1473
|
+
/**
|
|
1474
|
+
* 签署链接内容
|
|
1475
|
+
*/
|
|
1476
|
+
export interface SignUrlInfo {
|
|
1477
|
+
/**
|
|
1478
|
+
* 签署链接,过期时间为30天
|
|
1479
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1480
|
+
*/
|
|
1481
|
+
SignUrl: string
|
|
1482
|
+
|
|
1483
|
+
/**
|
|
1484
|
+
* 合同过期时间
|
|
1485
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1486
|
+
*/
|
|
1487
|
+
Deadline: number
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
1491
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1492
|
+
*/
|
|
1493
|
+
SignOrder: number
|
|
1494
|
+
|
|
1495
|
+
/**
|
|
1496
|
+
* 签署人编号
|
|
1497
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1498
|
+
*/
|
|
1499
|
+
SignId: string
|
|
1500
|
+
|
|
1501
|
+
/**
|
|
1502
|
+
* 自定义用户编号
|
|
1503
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1504
|
+
*/
|
|
1505
|
+
CustomUserId: string
|
|
1506
|
+
|
|
1507
|
+
/**
|
|
1508
|
+
* 用户姓名
|
|
1509
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1510
|
+
*/
|
|
1511
|
+
Name: string
|
|
1512
|
+
|
|
1513
|
+
/**
|
|
1514
|
+
* 用户手机号码
|
|
1515
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1516
|
+
*/
|
|
1517
|
+
Mobile: string
|
|
1518
|
+
|
|
1519
|
+
/**
|
|
1520
|
+
* 签署参与者机构名字
|
|
1521
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1522
|
+
*/
|
|
1523
|
+
OrganizationName: string
|
|
1524
|
+
|
|
1525
|
+
/**
|
|
1526
|
+
* 参与者类型:
|
|
1527
|
+
ORGANIZATION 企业经办人
|
|
1528
|
+
PERSON 自然人
|
|
1529
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1530
|
+
*/
|
|
1531
|
+
ApproverType: string
|
|
1532
|
+
|
|
1533
|
+
/**
|
|
1534
|
+
* 经办人身份证号
|
|
1535
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1536
|
+
*/
|
|
1537
|
+
IdCardNumber: string
|
|
1538
|
+
|
|
1539
|
+
/**
|
|
1540
|
+
* 签署链接对应流程Id
|
|
1541
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1542
|
+
*/
|
|
1543
|
+
FlowId: string
|
|
1544
|
+
|
|
1545
|
+
/**
|
|
1546
|
+
* 企业经办人 用户在渠道的编号
|
|
1547
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1548
|
+
*/
|
|
1549
|
+
OpenId: string
|
|
1550
|
+
|
|
1551
|
+
/**
|
|
1552
|
+
* 合同组签署链接对应的合同组id
|
|
1553
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1554
|
+
*/
|
|
1555
|
+
FlowGroupId: string
|
|
1556
|
+
}
|
|
1557
|
+
|
|
1515
1558
|
/**
|
|
1516
1559
|
* 通用签署人信息
|
|
1517
1560
|
*/
|
|
@@ -2219,19 +2262,13 @@ export interface AuthorizedUser {
|
|
|
2219
2262
|
}
|
|
2220
2263
|
|
|
2221
2264
|
/**
|
|
2222
|
-
*
|
|
2265
|
+
* ChannelDeleteRoleUsers返回参数结构体
|
|
2223
2266
|
*/
|
|
2224
|
-
export interface
|
|
2267
|
+
export interface ChannelDeleteRoleUsersResponse {
|
|
2225
2268
|
/**
|
|
2226
|
-
*
|
|
2269
|
+
* 角色id
|
|
2227
2270
|
*/
|
|
2228
|
-
|
|
2229
|
-
|
|
2230
|
-
/**
|
|
2231
|
-
* 创建消息,对应多个合同ID,
|
|
2232
|
-
成功为“”,创建失败则对应失败消息
|
|
2233
|
-
*/
|
|
2234
|
-
ErrorMessages?: Array<string>
|
|
2271
|
+
RoleId?: string
|
|
2235
2272
|
|
|
2236
2273
|
/**
|
|
2237
2274
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2315,107 +2352,234 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
|
2315
2352
|
Mobile?: string
|
|
2316
2353
|
|
|
2317
2354
|
/**
|
|
2318
|
-
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
2319
|
-
*/
|
|
2320
|
-
OrganizationOpenId?: string
|
|
2355
|
+
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
2356
|
+
*/
|
|
2357
|
+
OrganizationOpenId?: string
|
|
2358
|
+
|
|
2359
|
+
/**
|
|
2360
|
+
* 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
|
|
2361
|
+
*/
|
|
2362
|
+
OpenId?: string
|
|
2363
|
+
|
|
2364
|
+
/**
|
|
2365
|
+
* Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
|
|
2366
|
+
*/
|
|
2367
|
+
AutoJumpBack?: boolean
|
|
2368
|
+
|
|
2369
|
+
/**
|
|
2370
|
+
* 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
|
|
2371
|
+
*/
|
|
2372
|
+
JumpUrl?: string
|
|
2373
|
+
|
|
2374
|
+
/**
|
|
2375
|
+
* 暂未开放
|
|
2376
|
+
*/
|
|
2377
|
+
Operator?: UserInfo
|
|
2378
|
+
}
|
|
2379
|
+
|
|
2380
|
+
/**
|
|
2381
|
+
* ChannelCreateMultiFlowSignQRCode请求参数结构体
|
|
2382
|
+
*/
|
|
2383
|
+
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
2384
|
+
/**
|
|
2385
|
+
* 应用相关信息。
|
|
2386
|
+
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
2387
|
+
*/
|
|
2388
|
+
Agent: Agent
|
|
2389
|
+
|
|
2390
|
+
/**
|
|
2391
|
+
* 模版ID
|
|
2392
|
+
*/
|
|
2393
|
+
TemplateId: string
|
|
2394
|
+
|
|
2395
|
+
/**
|
|
2396
|
+
* 签署流程名称,最大长度200个字符。
|
|
2397
|
+
*/
|
|
2398
|
+
FlowName: string
|
|
2399
|
+
|
|
2400
|
+
/**
|
|
2401
|
+
* 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
|
|
2402
|
+
*/
|
|
2403
|
+
MaxFlowNum?: number
|
|
2404
|
+
|
|
2405
|
+
/**
|
|
2406
|
+
* 签署流程有效天数 默认7天 最高设置不超过30天
|
|
2407
|
+
*/
|
|
2408
|
+
FlowEffectiveDay?: number
|
|
2409
|
+
|
|
2410
|
+
/**
|
|
2411
|
+
* 二维码有效天数 默认7天 最高设置不超过90天
|
|
2412
|
+
*/
|
|
2413
|
+
QrEffectiveDay?: number
|
|
2414
|
+
|
|
2415
|
+
/**
|
|
2416
|
+
* 限制二维码用户条件
|
|
2417
|
+
*/
|
|
2418
|
+
Restrictions?: Array<ApproverRestriction>
|
|
2419
|
+
|
|
2420
|
+
/**
|
|
2421
|
+
* 回调地址,最大长度1000个字符
|
|
2422
|
+
不传默认使用第三方应用号配置的回调地址
|
|
2423
|
+
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2424
|
+
*/
|
|
2425
|
+
CallbackUrl?: string
|
|
2426
|
+
|
|
2427
|
+
/**
|
|
2428
|
+
* 限制二维码用户条件(已弃用)
|
|
2429
|
+
*/
|
|
2430
|
+
ApproverRestrictions?: ApproverRestriction
|
|
2431
|
+
|
|
2432
|
+
/**
|
|
2433
|
+
* 暂未开放
|
|
2434
|
+
*/
|
|
2435
|
+
Operator?: UserInfo
|
|
2436
|
+
}
|
|
2437
|
+
|
|
2438
|
+
/**
|
|
2439
|
+
* 一码多扫签署二维码对象
|
|
2440
|
+
*/
|
|
2441
|
+
export interface SignQrCode {
|
|
2442
|
+
/**
|
|
2443
|
+
* 二维码id
|
|
2444
|
+
*/
|
|
2445
|
+
QrCodeId: string
|
|
2446
|
+
|
|
2447
|
+
/**
|
|
2448
|
+
* 二维码url
|
|
2449
|
+
*/
|
|
2450
|
+
QrCodeUrl: string
|
|
2451
|
+
|
|
2452
|
+
/**
|
|
2453
|
+
* 二维码过期时间
|
|
2454
|
+
*/
|
|
2455
|
+
ExpiredTime: number
|
|
2456
|
+
}
|
|
2457
|
+
|
|
2458
|
+
/**
|
|
2459
|
+
* 创建签署流程签署人入参。
|
|
2460
|
+
|
|
2461
|
+
其中签署方FlowApproverInfo需要传递的参数
|
|
2462
|
+
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
2463
|
+
1-个人:Name、Mobile必传
|
|
2464
|
+
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
2465
|
+
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
2466
|
+
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
2467
|
+
|
|
2468
|
+
RecipientId参数:
|
|
2469
|
+
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
2470
|
+
*/
|
|
2471
|
+
export interface FlowApproverInfo {
|
|
2472
|
+
/**
|
|
2473
|
+
* 签署人姓名,最大长度50个字符
|
|
2474
|
+
*/
|
|
2475
|
+
Name?: string
|
|
2476
|
+
|
|
2477
|
+
/**
|
|
2478
|
+
* 签署人身份证件类型
|
|
2479
|
+
1.ID_CARD 居民身份证
|
|
2480
|
+
2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
|
|
2481
|
+
3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
|
|
2482
|
+
*/
|
|
2483
|
+
IdCardType?: string
|
|
2321
2484
|
|
|
2322
2485
|
/**
|
|
2323
|
-
*
|
|
2486
|
+
* 签署人证件号
|
|
2324
2487
|
*/
|
|
2325
|
-
|
|
2488
|
+
IdCardNumber?: string
|
|
2326
2489
|
|
|
2327
2490
|
/**
|
|
2328
|
-
*
|
|
2491
|
+
* 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
|
|
2329
2492
|
*/
|
|
2330
|
-
|
|
2493
|
+
Mobile?: string
|
|
2331
2494
|
|
|
2332
2495
|
/**
|
|
2333
|
-
*
|
|
2496
|
+
* 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2334
2497
|
*/
|
|
2335
|
-
|
|
2498
|
+
OrganizationName?: string
|
|
2336
2499
|
|
|
2337
2500
|
/**
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
|
-
|
|
2501
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
2502
|
+
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
2503
|
+
*/
|
|
2504
|
+
NotChannelOrganization?: boolean
|
|
2342
2505
|
|
|
2343
|
-
/**
|
|
2344
|
-
* ChannelCreateMultiFlowSignQRCode请求参数结构体
|
|
2345
|
-
*/
|
|
2346
|
-
export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
2347
2506
|
/**
|
|
2348
|
-
*
|
|
2349
|
-
|
|
2507
|
+
* 用户侧第三方id,最大长度64个字符
|
|
2508
|
+
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
2350
2509
|
*/
|
|
2351
|
-
|
|
2510
|
+
OpenId?: string
|
|
2352
2511
|
|
|
2353
2512
|
/**
|
|
2354
|
-
*
|
|
2513
|
+
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
2355
2514
|
*/
|
|
2356
|
-
|
|
2515
|
+
OrganizationOpenId?: string
|
|
2357
2516
|
|
|
2358
2517
|
/**
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2518
|
+
* 签署人类型
|
|
2519
|
+
PERSON-个人/自然人;
|
|
2520
|
+
PERSON_AUTO_SIGN-个人自动签(定制化场景下使用);
|
|
2521
|
+
ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
|
|
2522
|
+
ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
|
|
2523
|
+
*/
|
|
2524
|
+
ApproverType?: string
|
|
2362
2525
|
|
|
2363
2526
|
/**
|
|
2364
|
-
*
|
|
2527
|
+
* 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
|
|
2365
2528
|
*/
|
|
2366
|
-
|
|
2529
|
+
RecipientId?: string
|
|
2367
2530
|
|
|
2368
2531
|
/**
|
|
2369
|
-
*
|
|
2532
|
+
* 签署截止时间,默认一年
|
|
2370
2533
|
*/
|
|
2371
|
-
|
|
2534
|
+
Deadline?: number
|
|
2372
2535
|
|
|
2373
2536
|
/**
|
|
2374
|
-
*
|
|
2537
|
+
* 签署完回调url,最大长度1000个字符
|
|
2375
2538
|
*/
|
|
2376
|
-
|
|
2539
|
+
CallbackUrl?: string
|
|
2377
2540
|
|
|
2378
2541
|
/**
|
|
2379
|
-
*
|
|
2542
|
+
* 使用PDF文件直接发起合同时,签署人指定的签署控件
|
|
2380
2543
|
*/
|
|
2381
|
-
|
|
2544
|
+
SignComponents?: Array<Component>
|
|
2382
2545
|
|
|
2383
2546
|
/**
|
|
2384
|
-
*
|
|
2385
|
-
|
|
2386
|
-
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2547
|
+
* 个人签署方指定签署控件类型,目前支持:OCR_ESIGN -AI智慧手写签名
|
|
2548
|
+
HANDWRITE -手写签名
|
|
2387
2549
|
*/
|
|
2388
|
-
|
|
2550
|
+
ComponentLimitType?: Array<string>
|
|
2389
2551
|
|
|
2390
2552
|
/**
|
|
2391
|
-
*
|
|
2553
|
+
* 合同的强制预览时间:3~300s,未指定则按合同页数计算
|
|
2392
2554
|
*/
|
|
2393
|
-
|
|
2555
|
+
PreReadTime?: number
|
|
2394
2556
|
|
|
2395
2557
|
/**
|
|
2396
|
-
*
|
|
2558
|
+
* 签署完前端跳转的url,暂未使用
|
|
2397
2559
|
*/
|
|
2398
|
-
|
|
2399
|
-
}
|
|
2560
|
+
JumpUrl?: string
|
|
2400
2561
|
|
|
2401
|
-
/**
|
|
2402
|
-
* 一码多扫签署二维码对象
|
|
2403
|
-
*/
|
|
2404
|
-
export interface SignQrCode {
|
|
2405
2562
|
/**
|
|
2406
|
-
*
|
|
2563
|
+
* 签署人个性化能力值
|
|
2407
2564
|
*/
|
|
2408
|
-
|
|
2565
|
+
ApproverOption?: ApproverOption
|
|
2409
2566
|
|
|
2410
2567
|
/**
|
|
2411
|
-
*
|
|
2568
|
+
* 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
|
|
2412
2569
|
*/
|
|
2413
|
-
|
|
2570
|
+
ApproverNeedSignReview?: boolean
|
|
2414
2571
|
|
|
2415
2572
|
/**
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2573
|
+
* 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1
|
|
2574
|
+
查看合同的认证方式 Flow层级的优先于approver层级的
|
|
2575
|
+
*/
|
|
2576
|
+
ApproverVerifyTypes?: Array<number>
|
|
2577
|
+
|
|
2578
|
+
/**
|
|
2579
|
+
* 签署人签署合同时的认证方式
|
|
2580
|
+
1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
|
|
2581
|
+
*/
|
|
2582
|
+
ApproverSignTypes?: Array<number>
|
|
2419
2583
|
}
|
|
2420
2584
|
|
|
2421
2585
|
/**
|
|
@@ -2580,88 +2744,20 @@ export interface SyncProxyOrganizationOperatorsResponse {
|
|
|
2580
2744
|
}
|
|
2581
2745
|
|
|
2582
2746
|
/**
|
|
2583
|
-
*
|
|
2747
|
+
* 绑定失败的用户角色信息
|
|
2584
2748
|
*/
|
|
2585
|
-
export interface
|
|
2586
|
-
/**
|
|
2587
|
-
* 签署链接,过期时间为30天
|
|
2588
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2589
|
-
*/
|
|
2590
|
-
SignUrl: string
|
|
2591
|
-
|
|
2592
|
-
/**
|
|
2593
|
-
* 合同过期时间
|
|
2594
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2595
|
-
*/
|
|
2596
|
-
Deadline: number
|
|
2597
|
-
|
|
2598
|
-
/**
|
|
2599
|
-
* 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
|
|
2600
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2601
|
-
*/
|
|
2602
|
-
SignOrder: number
|
|
2603
|
-
|
|
2604
|
-
/**
|
|
2605
|
-
* 签署人编号
|
|
2606
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2607
|
-
*/
|
|
2608
|
-
SignId: string
|
|
2609
|
-
|
|
2610
|
-
/**
|
|
2611
|
-
* 自定义用户编号
|
|
2612
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2613
|
-
*/
|
|
2614
|
-
CustomUserId: string
|
|
2615
|
-
|
|
2616
|
-
/**
|
|
2617
|
-
* 用户姓名
|
|
2618
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2619
|
-
*/
|
|
2620
|
-
Name: string
|
|
2621
|
-
|
|
2622
|
-
/**
|
|
2623
|
-
* 用户手机号码
|
|
2624
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2625
|
-
*/
|
|
2626
|
-
Mobile: string
|
|
2627
|
-
|
|
2628
|
-
/**
|
|
2629
|
-
* 签署参与者机构名字
|
|
2630
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2631
|
-
*/
|
|
2632
|
-
OrganizationName: string
|
|
2633
|
-
|
|
2749
|
+
export interface FailedCreateRoleData {
|
|
2634
2750
|
/**
|
|
2635
|
-
*
|
|
2636
|
-
ORGANIZATION 企业经办人
|
|
2637
|
-
PERSON 自然人
|
|
2638
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2639
|
-
*/
|
|
2640
|
-
ApproverType: string
|
|
2641
|
-
|
|
2642
|
-
/**
|
|
2643
|
-
* 经办人身份证号
|
|
2644
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2645
|
-
*/
|
|
2646
|
-
IdCardNumber: string
|
|
2647
|
-
|
|
2648
|
-
/**
|
|
2649
|
-
* 签署链接对应流程Id
|
|
2650
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2651
|
-
*/
|
|
2652
|
-
FlowId: string
|
|
2653
|
-
|
|
2654
|
-
/**
|
|
2655
|
-
* 企业经办人 用户在渠道的编号
|
|
2751
|
+
* 用户userId
|
|
2656
2752
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2657
2753
|
*/
|
|
2658
|
-
|
|
2754
|
+
UserId?: string
|
|
2659
2755
|
|
|
2660
2756
|
/**
|
|
2661
|
-
*
|
|
2757
|
+
* 角色RoleId列表
|
|
2662
2758
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2663
2759
|
*/
|
|
2664
|
-
|
|
2760
|
+
RoleIds?: Array<string>
|
|
2665
2761
|
}
|
|
2666
2762
|
|
|
2667
2763
|
/**
|
|
@@ -3003,6 +3099,37 @@ export interface ChannelCancelMultiFlowSignQRCodeResponse {
|
|
|
3003
3099
|
RequestId?: string
|
|
3004
3100
|
}
|
|
3005
3101
|
|
|
3102
|
+
/**
|
|
3103
|
+
* ChannelDescribeRoles返回参数结构体
|
|
3104
|
+
*/
|
|
3105
|
+
export interface ChannelDescribeRolesResponse {
|
|
3106
|
+
/**
|
|
3107
|
+
* 页面偏移量,最大2000
|
|
3108
|
+
*/
|
|
3109
|
+
Offset?: number
|
|
3110
|
+
|
|
3111
|
+
/**
|
|
3112
|
+
* 查询数量,最大200
|
|
3113
|
+
*/
|
|
3114
|
+
Limit?: number
|
|
3115
|
+
|
|
3116
|
+
/**
|
|
3117
|
+
* 查询角色的总数量
|
|
3118
|
+
*/
|
|
3119
|
+
TotalCount?: number
|
|
3120
|
+
|
|
3121
|
+
/**
|
|
3122
|
+
* 角色信息
|
|
3123
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3124
|
+
*/
|
|
3125
|
+
ChannelRoles?: Array<ChannelRole>
|
|
3126
|
+
|
|
3127
|
+
/**
|
|
3128
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3129
|
+
*/
|
|
3130
|
+
RequestId?: string
|
|
3131
|
+
}
|
|
3132
|
+
|
|
3006
3133
|
/**
|
|
3007
3134
|
* ChannelCreateReleaseFlow请求参数结构体
|
|
3008
3135
|
*/
|
|
@@ -3165,6 +3292,31 @@ export interface ModifyExtendedServiceResponse {
|
|
|
3165
3292
|
RequestId?: string
|
|
3166
3293
|
}
|
|
3167
3294
|
|
|
3295
|
+
/**
|
|
3296
|
+
* ChannelCreateUserRoles请求参数结构体
|
|
3297
|
+
*/
|
|
3298
|
+
export interface ChannelCreateUserRolesRequest {
|
|
3299
|
+
/**
|
|
3300
|
+
* 操作者信息
|
|
3301
|
+
*/
|
|
3302
|
+
Operator: UserInfo
|
|
3303
|
+
|
|
3304
|
+
/**
|
|
3305
|
+
* 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 必填。
|
|
3306
|
+
*/
|
|
3307
|
+
Agent: Agent
|
|
3308
|
+
|
|
3309
|
+
/**
|
|
3310
|
+
* 绑定角色的员工id列表
|
|
3311
|
+
*/
|
|
3312
|
+
UserIds: Array<string>
|
|
3313
|
+
|
|
3314
|
+
/**
|
|
3315
|
+
* 绑定角色的角色id列表
|
|
3316
|
+
*/
|
|
3317
|
+
RoleIds: Array<string>
|
|
3318
|
+
}
|
|
3319
|
+
|
|
3168
3320
|
/**
|
|
3169
3321
|
* ChannelGetTaskResultApi返回参数结构体
|
|
3170
3322
|
*/
|
|
@@ -3704,6 +3856,36 @@ export interface DescribeTemplatesRequest {
|
|
|
3704
3856
|
ChannelTemplateId?: string
|
|
3705
3857
|
}
|
|
3706
3858
|
|
|
3859
|
+
/**
|
|
3860
|
+
* 解除协议文档中内容信息,包括但不限于:解除理由、解除后仍然有效的条款-保留条款、原合同事项处理-费用结算、原合同事项处理-其他事项、其他约定等。
|
|
3861
|
+
*/
|
|
3862
|
+
export interface RelieveInfo {
|
|
3863
|
+
/**
|
|
3864
|
+
* 解除理由,最大支持200个字
|
|
3865
|
+
*/
|
|
3866
|
+
Reason: string
|
|
3867
|
+
|
|
3868
|
+
/**
|
|
3869
|
+
* 解除后仍然有效的条款,保留条款,最大支持200个字
|
|
3870
|
+
*/
|
|
3871
|
+
RemainInForceItem?: string
|
|
3872
|
+
|
|
3873
|
+
/**
|
|
3874
|
+
* 原合同事项处理-费用结算,最大支持200个字
|
|
3875
|
+
*/
|
|
3876
|
+
OriginalExpenseSettlement?: string
|
|
3877
|
+
|
|
3878
|
+
/**
|
|
3879
|
+
* 原合同事项处理-其他事项,最大支持200个字
|
|
3880
|
+
*/
|
|
3881
|
+
OriginalOtherSettlement?: string
|
|
3882
|
+
|
|
3883
|
+
/**
|
|
3884
|
+
* 其他约定,最大支持200个字
|
|
3885
|
+
*/
|
|
3886
|
+
OtherDeals?: string
|
|
3887
|
+
}
|
|
3888
|
+
|
|
3707
3889
|
/**
|
|
3708
3890
|
* ChannelCreateSealPolicy请求参数结构体
|
|
3709
3891
|
*/
|