tencentcloud-sdk-nodejs 4.0.761 → 4.0.763
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 +271 -0
- package/SERVICE_CHANGELOG.md +255 -128
- package/package.json +1 -1
- package/products.md +23 -23
- package/src/common/sdk_version.ts +1 -1
- package/src/services/asr/v20190614/asr_models.ts +23 -20
- package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +6 -0
- package/src/services/cls/v20201016/cls_models.ts +106 -43
- package/src/services/dlc/v20210125/dlc_models.ts +2 -2
- package/src/services/ecm/v20190719/ecm_models.ts +17 -17
- package/src/services/ess/v20201111/ess_client.ts +91 -12
- package/src/services/ess/v20201111/ess_models.ts +41 -36
- package/src/services/essbasic/v20210526/essbasic_client.ts +18 -0
- package/src/services/essbasic/v20210526/essbasic_models.ts +16 -14
- package/src/services/lcic/v20220817/lcic_models.ts +8 -4
- package/src/services/lighthouse/v20200324/lighthouse_models.ts +18 -12
- package/src/services/oceanus/v20190422/oceanus_client.ts +23 -10
- package/src/services/oceanus/v20190422/oceanus_models.ts +147 -59
- package/src/services/ocr/v20181119/ocr_client.ts +4 -1
- package/src/services/ocr/v20181119/ocr_models.ts +328 -44
- package/src/services/ssl/v20191205/ssl_models.ts +22 -2
- package/src/services/tat/v20201028/tat_models.ts +1 -1
- package/src/services/tdmq/v20200217/tdmq_client.ts +1 -2
- package/src/services/tdmq/v20200217/tdmq_models.ts +35 -44
- package/src/services/tem/v20210701/tem_client.ts +1 -1
- package/src/services/tem/v20210701/tem_models.ts +1 -1
- package/src/services/teo/v20220901/teo_models.ts +2 -2
- package/src/services/tione/v20211111/tione_client.ts +25 -11
- package/src/services/tione/v20211111/tione_models.ts +229 -33
- package/src/services/tse/v20201207/tse_models.ts +2 -2
- package/src/services/vod/v20180717/vod_client.ts +14 -1
- package/src/services/vod/v20180717/vod_models.ts +73 -6
- package/src/services/wedata/v20210820/wedata_models.ts +5 -0
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +23 -20
- package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +6 -0
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +106 -43
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +2 -2
- package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +17 -17
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +91 -12
- package/tencentcloud/services/ess/v20201111/ess_client.js +91 -12
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +41 -36
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +18 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +18 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +16 -14
- package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +8 -4
- package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +18 -12
- package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +7 -3
- package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +9 -3
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +143 -58
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +325 -44
- package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +22 -2
- package/tencentcloud/services/tat/v20201028/tat_models.d.ts +1 -1
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +1 -1
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +35 -43
- package/tencentcloud/services/tem/v20210701/tem_client.d.ts +1 -1
- package/tencentcloud/services/tem/v20210701/tem_client.js +1 -1
- package/tencentcloud/services/tem/v20210701/tem_models.d.ts +1 -1
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +2 -2
- package/tencentcloud/services/tione/v20211111/tione_client.d.ts +7 -3
- package/tencentcloud/services/tione/v20211111/tione_client.js +9 -3
- package/tencentcloud/services/tione/v20211111/tione_models.d.ts +225 -33
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +2 -2
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +5 -1
- package/tencentcloud/services/vod/v20180717/vod_client.js +6 -0
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +70 -6
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +5 -0
- package/test/oceanus.v20190422.test.js +12 -2
- package/test/tione.v20211111.test.js +12 -2
- package/test/vod.v20180717.test.js +10 -0
|
@@ -6866,71 +6866,71 @@ export interface Image {
|
|
|
6866
6866
|
/**
|
|
6867
6867
|
* 镜像ID
|
|
6868
6868
|
*/
|
|
6869
|
-
ImageId
|
|
6869
|
+
ImageId?: string
|
|
6870
6870
|
/**
|
|
6871
6871
|
* 镜像名称
|
|
6872
6872
|
*/
|
|
6873
|
-
ImageName
|
|
6873
|
+
ImageName?: string
|
|
6874
6874
|
/**
|
|
6875
6875
|
* 镜像状态
|
|
6876
6876
|
*/
|
|
6877
|
-
ImageState
|
|
6877
|
+
ImageState?: string
|
|
6878
6878
|
/**
|
|
6879
6879
|
* 镜像类型
|
|
6880
6880
|
*/
|
|
6881
|
-
ImageType
|
|
6881
|
+
ImageType?: string
|
|
6882
6882
|
/**
|
|
6883
6883
|
* 操作系统名称
|
|
6884
6884
|
*/
|
|
6885
|
-
ImageOsName
|
|
6885
|
+
ImageOsName?: string
|
|
6886
6886
|
/**
|
|
6887
6887
|
* 镜像描述
|
|
6888
6888
|
*/
|
|
6889
|
-
ImageDescription
|
|
6889
|
+
ImageDescription?: string
|
|
6890
6890
|
/**
|
|
6891
6891
|
* 镜像导入时间
|
|
6892
6892
|
*/
|
|
6893
|
-
ImageCreateTime
|
|
6893
|
+
ImageCreateTime?: string
|
|
6894
6894
|
/**
|
|
6895
6895
|
* 操作系统位数
|
|
6896
6896
|
*/
|
|
6897
|
-
Architecture
|
|
6897
|
+
Architecture?: string
|
|
6898
6898
|
/**
|
|
6899
6899
|
* 操作系统类型
|
|
6900
6900
|
*/
|
|
6901
|
-
OsType
|
|
6901
|
+
OsType?: string
|
|
6902
6902
|
/**
|
|
6903
6903
|
* 操作系统版本
|
|
6904
6904
|
*/
|
|
6905
|
-
OsVersion
|
|
6905
|
+
OsVersion?: string
|
|
6906
6906
|
/**
|
|
6907
6907
|
* 操作系统平台
|
|
6908
6908
|
*/
|
|
6909
|
-
Platform
|
|
6909
|
+
Platform?: string
|
|
6910
6910
|
/**
|
|
6911
6911
|
* 镜像所有者
|
|
6912
6912
|
*/
|
|
6913
|
-
ImageOwner
|
|
6913
|
+
ImageOwner?: number
|
|
6914
6914
|
/**
|
|
6915
6915
|
* 镜像大小。单位：GB
|
|
6916
6916
|
*/
|
|
6917
|
-
ImageSize
|
|
6917
|
+
ImageSize?: number
|
|
6918
6918
|
/**
|
|
6919
6919
|
* 镜像来源信息
|
|
6920
6920
|
*/
|
|
6921
|
-
SrcImage
|
|
6921
|
+
SrcImage?: SrcImage
|
|
6922
6922
|
/**
|
|
6923
6923
|
* 镜像来源类型
|
|
6924
6924
|
*/
|
|
6925
|
-
ImageSource
|
|
6925
|
+
ImageSource?: string
|
|
6926
6926
|
/**
|
|
6927
6927
|
* 中间态和失败时候的任务ID
|
|
6928
6928
|
*/
|
|
6929
|
-
TaskId
|
|
6929
|
+
TaskId?: string
|
|
6930
6930
|
/**
|
|
6931
6931
|
* 是否支持CloudInit
|
|
6932
6932
|
*/
|
|
6933
|
-
IsSupportCloudInit
|
|
6933
|
+
IsSupportCloudInit?: boolean
|
|
6934
6934
|
}
|
|
6935
6935
|
|
|
6936
6936
|
/**
|
|
@@ -284,7 +284,11 @@ export class Client extends AbstractClient {
|
|
|
284
284
|
* 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
285
285
|
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
|
|
286
286
|
|
|
287
|
-
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
注：
|
|
290
|
+
- **合同发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）
|
|
291
|
+
- **静默（自动）签署不支持合同签署方存在填写**功能
|
|
288
292
|
*/
|
|
289
293
|
async StartFlow(
|
|
290
294
|
req: StartFlowRequest,
|
|
@@ -550,7 +554,7 @@ export class Client extends AbstractClient {
|
|
|
550
554
|
|
|
551
555
|
注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
|
|
552
556
|
|
|
553
|
-
|
|
557
|
+
|
|
554
558
|
*/
|
|
555
559
|
async CreateDocument(
|
|
556
560
|
req: CreateDocumentRequest,
|
|
@@ -605,10 +609,39 @@ export class Client extends AbstractClient {
|
|
|
605
609
|
/**
|
|
606
610
|
* 通过模板创建签署流程<br/>
|
|
607
611
|
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
|
|
612
|
+
<table>
|
|
613
|
+
<thead>
|
|
614
|
+
<tr>
|
|
615
|
+
<th>签署人类别</th>
|
|
616
|
+
<th>需要提前准备的信息</th>
|
|
617
|
+
</tr>
|
|
618
|
+
</thead>
|
|
619
|
+
<tbody>
|
|
620
|
+
<tr>
|
|
621
|
+
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
|
|
622
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
623
|
+
</tr>
|
|
624
|
+
<tr>
|
|
625
|
+
<td>自己企业的员工签署（已认证加入）</td>
|
|
626
|
+
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
|
|
627
|
+
</tr>
|
|
628
|
+
<tr>
|
|
629
|
+
<td>其他企业的员工签署</td>
|
|
630
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
631
|
+
</tr>
|
|
632
|
+
<tr>
|
|
633
|
+
<td>个人（自然人）签署</td>
|
|
634
|
+
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
|
|
635
|
+
</tr>
|
|
636
|
+
</tbody>
|
|
637
|
+
</table>
|
|
638
|
+
|
|
608
639
|
|
|
609
640
|
注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
|
|
610
641
|
|
|
611
|
-
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
注：**静默（自动）签署不支持合同签署方存在填写**功能
|
|
612
645
|
*/
|
|
613
646
|
async CreateFlow(
|
|
614
647
|
req: CreateFlowRequest,
|
|
@@ -645,7 +678,9 @@ export class Client extends AbstractClient {
|
|
|
645
678
|
|
|
646
679
|
注：
|
|
647
680
|
`1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署`
|
|
681
|
+
|
|
648
682
|
`2. 签署链接的有效期为90天，超过有效期链接不可用`
|
|
683
|
+
|
|
649
684
|
`3. 如果需跳转详情页（即PathType值为1）进行填写或签署合同，需指定签署方信息：姓名、手机号码、企业名称等，才能生成正确的跳转链接`
|
|
650
685
|
|
|
651
686
|
其中小程序的原始Id如下，或者查看小程序信息自助获取。
|
|
@@ -678,6 +713,8 @@ export class Client extends AbstractClient {
|
|
|
678
713
|
* 此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。
|
|
679
714
|
|
|
680
715
|
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
|
|
716
|
+
|
|
717
|
+
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
681
718
|
*/
|
|
682
719
|
async CreateFlowGroupByTemplates(
|
|
683
720
|
req: CreateFlowGroupByTemplatesRequest,
|
|
@@ -710,8 +747,8 @@ export class Client extends AbstractClient {
|
|
|
710
747
|
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
711
748
|
|
|
712
749
|
注:
|
|
713
|
-
1.
|
|
714
|
-
2.
|
|
750
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
751
|
+
2. 调用此接口时需要设置单独的Domain请求域名，<font color="red">联调开发环境为: file.test.ess.tencent.cn，正式环境需要设置为:file.ess.tencent.cn</font>，代码示例
|
|
715
752
|
```
|
|
716
753
|
HttpProfile httpProfile = new HttpProfile();
|
|
717
754
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
@@ -744,9 +781,46 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
744
781
|
|
|
745
782
|
/**
|
|
746
783
|
* 此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
784
|
+
适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
|
785
|
+
|
|
786
|
+
<table>
|
|
787
|
+
<thead>
|
|
788
|
+
<tr>
|
|
789
|
+
<th>签署人类别</th>
|
|
790
|
+
<th>需要提前准备的信息</th>
|
|
791
|
+
</tr>
|
|
792
|
+
</thead>
|
|
793
|
+
<tbody>
|
|
794
|
+
<tr>
|
|
795
|
+
<td>自己企业的员工签署（未认证加入或已认证加入）</td>
|
|
796
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
797
|
+
</tr>
|
|
798
|
+
<tr>
|
|
799
|
+
<td>自己企业的员工签署（已认证加入）</td>
|
|
800
|
+
<td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
|
|
801
|
+
</tr>
|
|
802
|
+
<tr>
|
|
803
|
+
<td>其他企业的员工签署</td>
|
|
804
|
+
<td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
|
|
805
|
+
</tr>
|
|
806
|
+
<tr>
|
|
807
|
+
<td>个人（自然人）签署</td>
|
|
808
|
+
<td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
|
|
809
|
+
</tr>
|
|
810
|
+
</tbody>
|
|
811
|
+
</table>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）<br/>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
注：
|
|
821
|
+
- 不同类型的签署方传参不同, 可以参考开发者中心的ApproverInfo结构体说明
|
|
822
|
+
- 合同**发起后就会扣减合同的额度**, 如果未签署完成时撤销合同会返还此额度（**过期，拒签，签署完成，解除完成等状态不会返还额度**）
|
|
823
|
+
- **静默（自动）签署不支持合同签署方存在填写**功能
|
|
750
824
|
*/
|
|
751
825
|
async CreateFlowByFiles(
|
|
752
826
|
req: CreateFlowByFilesRequest,
|
|
@@ -986,11 +1060,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
986
1060
|
/**
|
|
987
1061
|
* 指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
|
|
988
1062
|
|
|
989
|
-
1.
|
|
990
|
-
2.
|
|
991
|
-
3.
|
|
1063
|
+
1. 发起合同时，**签署人的NotifyType需设置为sms**
|
|
1064
|
+
2. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
1065
|
+
3. **每个合同只能催办一次**
|
|
992
1066
|
|
|
993
|
-
|
|
1067
|
+
**催办的效果**: 对方会收到如下的短信通知
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
注：`合同催办是白名单功能，请联系客户经理申请开白后使用`
|
|
994
1071
|
*/
|
|
995
1072
|
async CreateFlowReminds(
|
|
996
1073
|
req: CreateFlowRemindsRequest,
|
|
@@ -1172,6 +1249,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1172
1249
|
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
|
|
1173
1250
|
|
|
1174
1251
|
注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
|
1252
|
+
|
|
1253
|
+
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
1175
1254
|
*/
|
|
1176
1255
|
async CreateFlowGroupByFiles(
|
|
1177
1256
|
req: CreateFlowGroupByFilesRequest,
|
|
@@ -1300,7 +1300,7 @@ export interface FlowApproverDetail {
|
|
|
1300
1300
|
export interface CreateFlowGroupByFilesRequest {
|
|
1301
1301
|
/**
|
|
1302
1302
|
* 执行本接口操作的员工信息。
|
|
1303
|
-
注:
|
|
1303
|
+
注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
|
|
1304
1304
|
*/
|
|
1305
1305
|
Operator: UserInfo
|
|
1306
1306
|
/**
|
|
@@ -1744,7 +1744,7 @@ export interface CreateFlowRequest {
|
|
|
1744
1744
|
CcInfos?: Array<CcInfo>
|
|
1745
1745
|
/**
|
|
1746
1746
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
1747
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
1747
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
1748
1748
|
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
1749
1749
|
*/
|
|
1750
1750
|
AutoSignScene?: string
|
|
@@ -2970,6 +2970,18 @@ export interface CreateFlowByFilesRequest {
|
|
|
2970
2970
|
如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
|
|
2971
2971
|
*/
|
|
2972
2972
|
Deadline?: number
|
|
2973
|
+
/**
|
|
2974
|
+
* 合同流程的签署顺序类型：
|
|
2975
|
+
<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
2976
|
+
<li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
2977
|
+
*/
|
|
2978
|
+
Unordered?: boolean
|
|
2979
|
+
/**
|
|
2980
|
+
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
|
|
2981
|
+
|
|
2982
|
+
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
|
2983
|
+
*/
|
|
2984
|
+
UserData?: string
|
|
2973
2985
|
/**
|
|
2974
2986
|
* 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
|
|
2975
2987
|
|
|
@@ -2977,11 +2989,17 @@ export interface CreateFlowByFilesRequest {
|
|
|
2977
2989
|
*/
|
|
2978
2990
|
RemindedOn?: number
|
|
2979
2991
|
/**
|
|
2980
|
-
*
|
|
2981
|
-
<ul><li>
|
|
2982
|
-
<li>
|
|
2992
|
+
* 指定个人签署方查看合同的校验方式
|
|
2993
|
+
<ul><li> **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容 </li>
|
|
2994
|
+
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>
|
|
2983
2995
|
*/
|
|
2984
|
-
|
|
2996
|
+
ApproverVerifyType?: string
|
|
2997
|
+
/**
|
|
2998
|
+
* 签署方签署控件（印章/签名等）的生成方式：
|
|
2999
|
+
<ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
|
|
3000
|
+
<li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
|
|
3001
|
+
*/
|
|
3002
|
+
SignBeanTag?: number
|
|
2985
3003
|
/**
|
|
2986
3004
|
* 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
|
|
2987
3005
|
<ul><li>{合同名称} </li>
|
|
@@ -3000,34 +3018,6 @@ export interface CreateFlowByFilesRequest {
|
|
|
3000
3018
|
|
|
3001
3019
|
*/
|
|
3002
3020
|
CustomShowMap?: string
|
|
3003
|
-
/**
|
|
3004
|
-
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
|
|
3005
|
-
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
|
|
3006
|
-
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
|
|
3007
|
-
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3008
|
-
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
|
|
3009
|
-
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
|
|
3010
|
-
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
|
|
3011
|
-
*/
|
|
3012
|
-
NeedSignReview?: boolean
|
|
3013
|
-
/**
|
|
3014
|
-
* 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
|
|
3015
|
-
|
|
3016
|
-
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的[回调通知](https://qian.tencent.com/developers/company/callback_types_v2)模块。
|
|
3017
|
-
*/
|
|
3018
|
-
UserData?: string
|
|
3019
|
-
/**
|
|
3020
|
-
* 指定个人签署方查看合同的校验方式
|
|
3021
|
-
<ul><li> **VerifyCheck** :（默认）人脸识别,人脸识别后才能合同内容 </li>
|
|
3022
|
-
<li> **MobileCheck** : 手机号验证, 用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）</li></ul>
|
|
3023
|
-
*/
|
|
3024
|
-
ApproverVerifyType?: string
|
|
3025
|
-
/**
|
|
3026
|
-
* 签署方签署控件（印章/签名等）的生成方式：
|
|
3027
|
-
<ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
|
|
3028
|
-
<li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
|
|
3029
|
-
*/
|
|
3030
|
-
SignBeanTag?: number
|
|
3031
3021
|
/**
|
|
3032
3022
|
* 代理企业和员工的信息。
|
|
3033
3023
|
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
|
|
@@ -3035,10 +3025,20 @@ export interface CreateFlowByFilesRequest {
|
|
|
3035
3025
|
Agent?: Agent
|
|
3036
3026
|
/**
|
|
3037
3027
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
3038
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
3028
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
3039
3029
|
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
3040
3030
|
*/
|
|
3041
3031
|
AutoSignScene?: string
|
|
3032
|
+
/**
|
|
3033
|
+
* 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
|
|
3034
|
+
<ul><li> **false**：（默认）不需要审批，直接签署。</li>
|
|
3035
|
+
<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
|
|
3036
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3037
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
|
|
3038
|
+
<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
|
|
3039
|
+
注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
|
|
3040
|
+
*/
|
|
3041
|
+
NeedSignReview?: boolean
|
|
3042
3042
|
}
|
|
3043
3043
|
|
|
3044
3044
|
/**
|
|
@@ -5522,7 +5522,7 @@ export interface GetTaskResultApiResponse {
|
|
|
5522
5522
|
*/
|
|
5523
5523
|
TaskMessage?: string
|
|
5524
5524
|
/**
|
|
5525
|
-
* 资源Id
|
|
5525
|
+
* 资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)
|
|
5526
5526
|
*/
|
|
5527
5527
|
ResourceId?: string
|
|
5528
5528
|
/**
|
|
@@ -5766,6 +5766,11 @@ export interface CreatePrepareFlowRequest {
|
|
|
5766
5766
|
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
5767
5767
|
*/
|
|
5768
5768
|
UserData?: string
|
|
5769
|
+
/**
|
|
5770
|
+
* 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
|
|
5771
|
+
|
|
5772
|
+
*/
|
|
5773
|
+
CcInfos?: CcInfo
|
|
5769
5774
|
/**
|
|
5770
5775
|
* 合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
|
|
5771
5776
|
注: `该参数必须是一个待发起审核的合同id，并且还未审核通过`
|
|
@@ -391,7 +391,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
391
391
|
|
|
392
392
|
**注**:
|
|
393
393
|
`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
|
|
394
|
+
|
|
394
395
|
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
396
|
+
|
|
397
|
+
`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）`
|
|
398
|
+
|
|
399
|
+
`4. 静默（自动）签署不支持合同签署方存在填写功能`
|
|
395
400
|
*/
|
|
396
401
|
async ChannelCreateFlowByFiles(
|
|
397
402
|
req: ChannelCreateFlowByFilesRequest,
|
|
@@ -639,7 +644,12 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
639
644
|
|
|
640
645
|
**注**:
|
|
641
646
|
`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
|
|
647
|
+
|
|
642
648
|
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
649
|
+
|
|
650
|
+
`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度）`
|
|
651
|
+
|
|
652
|
+
`4. 静默（自动）签署不支持合同签署方存在填写功能`
|
|
643
653
|
*/
|
|
644
654
|
async CreateFlowsByTemplates(
|
|
645
655
|
req: CreateFlowsByTemplatesRequest,
|
|
@@ -1351,6 +1361,10 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
1351
1361
|
`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
|
|
1352
1362
|
|
|
1353
1363
|
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
1364
|
+
|
|
1365
|
+
`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
1366
|
+
|
|
1367
|
+
`4. 静默（自动）签署不支持合同签署方存在填写功能`
|
|
1354
1368
|
*/
|
|
1355
1369
|
async ChannelCreateFlowGroupByTemplates(
|
|
1356
1370
|
req: ChannelCreateFlowGroupByTemplatesRequest,
|
|
@@ -1557,6 +1571,10 @@ Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
1557
1571
|
`1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
|
|
1558
1572
|
|
|
1559
1573
|
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
1574
|
+
|
|
1575
|
+
`3. 合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
1576
|
+
|
|
1577
|
+
`4. 静默（自动）签署不支持合同签署方存在填写功能`
|
|
1560
1578
|
*/
|
|
1561
1579
|
async ChannelCreateFlowGroupByFiles(
|
|
1562
1580
|
req: ChannelCreateFlowGroupByFilesRequest,
|
|
@@ -1350,14 +1350,6 @@ export interface SyncProxyOrganizationRequest {
|
|
|
1350
1350
|
* ChannelCreatePrepareFlow请求参数结构体
|
|
1351
1351
|
*/
|
|
1352
1352
|
export interface ChannelCreatePrepareFlowRequest {
|
|
1353
|
-
/**
|
|
1354
|
-
* 资源id，与ResourceType相对应，取值范围：
|
|
1355
|
-
<ul>
|
|
1356
|
-
<li>文件Id（通过UploadFiles获取文件资源Id）</li>
|
|
1357
|
-
<li>模板Id</li>
|
|
1358
|
-
</ul>
|
|
1359
|
-
*/
|
|
1360
|
-
ResourceId: string
|
|
1361
1353
|
/**
|
|
1362
1354
|
* 资源类型，取值有：
|
|
1363
1355
|
<ul><li> **1**：模板</li>
|
|
@@ -1380,6 +1372,14 @@ export interface ChannelCreatePrepareFlowRequest {
|
|
|
1380
1372
|
第三方平台子客企业和员工必须已经经过实名认证
|
|
1381
1373
|
*/
|
|
1382
1374
|
Agent?: Agent
|
|
1375
|
+
/**
|
|
1376
|
+
* 资源id，与ResourceType相对应，取值范围：
|
|
1377
|
+
<ul>
|
|
1378
|
+
<li>文件Id（通过UploadFiles获取文件资源Id）</li>
|
|
1379
|
+
<li>模板Id</li>
|
|
1380
|
+
</ul>
|
|
1381
|
+
*/
|
|
1382
|
+
ResourceId?: string
|
|
1383
1383
|
/**
|
|
1384
1384
|
* 合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
|
|
1385
1385
|
*/
|
|
@@ -1974,7 +1974,7 @@ MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverM
|
|
|
1974
1974
|
CcNotifyType?: number
|
|
1975
1975
|
/**
|
|
1976
1976
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
1977
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
1977
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
1978
1978
|
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
1979
1979
|
*/
|
|
1980
1980
|
AutoSignScene?: string
|
|
@@ -3150,9 +3150,9 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
3150
3150
|
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3151
3151
|
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
3152
3152
|
</ul>注:
|
|
3153
|
-
`1.
|
|
3154
|
-
`2.
|
|
3155
|
-
`3. 同渠道应用(Agent.AppId)
|
|
3153
|
+
`1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 `
|
|
3154
|
+
`2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 `
|
|
3155
|
+
`3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 `
|
|
3156
3156
|
*/
|
|
3157
3157
|
Agent: Agent
|
|
3158
3158
|
/**
|
|
@@ -3363,6 +3363,8 @@ export interface CommonFlowApprover {
|
|
|
3363
3363
|
**3** :企业/企业员工自动签（他方企业自动签署或文件发起时的本方企业自动签）
|
|
3364
3364
|
|
|
3365
3365
|
注：类型为3（企业/企业员工自动签）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
|
|
3366
|
+
使用自动签时，请确保企业已经开通自动签功能，开通方式：控制台 -> 企业设置 -> 扩展服务 -> 企业自动签。
|
|
3367
|
+
使用文件发起自动签时使用前请联系对接的客户经理沟通。
|
|
3366
3368
|
|
|
3367
3369
|
*/
|
|
3368
3370
|
ApproverType?: number
|
|
@@ -3986,7 +3988,7 @@ export interface FlowInfo {
|
|
|
3986
3988
|
CcNotifyType?: number
|
|
3987
3989
|
/**
|
|
3988
3990
|
* 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
|
|
3989
|
-
<ul><li> **E_PRESCRIPTION_AUTO_SIGN
|
|
3991
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：电子处方单（医疗自动签） </li><li> **OTHER** : 通用场景</li></ul>
|
|
3990
3992
|
注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
|
|
3991
3993
|
*/
|
|
3992
3994
|
AutoSignScene?: string
|
|
@@ -6147,7 +6149,7 @@ export interface ChannelGetTaskResultApiResponse {
|
|
|
6147
6149
|
*/
|
|
6148
6150
|
TaskMessage?: string
|
|
6149
6151
|
/**
|
|
6150
|
-
* 资源Id
|
|
6152
|
+
* 资源Id（即FileId），用于[用PDF文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)
|
|
6151
6153
|
*/
|
|
6152
6154
|
ResourceId?: string
|
|
6153
6155
|
/**
|