tencentcloud-sdk-nodejs-essbasic 4.0.915 → 4.0.917

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.
@@ -923,38 +923,29 @@ export interface ChannelCreatePrepareFlowResponse {
923
923
  }
924
924
 
925
925
  /**
926
- * 主题配置
926
+ * CreateBatchInitOrganizationUrl返回参数结构体
927
927
  */
928
- export interface WebThemeConfig {
928
+ export interface CreateBatchInitOrganizationUrlResponse {
929
929
  /**
930
- * 是否显示页面底部电子签logo,取值如下:
931
- <ul><li> **true**:页面底部显示电子签logo</li>
932
- <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
930
+ * 小程序路径
933
931
  */
934
- DisplaySignBrandLogo?: boolean
932
+ MiniAppPath?: string
935
933
  /**
936
- * 主题颜色:
937
- 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
938
- <br/>
934
+ * 操作长链
939
935
  */
940
- WebEmbedThemeColor?: string
936
+ OperateLongUrl?: string
941
937
  /**
942
- * 企业认证页背景图(base64图片)
943
-
938
+ * 操作短链
944
939
  */
945
- AuthenticateBackground?: string
940
+ OperateShortUrl?: string
946
941
  /**
947
- * 隐藏企业认证页面导航栏,取值如下:
948
- <ul><li> **true**:隐藏企业认证页面导航栏</li>
949
- <li> **false**:显示企业认证页面导航栏(默认)</li></ul>
942
+ * 操作二维码
950
943
  */
951
- HideAuthenticateNavigationBar?: boolean
944
+ QRCodeUrl?: string
952
945
  /**
953
- * 隐藏企业认证顶部logo,取值如下:
954
- <ul><li> **true**:隐藏企业认证顶部logo</li>
955
- <li> **false**:显示企业认证顶部logo(默认)</li></ul>
946
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
956
947
  */
957
- HideAuthenticateTopLogo?: boolean
948
+ RequestId?: string
958
949
  }
959
950
 
960
951
  /**
@@ -5392,6 +5383,17 @@ export interface ChannelDescribeBillUsageDetailResponse {
5392
5383
  RequestId?: string
5393
5384
  }
5394
5385
 
5386
+ /**
5387
+ * 意愿核身点头确认模式结果
5388
+ */
5389
+ export interface IntentionActionResult {
5390
+ /**
5391
+ * 意愿核身结果详细数据,与每段点头确认过程一一对应
5392
+ 注意:此字段可能返回 null,表示取不到有效值。
5393
+ */
5394
+ Details?: Array<IntentionActionResultDetail>
5395
+ }
5396
+
5395
5397
  /**
5396
5398
  * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
5397
5399
  */
@@ -5542,237 +5544,498 @@ export interface ChannelCreateRoleResponse {
5542
5544
  }
5543
5545
 
5544
5546
  /**
5545
- * 意愿核身点头确认模式结果
5546
- */
5547
- export interface IntentionActionResult {
5548
- /**
5549
- * 意愿核身结果详细数据,与每段点头确认过程一一对应
5550
- 注意:此字段可能返回 null,表示取不到有效值。
5551
- */
5552
- Details?: Array<IntentionActionResultDetail>
5553
- }
5547
+ * 电子文档的控件填充信息。按照控件类型进行相应的填充。
5554
5548
 
5555
- /**
5556
- * 绑定失败的用户角色信息
5557
- */
5558
- export interface FailedCreateRoleData {
5559
- /**
5560
- * 用户userId
5561
- 注意:此字段可能返回 null,表示取不到有效值。
5562
- */
5563
- UserId?: string
5564
- /**
5565
- * 角色RoleId列表
5566
- 注意:此字段可能返回 null,表示取不到有效值。
5567
- */
5568
- RoleIds?: Array<string>
5549
+ 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
5550
+ ```
5551
+ FormField输入示例:
5552
+ {
5553
+ "ComponentId": "componentId1",
5554
+ "ComponentValue": "文本内容"
5569
5555
  }
5570
-
5571
- /**
5572
- * ChannelDescribeUserAutoSignStatus请求参数结构体
5573
- */
5574
- export interface ChannelDescribeUserAutoSignStatusRequest {
5575
- /**
5576
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5577
- */
5578
- Agent: Agent
5579
- /**
5580
- * 自动签使用的场景值, 可以选择的场景值如下:
5581
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5582
- */
5583
- SceneKey: string
5584
- /**
5585
- * 要查询状态的用户信息, 包括名字,身份证等
5586
- */
5587
- UserInfo: UserThreeFactor
5588
- /**
5589
- * 执行本接口操作的员工信息。
5590
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5591
- */
5592
- Operator?: UserInfo
5556
+ ```
5557
+ 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
5558
+ ```
5559
+ FormField输入示例:
5560
+ {
5561
+ "ComponentId": "componentId1",
5562
+ "ComponentValue": "多行文本内容"
5593
5563
  }
5594
-
5595
- /**
5596
- * 流程对应资源链接信息
5597
- */
5598
- export interface FlowResourceUrlInfo {
5599
- /**
5600
- * 合同流程的ID
5601
- 注意:此字段可能返回 null,表示取不到有效值。
5602
- */
5603
- FlowId?: string
5604
- /**
5605
- * 对应的合同流程的PDF下载链接
5606
- 注意:此字段可能返回 null,表示取不到有效值。
5607
- */
5608
- ResourceUrlInfos?: Array<ResourceUrlInfo>
5564
+ ```
5565
+ 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
5566
+ ```
5567
+ FormField输入示例:
5568
+ {
5569
+ "ComponentId": "componentId1",
5570
+ "ComponentValue": "true"
5609
5571
  }
5610
-
5611
- /**
5612
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
5613
- */
5614
- export interface UploadFile {
5615
- /**
5616
- * Base64编码后的文件内容
5617
- */
5618
- FileBody: string
5619
- /**
5620
- * 文件名,最大长度不超过200字符
5621
- */
5622
- FileName?: string
5572
+ ```
5573
+ 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
5574
+ ```
5575
+ FormField输入示例:
5576
+ {
5577
+ "ComponentId": "componentId1",
5578
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
5623
5579
  }
5624
-
5625
- /**
5626
- * 扩展服务开通和授权的详细信息
5627
- */
5628
- export interface ExtentServiceAuthInfo {
5629
- /**
5630
- * 扩展服务类型
5631
- <ul>
5632
- <li>AUTO_SIGN 企业自动签(自动签署)</li>
5633
- <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
5634
- <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5635
- <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5636
- <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
5637
- <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
5638
- </ul>
5639
- */
5640
- Type?: string
5641
- /**
5642
- * 扩展服务名称
5643
- */
5644
- Name?: string
5645
- /**
5646
- * 扩展服务的开通状态
5647
- **ENABLE**:开通
5648
- **DISABLE**:未开通
5649
- */
5650
- Status?: string
5651
- /**
5652
- * 操作扩展服务的操作人第三方应用平台的用户openid
5653
- 注意:此字段可能返回 null,表示取不到有效值。
5654
- */
5655
- OperatorOpenId?: string
5656
- /**
5657
- * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5658
- 注意:此字段可能返回 null,表示取不到有效值。
5659
- */
5660
- OperateOn?: number
5580
+ ```
5581
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
5582
+ ```
5583
+ FormField输入示例:
5584
+ {
5585
+ "ComponentId": "componentId1",
5586
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
5661
5587
  }
5662
-
5663
- /**
5664
- * ChannelModifyRole返回参数结构体
5665
- */
5666
- export interface ChannelModifyRoleResponse {
5667
- /**
5668
- * 角色id
5669
- */
5670
- RoleId?: string
5671
- /**
5672
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5673
- */
5674
- RequestId?: string
5588
+ ```
5589
+ 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
5590
+ ```
5591
+ FormField输入示例:
5592
+ {
5593
+ "ComponentId": "componentId1",
5594
+ "ComponentValue": "选择的内容"
5675
5595
  }
5676
-
5677
- /**
5678
- * 此结构体 (Filter) 用于描述查询过滤条件。
5679
- */
5680
- export interface Filter {
5681
- /**
5682
- * 查询过滤条件的Key
5683
- */
5684
- Key: string
5685
- /**
5686
- * 查询过滤条件的Value列表
5687
- */
5688
- Values: Array<string>
5596
+ ```
5597
+ 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
5598
+ ```
5599
+ FormField输入示例:
5600
+ {
5601
+ "ComponentId": "componentId1",
5602
+ "ComponentValue": "2023年01月01日"
5603
+ }
5604
+ ```
5605
+ 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
5606
+ ```
5607
+ FormField输入示例:
5608
+ {
5609
+ "ComponentId": "componentId1",
5610
+ "ComponentValue": "广东省深圳市福田区"
5689
5611
  }
5612
+ ```
5613
+ 【数据表格传参说明】
5614
+ 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
5615
+ 输入示例1:
5690
5616
 
5691
- /**
5692
- * 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
5693
- */
5694
- export interface FilledComponent {
5695
- /**
5696
- * 填写控件ID
5697
- */
5698
- ComponentId?: string
5699
- /**
5700
- * 控件名称
5701
- */
5702
- ComponentName?: string
5703
- /**
5704
- * 此填写控件的填写状态
5705
- **0** : 此填写控件**未填写**
5706
- **1** : 此填写控件**已填写**
5707
- */
5708
- ComponentFillStatus?: string
5709
- /**
5710
- * 控件填写内容
5711
- */
5712
- ComponentValue?: string
5713
- /**
5714
- * 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
5617
+ ```
5618
+ {
5619
+ "headers":[
5620
+ {
5621
+ "content":"head1"
5622
+ },
5623
+ {
5624
+ "content":"head2"
5625
+ },
5626
+ {
5627
+ "content":"head3"
5628
+ }
5629
+ ],
5630
+ "rowCount":3,
5631
+ "body":{
5632
+ "cells":[
5633
+ {
5634
+ "rowStart":1,
5635
+ "rowEnd":1,
5636
+ "columnStart":1,
5637
+ "columnEnd":1,
5638
+ "content":"123"
5639
+ },
5640
+ {
5641
+ "rowStart":2,
5642
+ "rowEnd":3,
5643
+ "columnStart":1,
5644
+ "columnEnd":2,
5645
+ "content":"456"
5646
+ },
5647
+ {
5648
+ "rowStart":3,
5649
+ "rowEnd":3,
5650
+ "columnStart":3,
5651
+ "columnEnd":3,
5652
+ "content":"789"
5653
+ }
5654
+ ]
5655
+ }
5656
+ }
5715
5657
 
5716
- 注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
5717
- */
5718
- ImageUrl?: string
5658
+ ```
5659
+
5660
+ 输入示例2(表格表头宽度比例配置):
5661
+
5662
+ ```
5663
+ {
5664
+ "headers":[
5665
+ {
5666
+ "content":"head1",
5667
+ "widthPercent": 30
5668
+ },
5669
+ {
5670
+ "content":"head2",
5671
+ "widthPercent": 30
5672
+ },
5673
+ {
5674
+ "content":"head3",
5675
+ "widthPercent": 40
5676
+ }
5677
+ ],
5678
+ "rowCount":3,
5679
+ "body":{
5680
+ "cells":[
5681
+ {
5682
+ "rowStart":1,
5683
+ "rowEnd":1,
5684
+ "columnStart":1,
5685
+ "columnEnd":1,
5686
+ "content":"123"
5687
+ },
5688
+ {
5689
+ "rowStart":2,
5690
+ "rowEnd":3,
5691
+ "columnStart":1,
5692
+ "columnEnd":2,
5693
+ "content":"456"
5694
+ },
5695
+ {
5696
+ "rowStart":3,
5697
+ "rowEnd":3,
5698
+ "columnStart":3,
5699
+ "columnEnd":3,
5700
+ "content":"789"
5701
+ }
5702
+ ]
5703
+ }
5719
5704
  }
5720
5705
 
5721
- /**
5722
- * 签署方信息,如角色ID、角色名称等
5706
+ ```
5707
+
5708
+
5709
+ 输入示例3(表格设置字体加粗颜色):
5710
+
5711
+ ```
5712
+ {
5713
+ "headers":[
5714
+ {
5715
+ "content":"head1"
5716
+ },
5717
+ {
5718
+ "content":"head2"
5719
+ },
5720
+ {
5721
+ "content":"head3"
5722
+ }
5723
+ ],
5724
+ "rowCount":3,
5725
+ "body":{
5726
+ "cells":[
5727
+ {
5728
+ "rowStart":1,
5729
+ "rowEnd":1,
5730
+ "columnStart":1,
5731
+ "columnEnd":1,
5732
+ "content":"123",
5733
+ "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
5734
+ },
5735
+ {
5736
+ "rowStart":2,
5737
+ "rowEnd":3,
5738
+ "columnStart":1,
5739
+ "columnEnd":2,
5740
+ "content":"456",
5741
+ "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
5742
+ },
5743
+ {
5744
+ "rowStart":3,
5745
+ "rowEnd":3,
5746
+ "columnStart":3,
5747
+ "columnEnd":3,
5748
+ "content":"789",
5749
+ "style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
5750
+ }
5751
+ ]
5752
+ }
5753
+ }
5754
+
5755
+ ```
5756
+
5757
+ 表格参数说明
5758
+
5759
+ | 名称 | 类型 | 描述 |
5760
+ | ------------------- | ------- | ------------------------------------------------- |
5761
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
5762
+ | rowCount | Integer | 表格内容最大行数 |
5763
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
5764
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
5765
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
5766
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
5767
+ | cells.N.content | String | 单元格内容,字数不超过100 |
5768
+ | cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
5769
+
5770
+ 表格参数headers说明
5771
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
5772
+
5773
+ content String 表头单元格内容,字数不超过100
5774
+
5775
+ style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
5723
5776
  */
5724
- export interface FlowApproverItem {
5777
+ export interface FormField {
5725
5778
  /**
5726
- * 合同编号
5779
+ * 控件填充值,ComponentType和传入值格式对应关系如下:
5780
+ <ul><li> <b>TEXT</b> : 文本内容</li>
5781
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
5782
+ <li> <b>CHECK_BOX</b> : true/false</li>
5783
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
5784
+ <li> <b>SELECTOR</b> : 选项值</li>
5785
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
5786
+ <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
5787
+ <li> <b>DISTRICT </b> : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容</li>
5788
+ </ul>
5789
+
5790
+
5791
+ <b>控件值约束说明</b>:
5792
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
5793
+
5794
+ */
5795
+ ComponentValue: string
5796
+ /**
5797
+ * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
5798
+ CreateFlowsByTemplates 接口不使用此字段。
5799
+
5800
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
5727
5801
  注意:此字段可能返回 null,表示取不到有效值。
5728
5802
  */
5729
- FlowId?: string
5803
+ ComponentId?: string
5730
5804
  /**
5731
- * 签署方信息,如角色ID、角色名称等
5805
+ * 控件的名字,跟ComponentId二选一,不能全为空
5806
+
5807
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
5732
5808
  注意:此字段可能返回 null,表示取不到有效值。
5733
5809
  */
5734
- Approvers?: Array<ApproverItem>
5810
+ ComponentName?: string
5811
+ /**
5812
+ * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
5813
+ 注意:此字段可能返回 null,表示取不到有效值。
5814
+ */
5815
+ LockComponentValue?: boolean
5735
5816
  }
5736
5817
 
5737
5818
  /**
5738
- * 渠道企业信息
5819
+ * 绑定失败的用户角色信息
5739
5820
  */
5740
- export interface ChannelOrganizationInfo {
5821
+ export interface FailedCreateRoleData {
5741
5822
  /**
5742
- * 电子签平台给企业分配的ID(在不同应用下同一个企业会分配通用的ID)
5823
+ * 用户userId
5824
+ 注意:此字段可能返回 null,表示取不到有效值。
5743
5825
  */
5744
- OrganizationId?: string
5826
+ UserId?: string
5745
5827
  /**
5746
- * 第三方平台子客企业的唯一标识
5828
+ * 角色RoleId列表
5829
+ 注意:此字段可能返回 null,表示取不到有效值。
5747
5830
  */
5748
- OrganizationOpenId?: string
5831
+ RoleIds?: Array<string>
5832
+ }
5833
+
5834
+ /**
5835
+ * ChannelDescribeUserAutoSignStatus请求参数结构体
5836
+ */
5837
+ export interface ChannelDescribeUserAutoSignStatusRequest {
5749
5838
  /**
5750
- * 第三方平台子客企业名称
5839
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5751
5840
  */
5752
- OrganizationName?: string
5841
+ Agent: Agent
5753
5842
  /**
5754
- * 企业的统一社会信用代码
5843
+ * 自动签使用的场景值, 可以选择的场景值如下:
5844
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5755
5845
  */
5756
- UnifiedSocialCreditCode?: string
5846
+ SceneKey: string
5757
5847
  /**
5758
- * 企业法定代表人的姓名
5848
+ * 要查询状态的用户信息, 包括名字,身份证等
5759
5849
  */
5760
- LegalName?: string
5850
+ UserInfo: UserThreeFactor
5761
5851
  /**
5762
- * 企业法定代表人作为第三方平台子客企业员工的唯一标识
5852
+ * 执行本接口操作的员工信息。
5853
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5763
5854
  */
5764
- LegalOpenId?: string
5855
+ Operator?: UserInfo
5856
+ }
5857
+
5858
+ /**
5859
+ * 流程对应资源链接信息
5860
+ */
5861
+ export interface FlowResourceUrlInfo {
5765
5862
  /**
5766
- * 企业超级管理员的姓名
5863
+ * 合同流程的ID
5864
+ 注意:此字段可能返回 null,表示取不到有效值。
5767
5865
  */
5768
- AdminName?: string
5866
+ FlowId?: string
5769
5867
  /**
5770
- * 企业超级管理员作为第三方平台子客企业员工的唯一标识
5868
+ * 对应的合同流程的PDF下载链接
5869
+ 注意:此字段可能返回 null,表示取不到有效值。
5771
5870
  */
5772
- AdminOpenId?: string
5773
- /**
5774
- * 企业超级管理员的手机号码
5775
- **注**:`手机号码脱敏(隐藏部分用*替代)`
5871
+ ResourceUrlInfos?: Array<ResourceUrlInfo>
5872
+ }
5873
+
5874
+ /**
5875
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
5876
+ */
5877
+ export interface UploadFile {
5878
+ /**
5879
+ * Base64编码后的文件内容
5880
+ */
5881
+ FileBody: string
5882
+ /**
5883
+ * 文件名,最大长度不超过200字符
5884
+ */
5885
+ FileName?: string
5886
+ }
5887
+
5888
+ /**
5889
+ * 扩展服务开通和授权的详细信息
5890
+ */
5891
+ export interface ExtentServiceAuthInfo {
5892
+ /**
5893
+ * 扩展服务类型
5894
+ <ul>
5895
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
5896
+ <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
5897
+ <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5898
+ <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5899
+ <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
5900
+ <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
5901
+ </ul>
5902
+ */
5903
+ Type?: string
5904
+ /**
5905
+ * 扩展服务名称
5906
+ */
5907
+ Name?: string
5908
+ /**
5909
+ * 扩展服务的开通状态
5910
+ **ENABLE**:开通
5911
+ **DISABLE**:未开通
5912
+ */
5913
+ Status?: string
5914
+ /**
5915
+ * 操作扩展服务的操作人第三方应用平台的用户openid
5916
+ 注意:此字段可能返回 null,表示取不到有效值。
5917
+ */
5918
+ OperatorOpenId?: string
5919
+ /**
5920
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5921
+ 注意:此字段可能返回 null,表示取不到有效值。
5922
+ */
5923
+ OperateOn?: number
5924
+ }
5925
+
5926
+ /**
5927
+ * ChannelModifyRole返回参数结构体
5928
+ */
5929
+ export interface ChannelModifyRoleResponse {
5930
+ /**
5931
+ * 角色id
5932
+ */
5933
+ RoleId?: string
5934
+ /**
5935
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5936
+ */
5937
+ RequestId?: string
5938
+ }
5939
+
5940
+ /**
5941
+ * 此结构体 (Filter) 用于描述查询过滤条件。
5942
+ */
5943
+ export interface Filter {
5944
+ /**
5945
+ * 查询过滤条件的Key
5946
+ */
5947
+ Key: string
5948
+ /**
5949
+ * 查询过滤条件的Value列表
5950
+ */
5951
+ Values: Array<string>
5952
+ }
5953
+
5954
+ /**
5955
+ * 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
5956
+ */
5957
+ export interface FilledComponent {
5958
+ /**
5959
+ * 填写控件ID
5960
+ */
5961
+ ComponentId?: string
5962
+ /**
5963
+ * 控件名称
5964
+ */
5965
+ ComponentName?: string
5966
+ /**
5967
+ * 此填写控件的填写状态
5968
+ **0** : 此填写控件**未填写**
5969
+ **1** : 此填写控件**已填写**
5970
+ */
5971
+ ComponentFillStatus?: string
5972
+ /**
5973
+ * 控件填写内容
5974
+ */
5975
+ ComponentValue?: string
5976
+ /**
5977
+ * 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
5978
+
5979
+ 注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
5980
+ */
5981
+ ImageUrl?: string
5982
+ }
5983
+
5984
+ /**
5985
+ * 签署方信息,如角色ID、角色名称等
5986
+ */
5987
+ export interface FlowApproverItem {
5988
+ /**
5989
+ * 合同编号
5990
+ 注意:此字段可能返回 null,表示取不到有效值。
5991
+ */
5992
+ FlowId?: string
5993
+ /**
5994
+ * 签署方信息,如角色ID、角色名称等
5995
+ 注意:此字段可能返回 null,表示取不到有效值。
5996
+ */
5997
+ Approvers?: Array<ApproverItem>
5998
+ }
5999
+
6000
+ /**
6001
+ * 渠道企业信息
6002
+ */
6003
+ export interface ChannelOrganizationInfo {
6004
+ /**
6005
+ * 电子签平台给企业分配的ID(在不同应用下同一个企业会分配通用的ID)
6006
+ */
6007
+ OrganizationId?: string
6008
+ /**
6009
+ * 第三方平台子客企业的唯一标识
6010
+ */
6011
+ OrganizationOpenId?: string
6012
+ /**
6013
+ * 第三方平台子客企业名称
6014
+ */
6015
+ OrganizationName?: string
6016
+ /**
6017
+ * 企业的统一社会信用代码
6018
+ */
6019
+ UnifiedSocialCreditCode?: string
6020
+ /**
6021
+ * 企业法定代表人的姓名
6022
+ */
6023
+ LegalName?: string
6024
+ /**
6025
+ * 企业法定代表人作为第三方平台子客企业员工的唯一标识
6026
+ */
6027
+ LegalOpenId?: string
6028
+ /**
6029
+ * 企业超级管理员的姓名
6030
+ */
6031
+ AdminName?: string
6032
+ /**
6033
+ * 企业超级管理员作为第三方平台子客企业员工的唯一标识
6034
+ */
6035
+ AdminOpenId?: string
6036
+ /**
6037
+ * 企业超级管理员的手机号码
6038
+ **注**:`手机号码脱敏(隐藏部分用*替代)`
5776
6039
  */
5777
6040
  AdminMobile?: string
5778
6041
  /**
@@ -6236,6 +6499,41 @@ export interface ChannelDescribeFlowComponentsResponse {
6236
6499
  RequestId?: string
6237
6500
  }
6238
6501
 
6502
+ /**
6503
+ * 主题配置
6504
+ */
6505
+ export interface WebThemeConfig {
6506
+ /**
6507
+ * 是否显示页面底部电子签logo,取值如下:
6508
+ <ul><li> **true**:页面底部显示电子签logo</li>
6509
+ <li> **false**:页面底部不显示电子签logo(默认)</li></ul>
6510
+ */
6511
+ DisplaySignBrandLogo?: boolean
6512
+ /**
6513
+ * 主题颜色:
6514
+ 支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
6515
+ <br/>
6516
+ */
6517
+ WebEmbedThemeColor?: string
6518
+ /**
6519
+ * 企业认证页背景图(base64图片)
6520
+
6521
+ */
6522
+ AuthenticateBackground?: string
6523
+ /**
6524
+ * 隐藏企业认证页面导航栏,取值如下:
6525
+ <ul><li> **true**:隐藏企业认证页面导航栏</li>
6526
+ <li> **false**:显示企业认证页面导航栏(默认)</li></ul>
6527
+ */
6528
+ HideAuthenticateNavigationBar?: boolean
6529
+ /**
6530
+ * 隐藏企业认证顶部logo,取值如下:
6531
+ <ul><li> **true**:隐藏企业认证顶部logo</li>
6532
+ <li> **false**:显示企业认证顶部logo(默认)</li></ul>
6533
+ */
6534
+ HideAuthenticateTopLogo?: boolean
6535
+ }
6536
+
6239
6537
  /**
6240
6538
  * ChannelCreateFlowGroupByFiles返回参数结构体
6241
6539
  */
@@ -6930,275 +7228,23 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
6930
7228
  }
6931
7229
 
6932
7230
  /**
6933
- * 电子文档的控件填充信息。按照控件类型进行相应的填充。
6934
-
6935
- 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
6936
- ```
6937
- FormField输入示例:
6938
- {
6939
- "ComponentId": "componentId1",
6940
- "ComponentValue": "文本内容"
6941
- }
6942
- ```
6943
- 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
6944
- ```
6945
- FormField输入示例:
6946
- {
6947
- "ComponentId": "componentId1",
6948
- "ComponentValue": "多行文本内容"
6949
- }
6950
- ```
6951
- 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
6952
- ```
6953
- FormField输入示例:
6954
- {
6955
- "ComponentId": "componentId1",
6956
- "ComponentValue": "true"
6957
- }
6958
- ```
6959
- 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
6960
- ```
6961
- FormField输入示例:
6962
- {
6963
- "ComponentId": "componentId1",
6964
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
6965
- }
6966
- ```
6967
- 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
6968
- ```
6969
- FormField输入示例:
6970
- {
6971
- "ComponentId": "componentId1",
6972
- "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
6973
- }
6974
- ```
6975
- 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
6976
- ```
6977
- FormField输入示例:
6978
- {
6979
- "ComponentId": "componentId1",
6980
- "ComponentValue": "选择的内容"
6981
- }
6982
- ```
6983
- 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
6984
- ```
6985
- FormField输入示例:
6986
- {
6987
- "ComponentId": "componentId1",
6988
- "ComponentValue": "2023年01月01日"
6989
- }
6990
- ```
6991
- 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
6992
- ```
6993
- FormField输入示例:
6994
- {
6995
- "ComponentId": "componentId1",
6996
- "ComponentValue": "广东省深圳市福田区"
6997
- }
6998
- ```
6999
- 【数据表格传参说明】
7000
- 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
7001
- 输入示例1:
7002
-
7003
- ```
7004
- {
7005
- "headers":[
7006
- {
7007
- "content":"head1"
7008
- },
7009
- {
7010
- "content":"head2"
7011
- },
7012
- {
7013
- "content":"head3"
7014
- }
7015
- ],
7016
- "rowCount":3,
7017
- "body":{
7018
- "cells":[
7019
- {
7020
- "rowStart":1,
7021
- "rowEnd":1,
7022
- "columnStart":1,
7023
- "columnEnd":1,
7024
- "content":"123"
7025
- },
7026
- {
7027
- "rowStart":2,
7028
- "rowEnd":3,
7029
- "columnStart":1,
7030
- "columnEnd":2,
7031
- "content":"456"
7032
- },
7033
- {
7034
- "rowStart":3,
7035
- "rowEnd":3,
7036
- "columnStart":3,
7037
- "columnEnd":3,
7038
- "content":"789"
7039
- }
7040
- ]
7041
- }
7042
- }
7043
-
7044
- ```
7045
-
7046
- 输入示例2(表格表头宽度比例配置):
7047
-
7048
- ```
7049
- {
7050
- "headers":[
7051
- {
7052
- "content":"head1",
7053
- "widthPercent": 30
7054
- },
7055
- {
7056
- "content":"head2",
7057
- "widthPercent": 30
7058
- },
7059
- {
7060
- "content":"head3",
7061
- "widthPercent": 40
7062
- }
7063
- ],
7064
- "rowCount":3,
7065
- "body":{
7066
- "cells":[
7067
- {
7068
- "rowStart":1,
7069
- "rowEnd":1,
7070
- "columnStart":1,
7071
- "columnEnd":1,
7072
- "content":"123"
7073
- },
7074
- {
7075
- "rowStart":2,
7076
- "rowEnd":3,
7077
- "columnStart":1,
7078
- "columnEnd":2,
7079
- "content":"456"
7080
- },
7081
- {
7082
- "rowStart":3,
7083
- "rowEnd":3,
7084
- "columnStart":3,
7085
- "columnEnd":3,
7086
- "content":"789"
7087
- }
7088
- ]
7089
- }
7090
- }
7091
-
7092
- ```
7093
-
7094
-
7095
- 输入示例3(表格设置字体加粗颜色):
7096
-
7097
- ```
7098
- {
7099
- "headers":[
7100
- {
7101
- "content":"head1"
7102
- },
7103
- {
7104
- "content":"head2"
7105
- },
7106
- {
7107
- "content":"head3"
7108
- }
7109
- ],
7110
- "rowCount":3,
7111
- "body":{
7112
- "cells":[
7113
- {
7114
- "rowStart":1,
7115
- "rowEnd":1,
7116
- "columnStart":1,
7117
- "columnEnd":1,
7118
- "content":"123",
7119
- "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "CENTER"}
7120
- },
7121
- {
7122
- "rowStart":2,
7123
- "rowEnd":3,
7124
- "columnStart":1,
7125
- "columnEnd":2,
7126
- "content":"456",
7127
- "style": {"color": "#b50000", "fontSize": 12,"bold": true,"align": "LEFT"}
7128
- },
7129
- {
7130
- "rowStart":3,
7131
- "rowEnd":3,
7132
- "columnStart":3,
7133
- "columnEnd":3,
7134
- "content":"789",
7135
- "style": {"color": "#b500bf", "fontSize": 12,"bold": false,"align": "RIGHT"}
7136
- }
7137
- ]
7138
- }
7139
- }
7140
-
7141
- ```
7142
-
7143
- 表格参数说明
7144
-
7145
- | 名称 | 类型 | 描述 |
7146
- | ------------------- | ------- | ------------------------------------------------- |
7147
- | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
7148
- | rowCount | Integer | 表格内容最大行数 |
7149
- | cells.N.rowStart | Integer | 单元格坐标:行起始index |
7150
- | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
7151
- | cells.N.columnStart | Integer | 单元格坐标:列起始index |
7152
- | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
7153
- | cells.N.content | String | 单元格内容,字数不超过100 |
7154
- | cells.N.style | String | 单元格字体风格配置 ,风格配置的json字符串 如: {"font":"黑体","fontSize":12,"color":"#FFFFFF","bold":true,"align":"CENTER"} |
7155
-
7156
- 表格参数headers说明
7157
- widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
7158
-
7159
- content String 表头单元格内容,字数不超过100
7160
-
7161
- style String 为字体风格设置 风格支持: font : 目前支持 黑体、宋体; fontSize: 6-72; color:000000-FFFFFF 字符串形如: "#FFFFFF" 或者 "0xFFFFFF"; bold : 是否加粗, true : 加粗 false: 不加粗; align: 对其方式, 支持 LEFT / RIGHT / CENTER
7231
+ * CreateBatchInitOrganizationUrl请求参数结构体
7162
7232
  */
7163
- export interface FormField {
7164
- /**
7165
- * 控件填充值,ComponentType和传入值格式对应关系如下:
7166
- <ul><li> <b>TEXT</b> : 文本内容</li>
7167
- <li> <b>MULTI_LINE_TEXT</b> : 文本内容, 可以用 \n 来控制换行位置</li>
7168
- <li> <b>CHECK_BOX</b> : true/false</li>
7169
- <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
7170
- <li> <b>SELECTOR</b> : 选项值</li>
7171
- <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)</li>
7172
- <li> <b>DATE</b> : 格式化:xxxx年xx月xx日(例如:2024年05月28日)</li>
7173
- <li> <b>DISTRICT </b> : 省市区行政区控件,需填写ComponentValue为省市区行政区字符串内容</li>
7174
- </ul>
7175
-
7176
-
7177
- <b>控件值约束说明</b>:
7178
- <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
7179
-
7180
- */
7181
- ComponentValue: string
7233
+ export interface CreateBatchInitOrganizationUrlRequest {
7182
7234
  /**
7183
- * 表单域或控件的ID,跟ComponentName二选一,不能全为空;
7184
- CreateFlowsByTemplates 接口不使用此字段。
7185
-
7186
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
7187
- 注意:此字段可能返回 null,表示取不到有效值。
7235
+ * 应用相关信息。 此接口Agent.AppId 必填。
7188
7236
  */
7189
- ComponentId?: string
7237
+ Agent: Agent
7190
7238
  /**
7191
- * 控件的名字,跟ComponentId二选一,不能全为空
7192
-
7193
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
7194
- 注意:此字段可能返回 null,表示取不到有效值。
7239
+ * 初始化操作类型
7240
+ <ul><li>CREATE_SEAL : 创建印章</li>
7241
+ <li>OPEN_AUTO_SIGN :开通企业自动签署</li></ul>
7195
7242
  */
7196
- ComponentName?: string
7243
+ OperateTypes: Array<string>
7197
7244
  /**
7198
- * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
7199
- 注意:此字段可能返回 null,表示取不到有效值。
7245
+ * 批量操作的企业列表在第三方平台的企业Id列表,即ProxyOrganizationOpenId列表,最大支持50个
7200
7246
  */
7201
- LockComponentValue?: boolean
7247
+ ProxyOrganizationOpenIds: Array<string>
7202
7248
  }
7203
7249
 
7204
7250
  /**