tencentcloud-sdk-nodejs-essbasic 4.0.721 → 4.0.722
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 +123 -0
- package/SERVICE_CHANGELOG.md +141 -115
- package/package.json +1 -1
- package/products.md +9 -9
- package/src/services/essbasic/v20210526/essbasic_client.ts +19 -5
- package/src/services/essbasic/v20210526/essbasic_models.ts +126 -94
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +19 -5
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +19 -5
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +126 -94
|
@@ -504,17 +504,26 @@ export interface AuthFailMessage {
|
|
|
504
504
|
*/
|
|
505
505
|
export interface DescribeFlowDetailInfoRequest {
|
|
506
506
|
/**
|
|
507
|
-
*
|
|
507
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
508
|
+
|
|
509
|
+
此接口下面信息必填。
|
|
510
|
+
<ul>
|
|
511
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
512
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
513
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
514
|
+
</ul>
|
|
515
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
508
516
|
*/
|
|
509
517
|
Agent: Agent
|
|
510
518
|
/**
|
|
511
|
-
*
|
|
512
|
-
|
|
519
|
+
* 需要查询的流程ID列表,最多可传入100个ID。
|
|
520
|
+
如果要查询合同组的信息,则不需要传入此参数,只需传入 FlowGroupId 参数即可。
|
|
513
521
|
*/
|
|
514
522
|
FlowIds?: Array<string>
|
|
515
523
|
/**
|
|
516
|
-
*
|
|
517
|
-
|
|
524
|
+
* 需要查询的流程组ID,如果传入此参数,则会忽略 FlowIds 参数。
|
|
525
|
+
|
|
526
|
+
合同组由<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>等接口创建。
|
|
518
527
|
*/
|
|
519
528
|
FlowGroupId?: string
|
|
520
529
|
/**
|
|
@@ -936,68 +945,78 @@ export interface BaseFlowInfo {
|
|
|
936
945
|
}
|
|
937
946
|
|
|
938
947
|
/**
|
|
939
|
-
*
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
948
|
+
* 解除协议的签署人,如不指定,默认使用待解除流程(原流程)中的签署人。</br>
|
|
949
|
+
`注意`:
|
|
950
|
+
- 不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该签署人。
|
|
951
|
+
- 目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
|
|
952
|
+
- 当指定C端签署人的签署方自定义控件别名不空时,除参数ApproverNumber外,可以只传参数ApproverSignRole。
|
|
943
953
|
|
|
944
|
-
如果需要指定B
|
|
945
|
-
ApproverNumber
|
|
946
|
-
|
|
947
|
-
-
|
|
948
|
-
-
|
|
954
|
+
如果需要指定B端(企业身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
|
955
|
+
`ApproverNumber`, `OrganizationName`, `ApproverType`必传。</br>
|
|
956
|
+
对于其他身份标识:
|
|
957
|
+
- **子客企业指定经办人**:OpenId必传,OrganizationOpenId必传;
|
|
958
|
+
- **非子客企业经办人**:Name、Mobile必传。
|
|
949
959
|
*/
|
|
950
960
|
export interface ReleasedApprover {
|
|
951
961
|
/**
|
|
952
|
-
*
|
|
953
|
-
|
|
954
|
-
OrganizationName: string
|
|
955
|
-
/**
|
|
956
|
-
* 签署人在原流程中的签署人列表中的顺序序号(从0开始,按顺序依次递增),如果不清楚原流程中的签署人列表,可以通过DescribeFlows接口查看
|
|
962
|
+
* 签署人在原合同签署人列表中的顺序序号(从0开始,按顺序依次递增)。</br>
|
|
963
|
+
可以通过<a href="https://qian.tencent.com/developers/partnerApis/flows/DescribeFlowDetailInfo" target="_blank">DescribeFlowDetailInfo</a>接口查看原流程中的签署人列表。
|
|
957
964
|
*/
|
|
958
965
|
ApproverNumber: number
|
|
959
966
|
/**
|
|
960
|
-
*
|
|
961
|
-
ORGANIZATION
|
|
962
|
-
ENTERPRISESERVER
|
|
967
|
+
* 指定签署人类型,目前支持
|
|
968
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
969
|
+
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
963
970
|
*/
|
|
964
971
|
ApproverType: string
|
|
965
972
|
/**
|
|
966
|
-
* 签署人姓名,最大长度50
|
|
973
|
+
* 签署人姓名,最大长度50个字。
|
|
967
974
|
*/
|
|
968
975
|
Name?: string
|
|
969
976
|
/**
|
|
970
|
-
*
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
977
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
978
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
979
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
980
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
974
981
|
*/
|
|
975
982
|
IdCardType?: string
|
|
976
983
|
/**
|
|
977
|
-
*
|
|
984
|
+
* 证件号码,应符合以下规则
|
|
985
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
986
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
987
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
978
988
|
*/
|
|
979
989
|
IdCardNumber?: string
|
|
980
990
|
/**
|
|
981
|
-
*
|
|
991
|
+
* 签署人手机号。
|
|
982
992
|
*/
|
|
983
993
|
Mobile?: string
|
|
984
994
|
/**
|
|
985
|
-
*
|
|
995
|
+
* 组织机构名称。
|
|
996
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
997
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
998
|
+
如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
|
|
999
|
+
*/
|
|
1000
|
+
OrganizationName?: string
|
|
1001
|
+
/**
|
|
1002
|
+
* 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>。</br>
|
|
1003
|
+
当为子客企业指定经办人时,此OrganizationOpenId必传。
|
|
986
1004
|
*/
|
|
987
1005
|
OrganizationOpenId?: string
|
|
988
1006
|
/**
|
|
989
|
-
*
|
|
990
|
-
|
|
1007
|
+
* 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成。</br>
|
|
1008
|
+
当签署方为同一第三方平台下的员工时,此OpenId必传。
|
|
991
1009
|
*/
|
|
992
1010
|
OpenId?: string
|
|
993
1011
|
/**
|
|
994
|
-
*
|
|
995
|
-
|
|
996
|
-
|
|
1012
|
+
* 签署控件类型,支持自定义企业签署方的签署控件类型
|
|
1013
|
+
<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
|
1014
|
+
<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
|
997
1015
|
*/
|
|
998
1016
|
ApproverSignComponentType?: string
|
|
999
1017
|
/**
|
|
1000
|
-
*
|
|
1018
|
+
* 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。</br>
|
|
1019
|
+
如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
|
|
1001
1020
|
*/
|
|
1002
1021
|
ApproverSignRole?: string
|
|
1003
1022
|
}
|
|
@@ -1707,25 +1726,26 @@ export interface ChannelCreateFlowByFilesResponse {
|
|
|
1707
1726
|
*/
|
|
1708
1727
|
export interface DescribeFlowDetailInfoResponse {
|
|
1709
1728
|
/**
|
|
1710
|
-
*
|
|
1729
|
+
* 合同归属的第三方平台应用号ID
|
|
1711
1730
|
*/
|
|
1712
1731
|
ApplicationId?: string
|
|
1713
1732
|
/**
|
|
1714
|
-
*
|
|
1733
|
+
* 合同归属的第三方平台子客企业OpenId
|
|
1715
1734
|
*/
|
|
1716
1735
|
ProxyOrganizationOpenId?: string
|
|
1717
1736
|
/**
|
|
1718
|
-
*
|
|
1737
|
+
* 合同流程的详细信息。
|
|
1738
|
+
如果查询的是合同组信息,则返回的是组内所有子合同流程的详细信息。
|
|
1719
1739
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1720
1740
|
*/
|
|
1721
1741
|
FlowInfo?: Array<FlowDetailInfo>
|
|
1722
1742
|
/**
|
|
1723
|
-
*
|
|
1743
|
+
* 合同组ID,只有在查询合同组信息时才会返回。
|
|
1724
1744
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1725
1745
|
*/
|
|
1726
1746
|
FlowGroupId?: string
|
|
1727
1747
|
/**
|
|
1728
|
-
*
|
|
1748
|
+
* 合同组名称,只有在查询合同组信息时才会返回。
|
|
1729
1749
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1730
1750
|
*/
|
|
1731
1751
|
FlowGroupName?: string
|
|
@@ -3662,15 +3682,25 @@ export interface ChannelDeleteRoleUsersResponse {
|
|
|
3662
3682
|
*/
|
|
3663
3683
|
export interface SyncProxyOrganizationOperatorsRequest {
|
|
3664
3684
|
/**
|
|
3665
|
-
*
|
|
3685
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3686
|
+
|
|
3687
|
+
此接口下面信息必填。
|
|
3688
|
+
<ul>
|
|
3689
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3690
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3691
|
+
</ul>
|
|
3692
|
+
第三方平台子客企业必须已经经过实名认证
|
|
3666
3693
|
*/
|
|
3667
3694
|
Agent: Agent
|
|
3668
3695
|
/**
|
|
3669
|
-
*
|
|
3696
|
+
* 操作类型,对应的操作
|
|
3697
|
+
<ul><li> **CREATE** :新增员工</li>
|
|
3698
|
+
<li> **UPDATE** :修改员工</li>
|
|
3699
|
+
<li> **RESIGN** :离职员工</li></ul>
|
|
3670
3700
|
*/
|
|
3671
3701
|
OperatorType: string
|
|
3672
3702
|
/**
|
|
3673
|
-
*
|
|
3703
|
+
* 员工信息列表,最多支持200个
|
|
3674
3704
|
*/
|
|
3675
3705
|
ProxyOrganizationOperators: Array<ProxyOrganizationOperator>
|
|
3676
3706
|
/**
|
|
@@ -4256,56 +4286,58 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4256
4286
|
*/
|
|
4257
4287
|
export interface FlowDetailInfo {
|
|
4258
4288
|
/**
|
|
4259
|
-
*
|
|
4289
|
+
* 合同流程ID,为32位字符串。
|
|
4260
4290
|
*/
|
|
4261
|
-
FlowId
|
|
4291
|
+
FlowId?: string
|
|
4262
4292
|
/**
|
|
4263
|
-
*
|
|
4293
|
+
* 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
4264
4294
|
*/
|
|
4265
|
-
FlowName
|
|
4295
|
+
FlowName?: string
|
|
4266
4296
|
/**
|
|
4267
|
-
*
|
|
4297
|
+
* 合同流程的类别分类(如销售合同/入职合同等)。
|
|
4268
4298
|
*/
|
|
4269
|
-
FlowType
|
|
4299
|
+
FlowType?: string
|
|
4270
4300
|
/**
|
|
4271
|
-
*
|
|
4272
|
-
|
|
4273
|
-
|
|
4274
|
-
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4278
|
-
|
|
4279
|
-
RELIEVED 解除协议(已解除)
|
|
4301
|
+
* 合同流程当前的签署状态, 会存在下列的状态值
|
|
4302
|
+
<ul><li> **INIT** :合同创建</li>
|
|
4303
|
+
<li> **PART** :合同签署中(至少有一个签署方已经签署)</li>
|
|
4304
|
+
<li> **REJECT** :合同拒签</li>
|
|
4305
|
+
<li> **ALL** :合同签署完成</li>
|
|
4306
|
+
<li> **DEADLINE** :合同流签(合同过期)</li>
|
|
4307
|
+
<li> **CANCEL** :合同撤回</li>
|
|
4308
|
+
<li> **RELIEVED** :解除协议(已解除)</li></ul>
|
|
4280
4309
|
|
|
4281
4310
|
*/
|
|
4282
|
-
FlowStatus
|
|
4311
|
+
FlowStatus?: string
|
|
4283
4312
|
/**
|
|
4284
|
-
*
|
|
4313
|
+
* 当合同流程状态为已拒签(即 FlowStatus=REJECT)或已撤销(即 FlowStatus=CANCEL )时,此字段 FlowMessage 为拒签或撤销原因。
|
|
4285
4314
|
*/
|
|
4286
|
-
FlowMessage
|
|
4315
|
+
FlowMessage?: string
|
|
4287
4316
|
/**
|
|
4288
|
-
*
|
|
4317
|
+
* 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
|
|
4289
4318
|
*/
|
|
4290
|
-
CreateOn
|
|
4319
|
+
CreateOn?: number
|
|
4291
4320
|
/**
|
|
4292
|
-
*
|
|
4321
|
+
* 签署流程的签署截止时间, 值为unix时间戳, 精确到秒。
|
|
4293
4322
|
*/
|
|
4294
|
-
DeadLine
|
|
4323
|
+
DeadLine?: number
|
|
4295
4324
|
/**
|
|
4296
|
-
*
|
|
4325
|
+
* 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 1000长度。
|
|
4326
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
4297
4327
|
*/
|
|
4298
|
-
CustomData
|
|
4328
|
+
CustomData?: string
|
|
4299
4329
|
/**
|
|
4300
|
-
*
|
|
4330
|
+
* 合同流程的签署方数组
|
|
4301
4331
|
*/
|
|
4302
|
-
FlowApproverInfos
|
|
4332
|
+
FlowApproverInfos?: Array<FlowApproverDetail>
|
|
4303
4333
|
/**
|
|
4304
|
-
*
|
|
4334
|
+
* 合同流程的关注方信息数组
|
|
4305
4335
|
*/
|
|
4306
4336
|
CcInfos?: Array<FlowApproverDetail>
|
|
4307
4337
|
/**
|
|
4308
|
-
*
|
|
4338
|
+
* 是否需要发起前审批
|
|
4339
|
+
<ul><li>当NeedCreateReview为true,表明当前流程是需要发起前审核的合同,可能无法进行查看,签署操作,需要等审核完成后,才可以继续后续流程</li>
|
|
4340
|
+
<li>当NeedCreateReview为false,不需要发起前审核的合同</li></ul>
|
|
4309
4341
|
*/
|
|
4310
4342
|
NeedCreateReview?: boolean
|
|
4311
4343
|
}
|
|
@@ -4387,14 +4419,15 @@ export interface ChannelCreateRoleResponse {
|
|
|
4387
4419
|
*/
|
|
4388
4420
|
export interface SyncProxyOrganizationOperatorsResponse {
|
|
4389
4421
|
/**
|
|
4390
|
-
*
|
|
4391
|
-
|
|
4392
|
-
|
|
4422
|
+
* 同步的状态, 全部同步失败接口是接口会直接报错
|
|
4423
|
+
|
|
4424
|
+
<ul><li> **1** :全部成功</li>
|
|
4425
|
+
<li> **2** :部分成功</li></ul>
|
|
4393
4426
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4394
4427
|
*/
|
|
4395
4428
|
Status?: number
|
|
4396
4429
|
/**
|
|
4397
|
-
*
|
|
4430
|
+
* 同步失败员工ID及其失败原因
|
|
4398
4431
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4399
4432
|
*/
|
|
4400
4433
|
FailedList?: Array<SyncFailReason>
|
|
@@ -4996,22 +5029,24 @@ export interface ApproverOption {
|
|
|
4996
5029
|
}
|
|
4997
5030
|
|
|
4998
5031
|
/**
|
|
4999
|
-
*
|
|
5032
|
+
* 同步的员工的信息
|
|
5000
5033
|
*/
|
|
5001
5034
|
export interface ProxyOrganizationOperator {
|
|
5002
5035
|
/**
|
|
5003
|
-
*
|
|
5036
|
+
* 员工的唯一标识(即OpenId), 定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
|
|
5004
5037
|
*/
|
|
5005
5038
|
Id: string
|
|
5006
5039
|
/**
|
|
5007
|
-
*
|
|
5040
|
+
* 员工的姓名,最大长度50个字符
|
|
5041
|
+
员工的姓名将用于身份认证和电子签名,请确保填写的姓名为真实姓名,而非昵称等代名。
|
|
5008
5042
|
*/
|
|
5009
5043
|
Name?: string
|
|
5010
5044
|
/**
|
|
5011
|
-
*
|
|
5012
|
-
|
|
5013
|
-
|
|
5014
|
-
|
|
5045
|
+
* 签署方经办人的证件类型,支持以下类型
|
|
5046
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
5047
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
5048
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
|
|
5049
|
+
|
|
5015
5050
|
*/
|
|
5016
5051
|
IdCardType?: string
|
|
5017
5052
|
/**
|
|
@@ -5019,14 +5054,12 @@ export interface ProxyOrganizationOperator {
|
|
|
5019
5054
|
*/
|
|
5020
5055
|
IdCardNumber?: string
|
|
5021
5056
|
/**
|
|
5022
|
-
*
|
|
5057
|
+
* 员工的手机号,支持国内手机号11位数字(无需加+86前缀或其他字符),不支持海外手机号。
|
|
5023
5058
|
*/
|
|
5024
5059
|
Mobile?: string
|
|
5025
5060
|
/**
|
|
5026
|
-
*
|
|
5027
|
-
|
|
5028
|
-
经办人:channel-normal-operator
|
|
5029
|
-
业务员:channel-sales-man
|
|
5061
|
+
* 预先分配员工的角色, 可以分配的角色如下:
|
|
5062
|
+
<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>
|
|
5030
5063
|
*/
|
|
5031
5064
|
DefaultRole?: string
|
|
5032
5065
|
}
|
|
@@ -5989,19 +6022,18 @@ export interface CreateChannelFlowEvidenceReportResponse {
|
|
|
5989
6022
|
}
|
|
5990
6023
|
|
|
5991
6024
|
/**
|
|
5992
|
-
*
|
|
6025
|
+
* 同步员工失败原因
|
|
5993
6026
|
*/
|
|
5994
6027
|
export interface SyncFailReason {
|
|
5995
6028
|
/**
|
|
5996
|
-
*
|
|
6029
|
+
* 企业员工标识(即OpenId)
|
|
5997
6030
|
*/
|
|
5998
|
-
Id
|
|
6031
|
+
Id?: string
|
|
5999
6032
|
/**
|
|
6000
|
-
*
|
|
6001
|
-
例如:Id不符合规范、证件号码不合法等
|
|
6033
|
+
* 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
|
|
6002
6034
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6003
6035
|
*/
|
|
6004
|
-
Message
|
|
6036
|
+
Message?: string
|
|
6005
6037
|
}
|
|
6006
6038
|
|
|
6007
6039
|
/**
|
|
@@ -576,8 +576,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
576
576
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
577
577
|
|
|
578
578
|
注:
|
|
579
|
-
1.
|
|
580
|
-
2.
|
|
579
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
580
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
|
|
581
581
|
```
|
|
582
582
|
HttpProfile httpProfile = new HttpProfile();
|
|
583
583
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -700,7 +700,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
700
700
|
CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
|
|
701
701
|
/**
|
|
702
702
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
703
|
-
|
|
703
|
+
|
|
704
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
705
|
+
|
|
706
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
707
|
+
|
|
708
|
+

|
|
709
|
+
|
|
710
|
+
**注**:
|
|
711
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
712
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
713
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
704
714
|
*/
|
|
705
715
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
706
716
|
/**
|
|
@@ -803,8 +813,12 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
803
813
|
*/
|
|
804
814
|
ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
|
|
805
815
|
/**
|
|
806
|
-
|
|
807
|
-
|
|
816
|
+
* 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
|
|
817
|
+
|
|
818
|
+
适用场景:可用于主动查询某个合同或者合同组的详情信息。
|
|
819
|
+
|
|
820
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
821
|
+
*/
|
|
808
822
|
DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
|
|
809
823
|
/**
|
|
810
824
|
* 获取个人用户自动签的开通链接。
|
|
@@ -691,8 +691,8 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
691
691
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelCreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
692
692
|
|
|
693
693
|
注:
|
|
694
|
-
1.
|
|
695
|
-
2.
|
|
694
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
695
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
|
|
696
696
|
```
|
|
697
697
|
HttpProfile httpProfile = new HttpProfile();
|
|
698
698
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -825,7 +825,17 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
825
825
|
}
|
|
826
826
|
/**
|
|
827
827
|
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
828
|
-
|
|
828
|
+
|
|
829
|
+
- **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
830
|
+
|
|
831
|
+
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
832
|
+
|
|
833
|
+

|
|
834
|
+
|
|
835
|
+
**注**:
|
|
836
|
+
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
837
|
+
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
838
|
+
- 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
829
839
|
*/
|
|
830
840
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
831
841
|
return this.request("SyncProxyOrganizationOperators", req, cb);
|
|
@@ -940,8 +950,12 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
940
950
|
return this.request("ChannelCreateEmbedWebUrl", req, cb);
|
|
941
951
|
}
|
|
942
952
|
/**
|
|
943
|
-
|
|
944
|
-
|
|
953
|
+
* 此接口用于查询合同或者合同组的详情信息,支持查询多个(数量不能超过100)。
|
|
954
|
+
|
|
955
|
+
适用场景:可用于主动查询某个合同或者合同组的详情信息。
|
|
956
|
+
|
|
957
|
+
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
|
958
|
+
*/
|
|
945
959
|
async DescribeFlowDetailInfo(req, cb) {
|
|
946
960
|
return this.request("DescribeFlowDetailInfo", req, cb);
|
|
947
961
|
}
|