tencentcloud-sdk-nodejs-essbasic 4.0.372 → 4.0.375

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.
@@ -28,72 +28,79 @@ export interface SyncProxyOrganizationResponse {
28
28
  RequestId?: string;
29
29
  }
30
30
  /**
31
- * 创建流程签署人入参
31
+ * 创建签署流程签署人入参
32
32
  */
33
33
  export interface FlowApproverInfo {
34
34
  /**
35
- * 签署人姓名
35
+ * 签署人姓名,最大长度50个字符
36
36
  */
37
37
  Name?: string;
38
38
  /**
39
- * 经办人身份证号
39
+ * 经办人身份证件类型
40
+ 1.ID_CARD 居民身份证
41
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
42
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
43
+ */
44
+ IdCardType?: string;
45
+ /**
46
+ * 经办人证件号
40
47
  */
41
48
  IdCardNumber?: string;
42
49
  /**
43
- * 签署人手机号,脱敏显示
50
+ * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
44
51
  */
45
52
  Mobile?: string;
46
53
  /**
47
- * 签署完前端跳转的url,暂未使用
54
+ * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
48
55
  */
49
- JumpUrl?: string;
56
+ OrganizationName?: string;
57
+ /**
58
+ * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
59
+ 默认为false,即签署人位于同一个渠道应用号下;
60
+ */
61
+ NotChannelOrganization?: boolean;
50
62
  /**
51
- * 签署截止时间
63
+ * 用户侧第三方id,最大长度64个字符
52
64
  */
53
- Deadline?: number;
65
+ OpenId?: string;
54
66
  /**
55
- * 签署完回调url
67
+ * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
56
68
  */
57
- CallbackUrl?: string;
69
+ OrganizationOpenId?: string;
58
70
  /**
59
71
  * 签署人类型,PERSON-个人;ORGANIZATION-企业;
60
72
  ENTERPRISESERVER-企业静默签;
61
- 注:ENTERPRISESERVER 类型仅用于使用文件创建流程(ChannelCreateFlowByFiles)接口;并且仅能指定发起方企业签署方为静默签署;
73
+ 注:ENTERPRISESERVER 类型仅用于使用文件创建签署流程(ChannelCreateFlowByFiles)接口;并且仅能指定发起方企业签署方为静默签署;
62
74
  */
63
75
  ApproverType?: string;
64
76
  /**
65
- * 用户侧第三方id
77
+ * 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
66
78
  */
67
- OpenId?: string;
79
+ RecipientId?: string;
68
80
  /**
69
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
81
+ * 签署截止时间,默认一年
70
82
  */
71
- PreReadTime?: number;
83
+ Deadline?: number;
72
84
  /**
73
- * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
85
+ * 签署完回调url,最大长度1000个字符
74
86
  */
75
- ComponentLimitType?: Array<string>;
87
+ CallbackUrl?: string;
76
88
  /**
77
- * 流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在流程中的位置;
89
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件
78
90
  */
79
- RecipientId?: string;
91
+ SignComponents?: Array<Component>;
80
92
  /**
81
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传;
93
+ * 个人签署方指定签署控件类型,目前仅支持:OCR_ESIGN(AI智慧手写签名)
82
94
  */
83
- OrganizationName?: string;
95
+ ComponentLimitType?: Array<string>;
84
96
  /**
85
- * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传;
97
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
86
98
  */
87
- OrganizationOpenId?: string;
88
- /**
89
- * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
90
- 默认为false,即签署人位于同一个渠道应用号下;
91
- */
92
- NotChannelOrganization?: boolean;
99
+ PreReadTime?: number;
93
100
  /**
94
- * 使用PDF文件直接发起合同时,签署人指定的签署控件
101
+ * 签署完前端跳转的url,暂未使用
95
102
  */
96
- SignComponents?: Array<Component>;
103
+ JumpUrl?: string;
97
104
  }
98
105
  /**
99
106
  * PrepareFlows返回参数结构体
@@ -113,27 +120,26 @@ export interface PrepareFlowsResponse {
113
120
  */
114
121
  export interface ProxyOrganizationOperator {
115
122
  /**
116
- * 经办人ID(渠道颁发)
123
+ * 经办人ID(渠道颁发),最大长度64个字符
117
124
  */
118
125
  Id: string;
119
126
  /**
120
- * 经办人姓名
127
+ * 经办人姓名,最大长度50个字符
121
128
  */
122
129
  Name?: string;
123
130
  /**
124
131
  * 经办人身份证件类型
125
- 用户证件类型:默认ID_CARD
126
- 1. ID_CARD - 居民身份证
127
- 2. HOUSEHOLD_REGISTER - 户口本
128
- 3. TEMP_ID_CARD - 临时居民身份证
132
+ 1.ID_CARD 居民身份证
133
+ 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
134
+ 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
129
135
  */
130
136
  IdCardType?: string;
131
137
  /**
132
- * 经办人身份证号
138
+ * 经办人证件号
133
139
  */
134
140
  IdCardNumber?: string;
135
141
  /**
136
- * 经办人手机号
142
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
137
143
  */
138
144
  Mobile?: string;
139
145
  }
@@ -162,25 +168,25 @@ export interface TemplateInfo {
162
168
  */
163
169
  SignComponents: Array<Component>;
164
170
  /**
165
- * 模板的创建者信息
166
- */
167
- Creator: string;
168
- /**
169
- * 模板创建的时间戳(精确到秒)
171
+ * 模板中的流程参与人信息
170
172
  */
171
- CreatedOn: number;
173
+ Recipients: Array<Recipient>;
172
174
  /**
173
175
  * 模板类型:1-静默签;2-静默签授权;3-普通模板
174
176
  */
175
177
  TemplateType: number;
176
- /**
177
- * 模板中的流程参与人信息
178
- */
179
- Recipients: Array<Recipient>;
180
178
  /**
181
179
  * 是否是发起人
182
180
  */
183
181
  IsPromoter: boolean;
182
+ /**
183
+ * 模板的创建者信息
184
+ */
185
+ Creator: string;
186
+ /**
187
+ * 模板创建的时间戳(精确到秒)
188
+ */
189
+ CreatedOn: number;
184
190
  }
185
191
  /**
186
192
  * GetDownloadFlowUrl返回参数结构体
@@ -200,7 +206,7 @@ export interface GetDownloadFlowUrlResponse {
200
206
  */
201
207
  export interface DescribeResourceUrlsByFlowsResponse {
202
208
  /**
203
- * 流程资源对应链接信息
209
+ * 签署流程资源对应链接信息
204
210
  */
205
211
  FlowResourceUrlInfos: Array<FlowResourceUrlInfo>;
206
212
  /**
@@ -340,25 +346,25 @@ export interface CreateSignUrlsRequest {
340
346
  */
341
347
  Agent: Agent;
342
348
  /**
343
- * 所签署合同ID数组
349
+ * 签署流程编号数组,最多支持100个。
344
350
  */
345
351
  FlowIds: Array<string>;
346
352
  /**
347
- * 操作者的信息
348
- */
349
- Operator?: UserInfo;
350
- /**
351
- * 签署链接类型,默认:“WEIXINAPP”-直接跳小程序; “CHANNEL”-跳转H5页面; “APP”-第三方APP或小程序跳转电子签小程序;
353
+ * 签署链接类型:“WEIXINAPP”-直接跳小程序;“CHANNEL”-跳转H5页面;“APP”-第三方APP或小程序跳转电子签小程序;默认“WEIXINAPP”类型,即跳转至小程序。
352
354
  */
353
355
  Endpoint?: string;
354
356
  /**
355
- * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效
357
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效,最大长度1000个字符。
356
358
  */
357
359
  JumpUrl?: string;
358
360
  /**
359
361
  * Endpoint为"APP" 类型的签署链接,可以设置此值;支持调用方小程序打开签署链接,在电子签小程序完成签署后自动回跳至调用方小程序
360
362
  */
361
363
  AutoJumpBack?: boolean;
364
+ /**
365
+ * 操作者的信息
366
+ */
367
+ Operator?: UserInfo;
362
368
  }
363
369
  /**
364
370
  * ChannelCreateMultiFlowSignQRCode请求参数结构体
@@ -374,15 +380,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
374
380
  */
375
381
  TemplateId: string;
376
382
  /**
377
- * 合同名称
383
+ * 签署流程名称,最大长度200个字符。
378
384
  */
379
385
  FlowName: string;
380
386
  /**
381
- * 用户信息
387
+ * 最大可发起签署流程份数,默认5份;发起签署流程数量超过此上限后,二维码自动失效。
382
388
  */
383
- Operator?: UserInfo;
389
+ MaxFlowNum?: number;
384
390
  /**
385
- * 合同有效天数 默认7天 最高设置不超过30天
391
+ * 签署流程有效天数 默认7天 最高设置不超过30天
386
392
  */
387
393
  FlowEffectiveDay?: number;
388
394
  /**
@@ -390,13 +396,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
390
396
  */
391
397
  QrEffectiveDay?: number;
392
398
  /**
393
- * 最大合同份数,默认5份 超过此上限 二维码自动失效
394
- */
395
- MaxFlowNum?: number;
399
+ * 回调地址,最大长度1000个字符
400
+ 不传默认使用渠道应用号配置的回调地址
401
+ 回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
402
+ */
403
+ CallbackUrl?: string;
396
404
  /**
397
- * 回调地址
405
+ * 用户信息
398
406
  */
399
- CallbackUrl?: string;
407
+ Operator?: UserInfo;
400
408
  }
401
409
  /**
402
410
  * 授权出错信息
@@ -420,7 +428,7 @@ export interface DescribeFlowDetailInfoRequest {
420
428
  */
421
429
  Agent: Agent;
422
430
  /**
423
- * 合同(流程)编号数组
431
+ * 合同(流程)编号数组,最多支持100个。
424
432
  */
425
433
  FlowIds: Array<string>;
426
434
  /**
@@ -449,16 +457,16 @@ export interface SignQrCode {
449
457
  * UploadFiles请求参数结构体
450
458
  */
451
459
  export interface UploadFilesRequest {
460
+ /**
461
+ * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
462
+ */
463
+ Agent: Agent;
452
464
  /**
453
465
  * 文件对应业务类型,用于区分文件存储路径:
454
466
  1. TEMPLATE - 模板; 文件类型:.pdf
455
467
  2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.jpg/.png
456
468
  */
457
469
  BusinessType: string;
458
- /**
459
- * 应用相关信息,若是渠道版调用 appid 和proxyappid 必填
460
- */
461
- Agent: Agent;
462
470
  /**
463
471
  * 上传文件内容数组,最多支持20个文件
464
472
  */
@@ -478,13 +486,13 @@ export interface DescribeResourceUrlsByFlowsRequest {
478
486
  */
479
487
  Agent: Agent;
480
488
  /**
481
- * 操作者的信息
489
+ * 查询资源所对应的签署流程Id,最多支持50个。
482
490
  */
483
- Operator?: UserInfo;
491
+ FlowIds?: Array<string>;
484
492
  /**
485
- * 查询资源所对应的流程Id
493
+ * 操作者的信息
486
494
  */
487
- FlowIds?: Array<string>;
495
+ Operator?: UserInfo;
488
496
  }
489
497
  /**
490
498
  * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
@@ -530,7 +538,7 @@ export interface Component {
530
538
  */
531
539
  ComponentType?: string;
532
540
  /**
533
- * 控件简称
541
+ * 控件简称,不能超过30个字符
534
542
  */
535
543
  ComponentName?: string;
536
544
  /**
@@ -538,7 +546,7 @@ export interface Component {
538
546
  */
539
547
  ComponentRequired?: boolean;
540
548
  /**
541
- * 控件所属文件的序号 (文档中文件的排列序号)
549
+ * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
542
550
  */
543
551
  FileIndex?: number;
544
552
  /**
@@ -559,7 +567,7 @@ export interface Component {
559
567
  */
560
568
  ComponentHeight?: number;
561
569
  /**
562
- * 参数控件所在页码
570
+ * 参数控件所在页码,从1开始
563
571
  */
564
572
  ComponentPage?: number;
565
573
  /**
@@ -593,15 +601,15 @@ export interface Component {
593
601
  */
594
602
  DocumentId?: string;
595
603
  /**
596
- * 控件描述
604
+ * 控件描述,不能超过30个字符
597
605
  */
598
606
  ComponentDescription?: string;
599
607
  /**
600
- * 指定关键字时横坐标偏移量
608
+ * 指定关键字时横坐标偏移量,单位pt
601
609
  */
602
610
  OffsetX?: number;
603
611
  /**
604
- * 指定关键字时纵坐标偏移量
612
+ * 指定关键字时纵坐标偏移量,单位pt
605
613
  */
606
614
  OffsetY?: number;
607
615
  }
@@ -614,13 +622,13 @@ export interface GetDownloadFlowUrlRequest {
614
622
  */
615
623
  Agent: Agent;
616
624
  /**
617
- * 操作者的信息
625
+ * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
618
626
  */
619
- Operator?: UserInfo;
627
+ DownLoadFlows?: Array<DownloadFlowInfo>;
620
628
  /**
621
- * 文件夹数组,合同(流程)总数不能超过50个,一个文件夹下,不能超过20个合同(流程),
629
+ * 操作者的信息
622
630
  */
623
- DownLoadFlows?: Array<DownloadFlowInfo>;
631
+ Operator?: UserInfo;
624
632
  }
625
633
  /**
626
634
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
@@ -669,25 +677,17 @@ export interface FlowDetailInfo {
669
677
  export interface CreateConsoleLoginUrlRequest {
670
678
  /**
671
679
  * 应用信息
672
- 此接口Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
680
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
673
681
  */
674
682
  Agent: Agent;
675
683
  /**
676
- * 渠道侧合作企业名称
684
+ * 渠道侧合作企业名称,最大长度64个字符
677
685
  */
678
686
  ProxyOrganizationName: string;
679
687
  /**
680
- * 渠道侧合作企业统一社会信用代码
681
- */
682
- UniformSocialCreditCode?: string;
683
- /**
684
- * 渠道侧合作企业经办人的姓名
688
+ * 渠道侧合作企业经办人的姓名,最大长度50个字符
685
689
  */
686
690
  ProxyOperatorName?: string;
687
- /**
688
- * 操作者的信息
689
- */
690
- Operator?: UserInfo;
691
691
  /**
692
692
  * 控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"
693
693
  */
@@ -696,6 +696,14 @@ export interface CreateConsoleLoginUrlRequest {
696
696
  * 控制台指定模块Id
697
697
  */
698
698
  ModuleId?: string;
699
+ /**
700
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
701
+ */
702
+ UniformSocialCreditCode?: string;
703
+ /**
704
+ * 操作者的信息
705
+ */
706
+ Operator?: UserInfo;
699
707
  }
700
708
  /**
701
709
  * CreateFlowsByTemplates返回参数结构体
@@ -728,15 +736,15 @@ export interface CreateFlowsByTemplatesResponse {
728
736
  */
729
737
  export interface PrepareFlowsRequest {
730
738
  /**
731
- * 渠道应用相关信息
739
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
732
740
  */
733
741
  Agent: Agent;
734
742
  /**
735
- * 多个合同(流程)信息
743
+ * 多个合同(签署流程)信息,最大支持20个签署流程。
736
744
  */
737
745
  FlowInfos: Array<FlowInfo>;
738
746
  /**
739
- * 操作完成后的跳转地址
747
+ * 操作完成后的跳转地址,最大长度200
740
748
  */
741
749
  JumpUrl: string;
742
750
  /**
@@ -801,10 +809,6 @@ export interface DescribeTemplatesRequest {
801
809
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
802
810
  */
803
811
  Agent: Agent;
804
- /**
805
- * 操作者的信息
806
- */
807
- Operator?: UserInfo;
808
812
  /**
809
813
  * 模板唯一标识
810
814
  */
@@ -821,21 +825,25 @@ export interface DescribeTemplatesRequest {
821
825
  * 查询偏移位置,默认0
822
826
  */
823
827
  Offset?: number;
828
+ /**
829
+ * 操作者的信息
830
+ */
831
+ Operator?: UserInfo;
824
832
  }
825
833
  /**
826
834
  * SyncProxyOrganizationOperators请求参数结构体
827
835
  */
828
836
  export interface SyncProxyOrganizationOperatorsRequest {
829
837
  /**
830
- * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
838
+ * 渠道应用相关信息。 此接口Agent.AppId 和 Agent.ProxyOrganizationOpenId必填。
831
839
  */
832
- OperatorType: string;
840
+ Agent: Agent;
833
841
  /**
834
- * 应用信息
842
+ * 操作类型,新增:"CREATE",修改:"UPDATE",离职:"RESIGN"
835
843
  */
836
- Agent: Agent;
844
+ OperatorType: string;
837
845
  /**
838
- * 经办人信息列表
846
+ * 经办人信息列表,最大长度200
839
847
  */
840
848
  ProxyOrganizationOperators: Array<ProxyOrganizationOperator>;
841
849
  /**
@@ -866,21 +874,22 @@ export interface CreateConsoleLoginUrlResponse {
866
874
  */
867
875
  export interface CreateFlowsByTemplatesRequest {
868
876
  /**
869
- * 渠道应用相关信息
877
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
870
878
  */
871
879
  Agent: Agent;
872
880
  /**
873
- * 多个合同(流程)信息
881
+ * 多个合同(签署流程)信息,最多支持20个
874
882
  */
875
883
  FlowInfos: Array<FlowInfo>;
884
+ /**
885
+ * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
886
+ 预览链接有效期300秒;
887
+ */
888
+ NeedPreview?: boolean;
876
889
  /**
877
890
  * 操作者的信息
878
891
  */
879
892
  Operator?: UserInfo;
880
- /**
881
- * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
882
- */
883
- NeedPreview?: boolean;
884
893
  }
885
894
  /**
886
895
  * SyncProxyOrganization请求参数结构体
@@ -888,21 +897,21 @@ export interface CreateFlowsByTemplatesRequest {
888
897
  export interface SyncProxyOrganizationRequest {
889
898
  /**
890
899
  * 应用信息
891
- 此接口Agent.ProxyOrganizationOpenId必填
900
+ 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
892
901
  */
893
902
  Agent: Agent;
894
903
  /**
895
- * 渠道侧合作企业名称
904
+ * 渠道侧合作企业名称,最大长度64个字符
896
905
  */
897
906
  ProxyOrganizationName: string;
898
- /**
899
- * 渠道侧合作企业统一社会信用代码
900
- */
901
- UniformSocialCreditCode?: string;
902
907
  /**
903
908
  * 营业执照正面照(PNG或JPG) base64格式, 大小不超过5M
904
909
  */
905
910
  BusinessLicense?: string;
911
+ /**
912
+ * 渠道侧合作企业统一社会信用代码,最大长度200个字符
913
+ */
914
+ UniformSocialCreditCode?: string;
906
915
  /**
907
916
  * 操作者的信息
908
917
  */
@@ -913,11 +922,11 @@ export interface SyncProxyOrganizationRequest {
913
922
  */
914
923
  export interface CreateSealByImageRequest {
915
924
  /**
916
- * 渠道应用相关信息
925
+ * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
917
926
  */
918
927
  Agent: Agent;
919
928
  /**
920
- * 印章名称
929
+ * 印章名称,最大长度不超过30字符
921
930
  */
922
931
  SealName: string;
923
932
  /**
@@ -934,17 +943,17 @@ export interface CreateSealByImageRequest {
934
943
  */
935
944
  export interface UserInfo {
936
945
  /**
937
- * 自定义用户编号
946
+ * 用户在渠道的编号
938
947
  */
939
- CustomUserId?: string;
948
+ OpenId?: string;
940
949
  /**
941
950
  * 用户的来源渠道
942
951
  */
943
952
  Channel?: string;
944
953
  /**
945
- * 用户在渠道的编号
954
+ * 自定义用户编号
946
955
  */
947
- OpenId?: string;
956
+ CustomUserId?: string;
948
957
  /**
949
958
  * 用户真实IP
950
959
  */
@@ -981,19 +990,19 @@ export interface UsageDetail {
981
990
  */
982
991
  ProxyOrganizationOpenId: string;
983
992
  /**
984
- * 消耗量
985
- */
986
- Usage: number;
993
+ * 渠道侧合作企业名
994
+ 注意:此字段可能返回 null,表示取不到有效值。
995
+ */
996
+ ProxyOrganizationName: string;
987
997
  /**
988
998
  * 日期,当需要汇总数据时日期为空
989
999
  注意:此字段可能返回 null,表示取不到有效值。
990
1000
  */
991
1001
  Date: string;
992
1002
  /**
993
- * 渠道侧合作企业名
994
- 注意:此字段可能返回 null,表示取不到有效值。
995
- */
996
- ProxyOrganizationName: string;
1003
+ * 消耗量
1004
+ */
1005
+ Usage: number;
997
1006
  }
998
1007
  /**
999
1008
  * CreateSignUrls返回参数结构体
@@ -1020,29 +1029,29 @@ export interface OperateChannelTemplateRequest {
1020
1029
  * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
1021
1030
  */
1022
1031
  Agent: Agent;
1023
- /**
1024
- * 渠道方模板库模板唯一标识
1025
- */
1026
- TemplateId: string;
1027
1032
  /**
1028
1033
  * 操作类型,查询:"SELECT",删除:"DELETE",更新:"UPDATE"
1029
1034
  */
1030
1035
  OperateType: string;
1031
1036
  /**
1032
- * 操作者的信息
1037
+ * 渠道方模板库模板唯一标识
1033
1038
  */
1034
- Operator?: UserInfo;
1039
+ TemplateId: string;
1040
+ /**
1041
+ * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
1042
+ */
1043
+ ProxyOrganizationOpenIds?: string;
1035
1044
  /**
1036
1045
  * 模板可见性, 全部可见-"all", 部分可见-"part"
1037
1046
  */
1038
1047
  AuthTag?: string;
1039
1048
  /**
1040
- * 合作企业方第三方机构唯一标识数据,支持多个, 用","进行分隔
1049
+ * 操作者的信息
1041
1050
  */
1042
- ProxyOrganizationOpenIds?: string;
1051
+ Operator?: UserInfo;
1043
1052
  }
1044
1053
  /**
1045
- * 合同(流程)下载信息
1054
+ * 签署流程下载信息
1046
1055
  */
1047
1056
  export interface DownloadFlowInfo {
1048
1057
  /**
@@ -1050,7 +1059,7 @@ export interface DownloadFlowInfo {
1050
1059
  */
1051
1060
  FileName: string;
1052
1061
  /**
1053
- * 合同(流程)的标识数组
1062
+ * 签署流程的标识数组
1054
1063
  */
1055
1064
  FlowIdList: Array<string>;
1056
1065
  }
@@ -1095,32 +1104,32 @@ export interface DescribeUsageRequest {
1095
1104
  */
1096
1105
  Agent: Agent;
1097
1106
  /**
1098
- * 开始时间 eg:2021-03-21
1107
+ * 开始时间,例如:2021-03-21
1099
1108
  */
1100
1109
  StartDate: string;
1101
1110
  /**
1102
- * 结束时间 eg:2021-06-21
1103
- 开始时间到结束时间的区间长度小于等于90
1111
+ * 结束时间,例如:2021-06-21
1112
+ 开始时间到结束时间的区间长度小于等于90天。
1104
1113
  */
1105
1114
  EndDate: string;
1106
1115
  /**
1107
- * 操作者的信息
1108
- */
1109
- Operator?: UserInfo;
1110
- /**
1111
- * 是否汇总数据,默认不汇总
1112
- 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数
1113
- 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据
1116
+ * 是否汇总数据,默认不汇总。
1117
+ 不汇总:返回在统计区间内渠道下所有企业的每日明细,即每个企业N条数据,N为统计天数;
1118
+ 汇总:返回在统计区间内渠道下所有企业的汇总后数据,即每个企业一条数据;
1114
1119
  */
1115
1120
  NeedAggregate?: boolean;
1116
1121
  /**
1117
- * 单次返回的最多条目数量,默认为1000,且不能超过1000
1122
+ * 单次返回的最多条目数量。默认为1000,且不能超过1000
1118
1123
  */
1119
1124
  Limit?: number;
1120
1125
  /**
1121
- * 偏移量,默认是0
1126
+ * 偏移量,默认是0
1122
1127
  */
1123
1128
  Offset?: number;
1129
+ /**
1130
+ * 操作者的信息
1131
+ */
1132
+ Operator?: UserInfo;
1124
1133
  }
1125
1134
  /**
1126
1135
  * ChannelCreateFlowByFiles请求参数结构体
@@ -1131,52 +1140,56 @@ export interface ChannelCreateFlowByFilesRequest {
1131
1140
  */
1132
1141
  Agent?: Agent;
1133
1142
  /**
1134
- * 操作者的信息
1143
+ * 签署流程名称,长度不超过200个字符
1135
1144
  */
1136
- Operator?: UserInfo;
1145
+ FlowName?: string;
1146
+ /**
1147
+ * 签署流程签约方列表,最多不超过5个参与方
1148
+ */
1149
+ FlowApprovers?: Array<FlowApproverInfo>;
1137
1150
  /**
1138
1151
  * 签署文件资源Id列表,目前仅支持单个文件
1139
1152
  */
1140
1153
  FileIds?: Array<string>;
1141
1154
  /**
1142
- * 流程名称,长度不超过200个字符
1155
+ * 签署文件中的控件,如:填写控件等
1143
1156
  */
1144
- FlowName?: string;
1157
+ Components?: Array<Component>;
1145
1158
  /**
1146
- * 流程截止时间,十位数时间戳,最大值为33162419560,即3020年
1159
+ * 签署流程截止时间,十位数时间戳,最大值为33162419560,即3020年
1147
1160
  */
1148
1161
  Deadline?: number;
1149
1162
  /**
1150
- * 流程的描述,长度不超过1000个字符
1163
+ * 签署流程回调地址,长度不超过255个字符
1151
1164
  */
1152
- FlowDescription?: string;
1165
+ CallbackUrl?: string;
1153
1166
  /**
1154
- * 流程的类型,长度不超过255个字符
1167
+ * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
1155
1168
  */
1156
- FlowType?: string;
1169
+ Unordered?: boolean;
1157
1170
  /**
1158
- * 流程回调地址,长度不超过255个字符
1171
+ * 签署流程的类型,长度不超过255个字符
1159
1172
  */
1160
- CallbackUrl?: string;
1173
+ FlowType?: string;
1161
1174
  /**
1162
- * 流程签约方列表,最多不超过5个参与方
1175
+ * 签署流程的描述,长度不超过1000个字符
1163
1176
  */
1164
- FlowApprovers?: Array<FlowApproverInfo>;
1177
+ FlowDescription?: string;
1165
1178
  /**
1166
- * 合同签署顺序类型(无序签,顺序签),默认为false,即有序签署
1179
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1167
1180
  */
1168
- Unordered?: boolean;
1181
+ CustomShowMap?: string;
1169
1182
  /**
1170
- * 签署文件中的控件,如:填写控件等
1183
+ * 操作者的信息
1171
1184
  */
1172
- Components?: Array<Component>;
1185
+ Operator?: UserInfo;
1173
1186
  }
1174
1187
  /**
1175
1188
  * ChannelCreateFlowByFiles返回参数结构体
1176
1189
  */
1177
1190
  export interface ChannelCreateFlowByFilesResponse {
1178
1191
  /**
1179
- * 合同流程ID
1192
+ * 合同签署流程ID
1180
1193
  注意:此字段可能返回 null,表示取不到有效值。
1181
1194
  */
1182
1195
  FlowId: string;
@@ -1215,21 +1228,21 @@ export interface Agent {
1215
1228
  */
1216
1229
  AppId: string;
1217
1230
  /**
1218
- * 腾讯电子签颁发给渠道侧合作企业的企业ID
1219
- */
1220
- ProxyOrganizationId?: string;
1221
- /**
1222
- * 腾讯电子签颁发给渠道侧合作企业的应用ID
1231
+ * 渠道/平台合作企业的企业ID
1223
1232
  */
1224
- ProxyAppId?: string;
1233
+ ProxyOrganizationOpenId?: string;
1225
1234
  /**
1226
1235
  * 渠道/平台合作企业经办人(操作员)
1227
1236
  */
1228
1237
  ProxyOperator?: UserInfo;
1229
1238
  /**
1230
- * 渠道/平台合作企业的企业ID
1239
+ * 腾讯电子签颁发给渠道侧合作企业的应用ID
1231
1240
  */
1232
- ProxyOrganizationOpenId?: string;
1241
+ ProxyAppId?: string;
1242
+ /**
1243
+ * 腾讯电子签颁发给渠道侧合作企业的企业ID
1244
+ */
1245
+ ProxyOrganizationId?: string;
1233
1246
  }
1234
1247
  /**
1235
1248
  * 此结构 (FormField) 用于描述内容控件填充结构。
@@ -1305,11 +1318,11 @@ export interface FlowApproverDetail {
1305
1318
  ApproveType: string;
1306
1319
  }
1307
1320
  /**
1308
- * 此结构体 (FlowInfo) 用于描述流程信息。
1321
+ * 此结构体 (FlowInfo) 用于描述签署流程信息。
1309
1322
  */
1310
1323
  export interface FlowInfo {
1311
1324
  /**
1312
- * 合同名字
1325
+ * 合同名字,最大长度200个字符
1313
1326
  */
1314
1327
  FlowName: string;
1315
1328
  /**
@@ -1321,19 +1334,7 @@ export interface FlowInfo {
1321
1334
  */
1322
1335
  TemplateId?: string;
1323
1336
  /**
1324
- * 合同类型:
1325
- 1. “劳务”
1326
- 2. “销售”
1327
- 3. “租赁”
1328
- 4. “其他”
1329
- */
1330
- FlowType?: string;
1331
- /**
1332
- * 回调地址
1333
- */
1334
- CallbackUrl?: string;
1335
- /**
1336
- * 多个签署人信息,渠道侧目前不支持超过5个签署方信息
1337
+ * 多个签署人信息,最大支持50个签署方
1337
1338
  */
1338
1339
  FlowApprovers?: Array<FlowApproverInfo>;
1339
1340
  /**
@@ -1341,13 +1342,25 @@ export interface FlowInfo {
1341
1342
  */
1342
1343
  FormFields?: Array<FormField>;
1343
1344
  /**
1344
- * 合同描述
1345
+ * 回调地址,最大长度1000个字符
1346
+ */
1347
+ CallbackUrl?: string;
1348
+ /**
1349
+ * 合同类型,如:1. “劳务”;2. “销售”;3. “租赁”;4. “其他”,最大长度200个字符
1350
+ */
1351
+ FlowType?: string;
1352
+ /**
1353
+ * 合同描述,最大长度1000个字符
1345
1354
  */
1346
1355
  FlowDescription?: string;
1347
1356
  /**
1348
- * 渠道的业务信息,限制1024字符
1357
+ * 渠道的业务信息,最大长度1000个字符
1349
1358
  */
1350
1359
  CustomerData?: string;
1360
+ /**
1361
+ * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1362
+ */
1363
+ CustomShowMap?: string;
1351
1364
  /**
1352
1365
  * 被抄送人的信息列表,抄送功能暂不开放
1353
1366
  */
@@ -1425,7 +1438,7 @@ export interface SignUrlInfo {
1425
1438
  */
1426
1439
  export interface CcInfo {
1427
1440
  /**
1428
- * 被抄送人手机号
1441
+ * 被抄送人手机号,大陆11位手机号
1429
1442
  */
1430
1443
  Mobile?: string;
1431
1444
  }
@@ -1451,7 +1464,7 @@ export interface DescribeFlowDetailInfoResponse {
1451
1464
  */
1452
1465
  ProxyOrganizationOpenId: string;
1453
1466
  /**
1454
- * 合同(流程)的具体详细描述信息
1467
+ * 合同(签署流程)的具体详细描述信息
1455
1468
  注意:此字段可能返回 null,表示取不到有效值。
1456
1469
  */
1457
1470
  FlowInfo: Array<FlowDetailInfo>;