tencentcloud-sdk-nodejs-essbasic 4.0.726 → 4.0.729
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 +155835 -0
- package/SERVICE_CHANGELOG.md +141689 -0
- package/package.json +1 -1
- package/products.md +25 -24
- package/src/services/essbasic/v20210526/essbasic_client.ts +97 -45
- package/src/services/essbasic/v20210526/essbasic_models.ts +378 -149
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +84 -41
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +85 -40
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +372 -146
|
@@ -920,7 +920,15 @@ export interface ChannelCreateRoleRequest {
|
|
|
920
920
|
*/
|
|
921
921
|
Name: string;
|
|
922
922
|
/**
|
|
923
|
-
*
|
|
923
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
924
|
+
|
|
925
|
+
此接口下面信息必填。
|
|
926
|
+
<ul>
|
|
927
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
928
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
929
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
930
|
+
</ul>
|
|
931
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
924
932
|
*/
|
|
925
933
|
Agent: Agent;
|
|
926
934
|
/**
|
|
@@ -1755,7 +1763,14 @@ export interface ChannelCreateFlowGroupByFilesRequest {
|
|
|
1755
1763
|
*/
|
|
1756
1764
|
export interface ChannelCreateOrganizationModifyQrCodeRequest {
|
|
1757
1765
|
/**
|
|
1758
|
-
*
|
|
1766
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1767
|
+
|
|
1768
|
+
此接口下面信息必填。
|
|
1769
|
+
|
|
1770
|
+
渠道应用标识: Agent.AppId
|
|
1771
|
+
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
|
|
1772
|
+
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
|
|
1773
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1759
1774
|
*/
|
|
1760
1775
|
Agent: Agent;
|
|
1761
1776
|
}
|
|
@@ -1817,22 +1832,26 @@ export interface DescribeFlowDetailInfoResponse {
|
|
|
1817
1832
|
*/
|
|
1818
1833
|
export interface RecipientComponentInfo {
|
|
1819
1834
|
/**
|
|
1820
|
-
*
|
|
1821
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
1835
|
+
* 参与方的角色ID
|
|
1822
1836
|
*/
|
|
1823
1837
|
RecipientId?: string;
|
|
1824
1838
|
/**
|
|
1825
1839
|
* 参与方填写状态
|
|
1826
|
-
|
|
1840
|
+
|
|
1841
|
+
<ul><li> **0** : 还没有填写</li>
|
|
1842
|
+
<li> **1** : 已经填写</li></ul>
|
|
1827
1843
|
*/
|
|
1828
1844
|
RecipientFillStatus?: string;
|
|
1829
1845
|
/**
|
|
1830
|
-
*
|
|
1846
|
+
* 此角色是否是发起方角色
|
|
1847
|
+
|
|
1848
|
+
<ul><li> **true** : 是发起方角色</li>
|
|
1849
|
+
<li> **false** : 不是发起方角色</li></ul>
|
|
1831
1850
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1832
1851
|
*/
|
|
1833
1852
|
IsPromoter?: boolean;
|
|
1834
1853
|
/**
|
|
1835
|
-
*
|
|
1854
|
+
* 此角色的填写控件列表
|
|
1836
1855
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1837
1856
|
*/
|
|
1838
1857
|
Components?: Array<FilledComponent>;
|
|
@@ -1842,7 +1861,15 @@ export interface RecipientComponentInfo {
|
|
|
1842
1861
|
*/
|
|
1843
1862
|
export interface ChannelDescribeRolesRequest {
|
|
1844
1863
|
/**
|
|
1845
|
-
*
|
|
1864
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1865
|
+
|
|
1866
|
+
此接口下面信息必填。
|
|
1867
|
+
<ul>
|
|
1868
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1869
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1870
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1871
|
+
</ul>
|
|
1872
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1846
1873
|
*/
|
|
1847
1874
|
Agent: Agent;
|
|
1848
1875
|
/**
|
|
@@ -1879,6 +1906,49 @@ export interface PrepareFlowsResponse {
|
|
|
1879
1906
|
*/
|
|
1880
1907
|
RequestId?: string;
|
|
1881
1908
|
}
|
|
1909
|
+
/**
|
|
1910
|
+
* ChannelCancelFlow请求参数结构体
|
|
1911
|
+
*/
|
|
1912
|
+
export interface ChannelCancelFlowRequest {
|
|
1913
|
+
/**
|
|
1914
|
+
* 要撤销的合同流程ID
|
|
1915
|
+
*/
|
|
1916
|
+
FlowId: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
1919
|
+
|
|
1920
|
+
此接口下面信息必填。
|
|
1921
|
+
<ul>
|
|
1922
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1923
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1924
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1925
|
+
</ul>
|
|
1926
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1927
|
+
*/
|
|
1928
|
+
Agent?: Agent;
|
|
1929
|
+
/**
|
|
1930
|
+
* 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
1931
|
+
*/
|
|
1932
|
+
CancelMessage?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
|
1935
|
+
|
|
1936
|
+
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
1937
|
+
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
1938
|
+
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
1939
|
+
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
1940
|
+
|
|
1941
|
+
注: `CancelMessage为撤销当前合同的理由`
|
|
1942
|
+
|
|
1943
|
+

|
|
1944
|
+
*/
|
|
1945
|
+
CancelMessageFormat?: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* 暂未开放
|
|
1948
|
+
* @deprecated
|
|
1949
|
+
*/
|
|
1950
|
+
Operator?: UserInfo;
|
|
1951
|
+
}
|
|
1882
1952
|
/**
|
|
1883
1953
|
* 此结构体 (TemplateInfo) 用于描述模板的信息。
|
|
1884
1954
|
|
|
@@ -2033,7 +2103,6 @@ export interface ChannelRole {
|
|
|
2033
2103
|
RoleName?: string;
|
|
2034
2104
|
/**
|
|
2035
2105
|
* 角色状态:1-启用;2-禁用
|
|
2036
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
2037
2106
|
*/
|
|
2038
2107
|
RoleStatus?: number;
|
|
2039
2108
|
/**
|
|
@@ -2233,6 +2302,60 @@ export interface CreateChannelFlowEvidenceReportRequest {
|
|
|
2233
2302
|
*/
|
|
2234
2303
|
Operator?: UserInfo;
|
|
2235
2304
|
}
|
|
2305
|
+
/**
|
|
2306
|
+
* ChannelDescribeBillUsageDetail请求参数结构体
|
|
2307
|
+
*/
|
|
2308
|
+
export interface ChannelDescribeBillUsageDetailRequest {
|
|
2309
|
+
/**
|
|
2310
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2311
|
+
|
|
2312
|
+
此接口下面信息必填。
|
|
2313
|
+
<ul>
|
|
2314
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2315
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2316
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2317
|
+
</ul>
|
|
2318
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2319
|
+
*/
|
|
2320
|
+
Agent: Agent;
|
|
2321
|
+
/**
|
|
2322
|
+
* 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
2323
|
+
*/
|
|
2324
|
+
StartTime: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
2327
|
+
*/
|
|
2328
|
+
EndTime: string;
|
|
2329
|
+
/**
|
|
2330
|
+
* 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
2331
|
+
目前支持:
|
|
2332
|
+
<ul>
|
|
2333
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
2334
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
2335
|
+
<li>**CloudProve**: 签署报告</li>
|
|
2336
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
2337
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
2338
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
2339
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
2340
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
2341
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
2342
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
2343
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
2344
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
2345
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
2346
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
2347
|
+
</ul>
|
|
2348
|
+
*/
|
|
2349
|
+
QuotaType?: string;
|
|
2350
|
+
/**
|
|
2351
|
+
* 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
2352
|
+
*/
|
|
2353
|
+
Offset?: number;
|
|
2354
|
+
/**
|
|
2355
|
+
* 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
2356
|
+
*/
|
|
2357
|
+
Limit?: number;
|
|
2358
|
+
}
|
|
2236
2359
|
/**
|
|
2237
2360
|
* ChannelCancelUserAutoSignEnableUrl请求参数结构体
|
|
2238
2361
|
*/
|
|
@@ -3016,14 +3139,15 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
3016
3139
|
|
|
3017
3140
|
此接口下面信息必填。
|
|
3018
3141
|
<ul>
|
|
3019
|
-
<li>渠道应用标识: Agent.
|
|
3020
|
-
<li>第三方平台子客企业标识: Agent.
|
|
3021
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
3142
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3143
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3144
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3022
3145
|
</ul>
|
|
3146
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3023
3147
|
*/
|
|
3024
3148
|
Agent: Agent;
|
|
3025
3149
|
/**
|
|
3026
|
-
*
|
|
3150
|
+
* 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
|
|
3027
3151
|
*/
|
|
3028
3152
|
QrCodeId: string;
|
|
3029
3153
|
/**
|
|
@@ -3089,30 +3213,43 @@ export interface ChannelDescribeOrganizationSealsRequest {
|
|
|
3089
3213
|
*/
|
|
3090
3214
|
export interface DescribeUsageRequest {
|
|
3091
3215
|
/**
|
|
3092
|
-
*
|
|
3216
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3217
|
+
|
|
3218
|
+
此接口下面信息必填。
|
|
3219
|
+
<ul>
|
|
3220
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3221
|
+
</ul>
|
|
3093
3222
|
*/
|
|
3094
3223
|
Agent: Agent;
|
|
3095
3224
|
/**
|
|
3096
|
-
*
|
|
3225
|
+
* 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
|
|
3226
|
+
|
|
3227
|
+
注: `查询日期范围区间长度大于90天`。
|
|
3097
3228
|
*/
|
|
3098
3229
|
StartDate: string;
|
|
3099
3230
|
/**
|
|
3100
|
-
*
|
|
3101
|
-
|
|
3231
|
+
* 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
|
|
3232
|
+
|
|
3233
|
+
注: `查询日期范围区间长度大于90天`。
|
|
3102
3234
|
*/
|
|
3103
3235
|
EndDate: string;
|
|
3104
3236
|
/**
|
|
3105
3237
|
* 是否汇总数据,默认不汇总。
|
|
3106
|
-
|
|
3107
|
-
|
|
3238
|
+
<ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
|
|
3239
|
+
<li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
|
|
3240
|
+
|
|
3108
3241
|
*/
|
|
3109
3242
|
NeedAggregate?: boolean;
|
|
3110
3243
|
/**
|
|
3111
|
-
*
|
|
3244
|
+
* 指定每页返回的数据条数,和Offset参数配合使用。
|
|
3245
|
+
|
|
3246
|
+
注: `默认值为1000,单页做大值为1000`
|
|
3112
3247
|
*/
|
|
3113
3248
|
Limit?: number;
|
|
3114
3249
|
/**
|
|
3115
|
-
*
|
|
3250
|
+
* 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
3251
|
+
|
|
3252
|
+
注:`offset从0开始,即第一页为0。`
|
|
3116
3253
|
*/
|
|
3117
3254
|
Offset?: number;
|
|
3118
3255
|
/**
|
|
@@ -3735,12 +3872,19 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
|
|
|
3735
3872
|
*/
|
|
3736
3873
|
export interface ChannelCreateBoundFlowsRequest {
|
|
3737
3874
|
/**
|
|
3738
|
-
*
|
|
3739
|
-
|
|
3875
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
3876
|
+
|
|
3877
|
+
此接口下面信息必填。
|
|
3878
|
+
<ul>
|
|
3879
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3880
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3881
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3882
|
+
</ul>
|
|
3883
|
+
第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
|
|
3740
3884
|
*/
|
|
3741
3885
|
Agent: Agent;
|
|
3742
3886
|
/**
|
|
3743
|
-
*
|
|
3887
|
+
* 需要领取的合同流程的ID列表
|
|
3744
3888
|
*/
|
|
3745
3889
|
FlowIds?: Array<string>;
|
|
3746
3890
|
/**
|
|
@@ -3989,15 +4133,15 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
3989
4133
|
|
|
3990
4134
|
此接口下面信息必填。
|
|
3991
4135
|
<ul>
|
|
3992
|
-
<li>渠道应用标识: Agent.
|
|
3993
|
-
<li>第三方平台子客企业标识: Agent.
|
|
3994
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
4136
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4137
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4138
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3995
4139
|
</ul>
|
|
4140
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3996
4141
|
*/
|
|
3997
4142
|
Agent: Agent;
|
|
3998
4143
|
/**
|
|
3999
4144
|
* 合同模板ID,为32位字符串。
|
|
4000
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
4001
4145
|
*/
|
|
4002
4146
|
TemplateId: string;
|
|
4003
4147
|
/**
|
|
@@ -4048,6 +4192,8 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
4048
4192
|
export interface SignQrCode {
|
|
4049
4193
|
/**
|
|
4050
4194
|
* 二维码ID,为32位字符串。
|
|
4195
|
+
|
|
4196
|
+
注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
|
|
4051
4197
|
*/
|
|
4052
4198
|
QrCodeId?: string;
|
|
4053
4199
|
/**
|
|
@@ -4055,7 +4201,8 @@ export interface SignQrCode {
|
|
|
4055
4201
|
*/
|
|
4056
4202
|
QrCodeUrl?: string;
|
|
4057
4203
|
/**
|
|
4058
|
-
* 二维码的有截止时间,格式为Unix
|
|
4204
|
+
* 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
|
|
4205
|
+
一旦超过二维码的有效期限,该二维码将自动失效。
|
|
4059
4206
|
*/
|
|
4060
4207
|
ExpiredTime?: number;
|
|
4061
4208
|
}
|
|
@@ -4359,21 +4506,6 @@ export interface ChannelGetTaskResultApiRequest {
|
|
|
4359
4506
|
*/
|
|
4360
4507
|
Organization?: OrganizationInfo;
|
|
4361
4508
|
}
|
|
4362
|
-
/**
|
|
4363
|
-
* 批量补充签署人时,补充失败的报错说明
|
|
4364
|
-
*/
|
|
4365
|
-
export interface FillError {
|
|
4366
|
-
/**
|
|
4367
|
-
* 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
|
|
4368
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4369
|
-
*/
|
|
4370
|
-
RecipientId?: string;
|
|
4371
|
-
/**
|
|
4372
|
-
* 补充失败错误说明
|
|
4373
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4374
|
-
*/
|
|
4375
|
-
ErrMessage?: string;
|
|
4376
|
-
}
|
|
4377
4509
|
/**
|
|
4378
4510
|
* ChannelCreatePreparedPersonalEsign请求参数结构体
|
|
4379
4511
|
*/
|
|
@@ -4436,6 +4568,38 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
|
|
|
4436
4568
|
*/
|
|
4437
4569
|
LicenseType?: number;
|
|
4438
4570
|
}
|
|
4571
|
+
/**
|
|
4572
|
+
* 批量补充签署人时,补充失败的报错说明
|
|
4573
|
+
*/
|
|
4574
|
+
export interface FillError {
|
|
4575
|
+
/**
|
|
4576
|
+
* 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
|
|
4577
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4578
|
+
*/
|
|
4579
|
+
RecipientId?: string;
|
|
4580
|
+
/**
|
|
4581
|
+
* 补充失败错误说明
|
|
4582
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
4583
|
+
*/
|
|
4584
|
+
ErrMessage?: string;
|
|
4585
|
+
}
|
|
4586
|
+
/**
|
|
4587
|
+
* ChannelDescribeBillUsageDetail返回参数结构体
|
|
4588
|
+
*/
|
|
4589
|
+
export interface ChannelDescribeBillUsageDetailResponse {
|
|
4590
|
+
/**
|
|
4591
|
+
* 返回查询记录总数
|
|
4592
|
+
*/
|
|
4593
|
+
Total?: number;
|
|
4594
|
+
/**
|
|
4595
|
+
* 消耗记录详情
|
|
4596
|
+
*/
|
|
4597
|
+
Details?: Array<ChannelBillUsageDetail>;
|
|
4598
|
+
/**
|
|
4599
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4600
|
+
*/
|
|
4601
|
+
RequestId?: string;
|
|
4602
|
+
}
|
|
4439
4603
|
/**
|
|
4440
4604
|
* 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
|
|
4441
4605
|
*/
|
|
@@ -4670,11 +4834,11 @@ export interface ExtentServiceAuthInfo {
|
|
|
4670
4834
|
/**
|
|
4671
4835
|
* 扩展服务类型
|
|
4672
4836
|
<ul>
|
|
4673
|
-
|
|
4837
|
+
<li>AUTO_SIGN 企业自动签(自动签署)</li>
|
|
4674
4838
|
<li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
|
|
4675
4839
|
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
|
4676
|
-
|
|
4677
|
-
|
|
4840
|
+
<li> PAGING_SEAL 骑缝章</li>
|
|
4841
|
+
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
|
4678
4842
|
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
|
4679
4843
|
</ul>
|
|
4680
4844
|
*/
|
|
@@ -4684,7 +4848,9 @@ export interface ExtentServiceAuthInfo {
|
|
|
4684
4848
|
*/
|
|
4685
4849
|
Name?: string;
|
|
4686
4850
|
/**
|
|
4687
|
-
*
|
|
4851
|
+
* 扩展服务的开通状态
|
|
4852
|
+
**ENABLE**:开通
|
|
4853
|
+
**DISABLE**:未开通
|
|
4688
4854
|
*/
|
|
4689
4855
|
Status?: string;
|
|
4690
4856
|
/**
|
|
@@ -4729,28 +4895,27 @@ export interface Filter {
|
|
|
4729
4895
|
*/
|
|
4730
4896
|
export interface FilledComponent {
|
|
4731
4897
|
/**
|
|
4732
|
-
*
|
|
4733
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4898
|
+
* 填写控件ID
|
|
4734
4899
|
*/
|
|
4735
4900
|
ComponentId?: string;
|
|
4736
4901
|
/**
|
|
4737
4902
|
* 控件名称
|
|
4738
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4739
4903
|
*/
|
|
4740
4904
|
ComponentName?: string;
|
|
4741
4905
|
/**
|
|
4742
|
-
*
|
|
4743
|
-
|
|
4906
|
+
* 此填写控件的填写状态
|
|
4907
|
+
**0** : 此填写控件**未填写**
|
|
4908
|
+
**1** : 此填写控件**已填写**
|
|
4744
4909
|
*/
|
|
4745
4910
|
ComponentFillStatus?: string;
|
|
4746
4911
|
/**
|
|
4747
4912
|
* 控件填写内容
|
|
4748
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
4749
4913
|
*/
|
|
4750
4914
|
ComponentValue?: string;
|
|
4751
4915
|
/**
|
|
4752
4916
|
* 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
|
|
4753
|
-
|
|
4917
|
+
|
|
4918
|
+
注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
|
|
4754
4919
|
*/
|
|
4755
4920
|
ImageUrl?: string;
|
|
4756
4921
|
}
|
|
@@ -4791,7 +4956,15 @@ export interface CreateSignUrlsResponse {
|
|
|
4791
4956
|
*/
|
|
4792
4957
|
export interface ChannelDeleteRoleRequest {
|
|
4793
4958
|
/**
|
|
4794
|
-
*
|
|
4959
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4960
|
+
|
|
4961
|
+
此接口下面信息必填。
|
|
4962
|
+
<ul>
|
|
4963
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4964
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4965
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4966
|
+
</ul>
|
|
4967
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4795
4968
|
*/
|
|
4796
4969
|
Agent: Agent;
|
|
4797
4970
|
/**
|
|
@@ -5079,8 +5252,7 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
5079
5252
|
*/
|
|
5080
5253
|
export interface ChannelDescribeFlowComponentsResponse {
|
|
5081
5254
|
/**
|
|
5082
|
-
*
|
|
5083
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
5255
|
+
* 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
|
|
5084
5256
|
*/
|
|
5085
5257
|
RecipientComponentInfos?: Array<RecipientComponentInfo>;
|
|
5086
5258
|
/**
|
|
@@ -5159,6 +5331,37 @@ export interface ApproverOption {
|
|
|
5159
5331
|
*/
|
|
5160
5332
|
FlowReadLimit?: string;
|
|
5161
5333
|
}
|
|
5334
|
+
/**
|
|
5335
|
+
* ChannelDescribeUserAutoSignStatus返回参数结构体
|
|
5336
|
+
*/
|
|
5337
|
+
export interface ChannelDescribeUserAutoSignStatusResponse {
|
|
5338
|
+
/**
|
|
5339
|
+
* 查询用户是否已开通自动签
|
|
5340
|
+
*/
|
|
5341
|
+
IsOpen?: boolean;
|
|
5342
|
+
/**
|
|
5343
|
+
* 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
|
|
5344
|
+
|
|
5345
|
+
值为unix时间戳,单位为秒。
|
|
5346
|
+
*/
|
|
5347
|
+
LicenseFrom?: number;
|
|
5348
|
+
/**
|
|
5349
|
+
* 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
|
|
5350
|
+
|
|
5351
|
+
值为unix时间戳,单位为秒。
|
|
5352
|
+
*/
|
|
5353
|
+
LicenseTo?: number;
|
|
5354
|
+
/**
|
|
5355
|
+
* 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
5356
|
+
|
|
5357
|
+
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
5358
|
+
*/
|
|
5359
|
+
LicenseType?: number;
|
|
5360
|
+
/**
|
|
5361
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
5362
|
+
*/
|
|
5363
|
+
RequestId?: string;
|
|
5364
|
+
}
|
|
5162
5365
|
/**
|
|
5163
5366
|
* 同步的员工的信息
|
|
5164
5367
|
*/
|
|
@@ -5629,47 +5832,85 @@ export interface SignUrl {
|
|
|
5629
5832
|
HttpSignUrl?: string;
|
|
5630
5833
|
}
|
|
5631
5834
|
/**
|
|
5632
|
-
*
|
|
5835
|
+
* 用户计费使用情况详情
|
|
5633
5836
|
*/
|
|
5634
|
-
export interface
|
|
5837
|
+
export interface ChannelBillUsageDetail {
|
|
5635
5838
|
/**
|
|
5636
|
-
*
|
|
5839
|
+
* 合同流程ID,为32位字符串。
|
|
5637
5840
|
*/
|
|
5638
|
-
FlowId
|
|
5841
|
+
FlowId?: string;
|
|
5639
5842
|
/**
|
|
5640
|
-
*
|
|
5641
|
-
|
|
5642
|
-
|
|
5843
|
+
* 合同经办人名称
|
|
5844
|
+
如果有多个经办人用分号隔开。
|
|
5845
|
+
*/
|
|
5846
|
+
OperatorName?: string;
|
|
5847
|
+
/**
|
|
5848
|
+
* 发起方组织机构名称
|
|
5849
|
+
*/
|
|
5850
|
+
CreateOrganizationName?: string;
|
|
5851
|
+
/**
|
|
5852
|
+
* 合同流程的名称。
|
|
5853
|
+
*/
|
|
5854
|
+
FlowName?: string;
|
|
5855
|
+
/**
|
|
5856
|
+
* 合同流程当前的签署状态, 会存在下列的状态值
|
|
5643
5857
|
<ul>
|
|
5644
|
-
<li
|
|
5645
|
-
<li
|
|
5646
|
-
<li
|
|
5858
|
+
<li>**INIT**: 合同创建</li>
|
|
5859
|
+
<li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
|
|
5860
|
+
<li>**REJECT**: 合同拒签</li>
|
|
5861
|
+
<li>**ALL**: 合同签署完成</li>
|
|
5862
|
+
<li>**DEADLINE**: 合同流签(合同过期)</li>
|
|
5863
|
+
<li>**CANCEL**: 合同撤回</li>
|
|
5864
|
+
<li>**RELIEVED**: 解除协议(已解除)</li>
|
|
5865
|
+
<li>**WILLEXPIRE**: 合同即将过期</li>
|
|
5866
|
+
<li>**EXCEPTION**: 合同异常</li>
|
|
5647
5867
|
</ul>
|
|
5648
|
-
第三方平台子客企业和员工必须已经经过实名认证
|
|
5649
5868
|
*/
|
|
5650
|
-
|
|
5869
|
+
FlowStatus?: string;
|
|
5651
5870
|
/**
|
|
5652
|
-
*
|
|
5871
|
+
* 查询的套餐类型
|
|
5872
|
+
对应关系如下:
|
|
5873
|
+
<ul>
|
|
5874
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
5875
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
5876
|
+
<li>**CloudProve**: 签署报告</li>
|
|
5877
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
5878
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
5879
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
5880
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
5881
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
5882
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
5883
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
5884
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
5885
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
5886
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
5887
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
5888
|
+
</ul>
|
|
5653
5889
|
*/
|
|
5654
|
-
|
|
5890
|
+
QuotaType?: string;
|
|
5655
5891
|
/**
|
|
5656
|
-
*
|
|
5657
|
-
|
|
5658
|
-
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5659
|
-
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
5660
|
-
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
5661
|
-
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5662
|
-
|
|
5663
|
-
注: `CancelMessage为撤销当前合同的理由`
|
|
5664
|
-
|
|
5665
|
-

|
|
5892
|
+
* 合同使用量
|
|
5893
|
+
注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
|
|
5666
5894
|
*/
|
|
5667
|
-
|
|
5895
|
+
UseCount?: number;
|
|
5668
5896
|
/**
|
|
5669
|
-
*
|
|
5670
|
-
* @deprecated
|
|
5897
|
+
* 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
5671
5898
|
*/
|
|
5672
|
-
|
|
5899
|
+
CostTime?: number;
|
|
5900
|
+
/**
|
|
5901
|
+
* 消耗的套餐名称
|
|
5902
|
+
*/
|
|
5903
|
+
QuotaName?: string;
|
|
5904
|
+
/**
|
|
5905
|
+
* 消耗类型
|
|
5906
|
+
**1**.扣费
|
|
5907
|
+
**2**.撤销返还
|
|
5908
|
+
*/
|
|
5909
|
+
CostType?: number;
|
|
5910
|
+
/**
|
|
5911
|
+
* 备注
|
|
5912
|
+
*/
|
|
5913
|
+
Remark?: string;
|
|
5673
5914
|
}
|
|
5674
5915
|
/**
|
|
5675
5916
|
* DescribeBillUsageDetail请求参数结构体
|
|
@@ -5949,33 +6190,33 @@ export interface ChannelCreateOrganizationBatchSignUrlResponse {
|
|
|
5949
6190
|
*/
|
|
5950
6191
|
export interface UsageDetail {
|
|
5951
6192
|
/**
|
|
5952
|
-
*
|
|
6193
|
+
* 子客企业标识
|
|
5953
6194
|
*/
|
|
5954
|
-
ProxyOrganizationOpenId
|
|
6195
|
+
ProxyOrganizationOpenId?: string;
|
|
5955
6196
|
/**
|
|
5956
6197
|
* 子客企业名
|
|
5957
6198
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5958
6199
|
*/
|
|
5959
|
-
ProxyOrganizationName
|
|
6200
|
+
ProxyOrganizationName?: string;
|
|
5960
6201
|
/**
|
|
5961
|
-
*
|
|
6202
|
+
* 对应的消耗日期, **如果是汇总数据则为1970-01-01**
|
|
5962
6203
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5963
6204
|
*/
|
|
5964
|
-
Date
|
|
6205
|
+
Date?: string;
|
|
5965
6206
|
/**
|
|
5966
|
-
*
|
|
6207
|
+
* 消耗合同数量
|
|
5967
6208
|
*/
|
|
5968
|
-
Usage
|
|
6209
|
+
Usage?: number;
|
|
5969
6210
|
/**
|
|
5970
|
-
*
|
|
6211
|
+
* 撤回合同数量
|
|
5971
6212
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5972
6213
|
*/
|
|
5973
|
-
Cancel
|
|
6214
|
+
Cancel?: number;
|
|
5974
6215
|
/**
|
|
5975
6216
|
* 消耗渠道
|
|
5976
6217
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
5977
6218
|
*/
|
|
5978
|
-
FlowChannel
|
|
6219
|
+
FlowChannel?: string;
|
|
5979
6220
|
}
|
|
5980
6221
|
/**
|
|
5981
6222
|
* ChannelCreateBatchCancelFlowUrl返回参数结构体
|
|
@@ -6126,37 +6367,6 @@ export interface ChannelDescribeEmployeesResponse {
|
|
|
6126
6367
|
*/
|
|
6127
6368
|
RequestId?: string;
|
|
6128
6369
|
}
|
|
6129
|
-
/**
|
|
6130
|
-
* ChannelCreateFlowApprovers请求参数结构体
|
|
6131
|
-
*/
|
|
6132
|
-
export interface ChannelCreateFlowApproversRequest {
|
|
6133
|
-
/**
|
|
6134
|
-
* 渠道应用相关信息
|
|
6135
|
-
*/
|
|
6136
|
-
Agent: Agent;
|
|
6137
|
-
/**
|
|
6138
|
-
* 合同唯一编号
|
|
6139
|
-
*/
|
|
6140
|
-
FlowId: string;
|
|
6141
|
-
/**
|
|
6142
|
-
* 补充企业签署人信息。
|
|
6143
|
-
|
|
6144
|
-
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
6145
|
-
|
|
6146
|
-
- 如果不指定,则使用姓名和手机号进行补充。
|
|
6147
|
-
*/
|
|
6148
|
-
Approvers: Array<FillApproverInfo>;
|
|
6149
|
-
/**
|
|
6150
|
-
* 操作人信息
|
|
6151
|
-
*/
|
|
6152
|
-
Operator?: UserInfo;
|
|
6153
|
-
/**
|
|
6154
|
-
* 签署人信息补充方式
|
|
6155
|
-
|
|
6156
|
-
<ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
6157
|
-
*/
|
|
6158
|
-
FillApproverType?: number;
|
|
6159
|
-
}
|
|
6160
6370
|
/**
|
|
6161
6371
|
* ChannelDeleteRole返回参数结构体
|
|
6162
6372
|
*/
|
|
@@ -6276,35 +6486,43 @@ export interface CreateSealByImageRequest {
|
|
|
6276
6486
|
SealSize?: string;
|
|
6277
6487
|
}
|
|
6278
6488
|
/**
|
|
6279
|
-
*
|
|
6489
|
+
* ChannelCreateFlowApprovers请求参数结构体
|
|
6280
6490
|
*/
|
|
6281
|
-
export interface
|
|
6491
|
+
export interface ChannelCreateFlowApproversRequest {
|
|
6282
6492
|
/**
|
|
6283
|
-
*
|
|
6493
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6494
|
+
|
|
6495
|
+
此接口下面信息必填。
|
|
6496
|
+
<ul>
|
|
6497
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6498
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6499
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6500
|
+
</ul>
|
|
6501
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6284
6502
|
*/
|
|
6285
|
-
|
|
6503
|
+
Agent: Agent;
|
|
6286
6504
|
/**
|
|
6287
|
-
*
|
|
6288
|
-
|
|
6289
|
-
值为unix时间戳,单位为秒。
|
|
6505
|
+
* 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
6290
6506
|
*/
|
|
6291
|
-
|
|
6507
|
+
FlowId: string;
|
|
6292
6508
|
/**
|
|
6293
|
-
*
|
|
6509
|
+
* 补充企业签署人信息。
|
|
6294
6510
|
|
|
6295
|
-
|
|
6511
|
+
- 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
|
|
6512
|
+
|
|
6513
|
+
- 如果不指定,则使用姓名和手机号进行补充。
|
|
6296
6514
|
*/
|
|
6297
|
-
|
|
6515
|
+
Approvers: Array<FillApproverInfo>;
|
|
6298
6516
|
/**
|
|
6299
|
-
*
|
|
6300
|
-
|
|
6301
|
-
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li></ul>
|
|
6517
|
+
* 操作人信息
|
|
6302
6518
|
*/
|
|
6303
|
-
|
|
6519
|
+
Operator?: UserInfo;
|
|
6304
6520
|
/**
|
|
6305
|
-
*
|
|
6521
|
+
* 签署人信息补充方式
|
|
6522
|
+
|
|
6523
|
+
<ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
|
|
6306
6524
|
*/
|
|
6307
|
-
|
|
6525
|
+
FillApproverType?: number;
|
|
6308
6526
|
}
|
|
6309
6527
|
/**
|
|
6310
6528
|
* ChannelUpdateSealStatus返回参数结构体
|
|
@@ -6442,11 +6660,19 @@ export interface CcInfo {
|
|
|
6442
6660
|
*/
|
|
6443
6661
|
export interface ChannelDescribeFlowComponentsRequest {
|
|
6444
6662
|
/**
|
|
6445
|
-
*
|
|
6663
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6664
|
+
|
|
6665
|
+
此接口下面信息必填。
|
|
6666
|
+
<ul>
|
|
6667
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6668
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6669
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6670
|
+
</ul>
|
|
6671
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6446
6672
|
*/
|
|
6447
6673
|
Agent: Agent;
|
|
6448
6674
|
/**
|
|
6449
|
-
*
|
|
6675
|
+
* 需要获取填写控件填写内容的合同流程ID
|
|
6450
6676
|
*/
|
|
6451
6677
|
FlowId: string;
|
|
6452
6678
|
}
|