tencentcloud-sdk-nodejs-essbasic 4.0.742 → 4.0.744

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.
@@ -789,11 +789,11 @@ export interface ChannelCreateBatchSignUrlResponse {
789
789
  */
790
790
  export interface ChannelCreatePrepareFlowResponse {
791
791
  /**
792
- * 预发起的合同链接, 可以直接点击进入进行合同发起
792
+ * 发起的合同嵌入链接, 可以直接点击进入进行合同发起, 有效期为5分钟
793
793
  */
794
794
  PrepareFlowUrl?: string
795
795
  /**
796
- * 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果
796
+ * 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果, 有效期为5分钟
797
797
  */
798
798
  PreviewFlowUrl?: string
799
799
  /**
@@ -926,29 +926,46 @@ export interface FlowFileInfo {
926
926
  */
927
927
  export interface CreateFlowOption {
928
928
  /**
929
- * 是否允许修改合同信息,true-是,false-否
929
+ * 是否允许修改合同信息,
930
+ **true**:可以
931
+ **false**:(默认)不可以
930
932
  */
931
933
  CanEditFlow?: boolean
932
934
  /**
933
- * 是否允许发起合同弹窗隐藏合同名称,true-允许,false-不允许
935
+ * 是否允许发起合同弹窗隐藏合同名称
936
+ **true**:允许
937
+ **false**:(默认)不允许
934
938
  */
935
939
  HideShowFlowName?: boolean
936
940
  /**
937
- * 是否允许发起合同弹窗隐藏合同类型,true-允许,false-不允许
941
+ * 是否允许发起合同弹窗隐藏合同类型,
942
+ **true**:允许
943
+ **false**:(默认)不允许
938
944
  */
939
945
  HideShowFlowType?: boolean
940
946
  /**
941
- * 是否允许发起合同弹窗隐藏合同到期时间,true-允许,false-不允许
947
+ * 是否允许发起合同弹窗隐藏合同到期时间
948
+ **true**:允许
949
+ **false**:(默认)不允许
942
950
  */
943
951
  HideShowDeadline?: boolean
944
952
  /**
945
- * 是否允许发起合同步骤跳过指定签署方步骤,true-允许,false-不允许
953
+ * 是否允许发起合同步骤跳过指定签署方步骤
954
+ **true**:允许
955
+ **false**:(默认)不允许
946
956
  */
947
957
  CanSkipAddApprover?: boolean
948
958
  /**
949
- * 定制化发起合同弹窗的描述信息,描述信息最长500
959
+ * 定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。
950
960
  */
951
961
  CustomCreateFlowDescription?: string
962
+ /**
963
+ * 禁止编辑填写控件
964
+
965
+ **true**:禁止编辑填写控件
966
+ **false**:(默认)允许编辑填写控件
967
+ */
968
+ ForbidEditFillComponent?: boolean
952
969
  }
953
970
 
954
971
  /**
@@ -986,25 +1003,25 @@ export interface ChannelCreateRoleRequest {
986
1003
  */
987
1004
  export interface BaseFlowInfo {
988
1005
  /**
989
- * 合同流程名称
1006
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
990
1007
  */
991
1008
  FlowName: string
992
1009
  /**
993
- * 合同流程类型
994
- <br/>客户自定义,用于合同分类展示
1010
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
995
1011
  */
996
1012
  FlowType: string
997
1013
  /**
998
- * 合同流程描述信息
1014
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
999
1015
  */
1000
1016
  FlowDescription: string
1001
1017
  /**
1002
- * 合同流程截止时间,unix时间戳,单位秒
1018
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1003
1019
  */
1004
1020
  Deadline: number
1005
1021
  /**
1006
- * 是否顺序签署(true:无序签,false:顺序签)
1007
- <br/>默认false,有序签署合同
1022
+ * 合同流程的签署顺序类型:
1023
+ **false**:(默认)有序签署, 本合同多个参与人需要依次签署
1024
+ **true**:无序签署, 本合同多个参与人没有先后签署限制
1008
1025
  */
1009
1026
  Unordered?: boolean
1010
1027
  /**
@@ -1012,29 +1029,37 @@ export interface BaseFlowInfo {
1012
1029
  */
1013
1030
  IntelligentStatus?: string
1014
1031
  /**
1015
- * 填写控件内容
1032
+ * 填写控件内容, 填写的控制的ID-填写的内容对列表
1016
1033
  */
1017
1034
  FormFields?: Array<FormField>
1018
1035
  /**
1019
- * 本企业(发起方企业)是否需要签署审批
1020
- <br/>true:开启发起方签署审批
1021
- <br/>false:不开启发起方签署审批
1022
- <br/>开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
1036
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1037
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1038
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1039
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1040
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1041
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1042
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1023
1043
  */
1024
1044
  NeedSignReview?: boolean
1025
1045
  /**
1026
- * 用户流程自定义数据参数
1046
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
1047
+
1048
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
1027
1049
  */
1028
1050
  UserData?: string
1029
1051
  /**
1030
- * 抄送人信息
1052
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1053
+
1054
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
1031
1055
  */
1032
1056
  CcInfos?: Array<CcInfo>
1033
1057
  /**
1034
- * 是否需要开启发起方发起前审核
1035
- <br/>true:开启发起方发起前审核
1036
- <br/>false:不开启发起方发起前审核
1037
- <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
1058
+ * 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1059
+
1060
+ 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
1061
+
1062
+
1038
1063
  */
1039
1064
  NeedCreateReview?: boolean
1040
1065
  /**
@@ -1256,23 +1281,31 @@ export interface SyncProxyOrganizationRequest {
1256
1281
  */
1257
1282
  export interface ChannelCreatePrepareFlowRequest {
1258
1283
  /**
1259
- * 资源id,与ResourceType对应
1284
+ * 合同模板ID,为32位字符串。
1260
1285
  */
1261
1286
  ResourceId: string
1262
1287
  /**
1263
- * 资源类型,与ResourceId对应1:模板 2: 文件
1288
+ * 资源类型,此接口固定为**1**表示为用模板发起
1264
1289
  */
1265
1290
  ResourceType: number
1266
1291
  /**
1267
- * 合同流程基础信息
1292
+ * 要创建的合同信息
1268
1293
  */
1269
1294
  FlowInfo: BaseFlowInfo
1270
1295
  /**
1271
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
1296
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1297
+
1298
+ 此接口下面信息必填。
1299
+ <ul>
1300
+ <li>渠道应用标识: Agent.AppId</li>
1301
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1302
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1303
+ </ul>
1304
+ 第三方平台子客企业和员工必须已经经过实名认证
1272
1305
  */
1273
1306
  Agent?: Agent
1274
1307
  /**
1275
- * 合同流程配置信息,用于配置发起合同时定制化
1308
+ * 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
1276
1309
  */
1277
1310
  FlowOption?: CreateFlowOption
1278
1311
  /**
@@ -1280,7 +1313,7 @@ export interface ChannelCreatePrepareFlowRequest {
1280
1313
  */
1281
1314
  FlowApproverList?: Array<CommonFlowApprover>
1282
1315
  /**
1283
- * 通过flowid快速获得之前成功通过页面发起的合同生成链接
1316
+ * 用过去已经通过此接口发起的合同的ID复制个新的合同创建链接
1284
1317
  */
1285
1318
  FlowId?: string
1286
1319
  /**
@@ -2320,7 +2353,7 @@ export interface AutoSignConfig {
2320
2353
  * 设置用户开通自动签时是否绑定个人自动签账号许可。
2321
2354
 
2322
2355
  <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
2323
- </ul>
2356
+ <li>**1**: 不绑定自动签账号许可开通,后续使用合同份额进行合同发起</li></ul>
2324
2357
  */
2325
2358
  LicenseType?: number
2326
2359
  }
@@ -2464,7 +2497,8 @@ export interface ChannelCancelUserAutoSignEnableUrlRequest {
2464
2497
  */
2465
2498
  Operator: UserInfo
2466
2499
  /**
2467
- * 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
2500
+ * 自动签使用的场景值, 可以选择的场景值如下:
2501
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
2468
2502
  */
2469
2503
  SceneKey: string
2470
2504
  /**
@@ -2954,15 +2988,27 @@ export interface SignUrlInfo {
2954
2988
  */
2955
2989
  export interface CommonFlowApprover {
2956
2990
  /**
2957
- * 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
2991
+ * 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
2992
+ <ul>
2993
+ <li>false: 默认值,第三方平台子客企业下员工</li>
2994
+ <li>true: SaaS平台企业下的员工</li>
2995
+ </ul>
2996
+
2958
2997
  */
2959
2998
  NotChannelOrganization: boolean
2960
2999
  /**
2961
- * 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
3000
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3001
+
3002
+ **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)
3003
+ **1** :个人/自然人
3004
+ **3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)
3005
+
3006
+ 注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
3007
+
2962
3008
  */
2963
3009
  ApproverType?: number
2964
3010
  /**
2965
- * 企业id
3011
+ * 电子签平台给企业生成的企业id
2966
3012
  */
2967
3013
  OrganizationId?: string
2968
3014
  /**
@@ -2974,21 +3020,39 @@ export interface CommonFlowApprover {
2974
3020
  */
2975
3021
  OrganizationName?: string
2976
3022
  /**
2977
- * 用户id
3023
+ * 电子签平台给企业员工或者自热人生成的用户id
2978
3024
  */
2979
3025
  UserId?: string
2980
3026
  /**
2981
- * 用户openId,第三方应用集成非静默签子客企业签署人必传
3027
+ * 第三方平台子客企业员工的唯一标识
2982
3028
  */
2983
3029
  OpenId?: string
2984
3030
  /**
2985
- * 签署人名称,saas企业签署人,个人签署人必传
3031
+ * 签署方经办人的姓名。
3032
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2986
3033
  */
2987
3034
  ApproverName?: string
2988
3035
  /**
2989
3036
  * 签署人手机号,saas企业签署人,个人签署人必传
2990
3037
  */
2991
3038
  ApproverMobile?: string
3039
+ /**
3040
+ * 签署方经办人的证件类型,支持以下类型
3041
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
3042
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3043
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
3044
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
3045
+
3046
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
3047
+ */
3048
+ ApproverIdCardType?: string
3049
+ /**
3050
+ * 签署方经办人的证件号码,应符合以下规则
3051
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3052
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3053
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3054
+ */
3055
+ ApproverIdCardNumber?: string
2992
3056
  /**
2993
3057
  * 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
2994
3058
  注意:模板发起时该字段必填
@@ -3003,7 +3067,11 @@ export interface CommonFlowApprover {
3003
3067
  */
3004
3068
  IsFullText?: boolean
3005
3069
  /**
3006
- * 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
3070
+ * 通知签署方经办人的方式, 有以下途径:
3071
+ <ul><li> **SMS** :(默认)短信</li>
3072
+ <li> **NONE** : 不通知</li></ul>
3073
+
3074
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
3007
3075
  */
3008
3076
  NotifyType?: string
3009
3077
  /**
@@ -3011,15 +3079,30 @@ export interface CommonFlowApprover {
3011
3079
  */
3012
3080
  ApproverOption?: CommonApproverOption
3013
3081
  /**
3014
- * 签署控件:文件发起使用
3082
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
3015
3083
  */
3016
3084
  SignComponents?: Array<Component>
3017
3085
  /**
3018
- * 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
3086
+ * 指定个人签署方查看合同的校验方式,可以传值如下:
3087
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
3088
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
3089
+ </li></ul>
3090
+ 注:
3091
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
3092
+ <li>此字段可传多个校验方式</li></ul>
3019
3093
  */
3020
3094
  ApproverVerifyTypes?: Array<number | bigint>
3021
3095
  /**
3022
- * 签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3096
+ * 签署人签署合同时的认证方式
3097
+ <ul><li> **1** :人脸认证</li>
3098
+ <li> **2** :签署密码</li>
3099
+ <li> **3** :运营商三要素</li></ul>
3100
+
3101
+ 默认为1(人脸认证 ),2(签署密码)
3102
+
3103
+ 注:
3104
+ 1. 用<font color='red'>模版创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
3105
+ 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
3023
3106
  */
3024
3107
  ApproverSignTypes?: Array<number | bigint>
3025
3108
  }
@@ -3070,9 +3153,7 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
3070
3153
  Agent: Agent
3071
3154
  /**
3072
3155
  * 自动签使用的场景值, 可以选择的场景值如下:
3073
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3074
-
3075
- 注: `现在仅支持电子处方场景`
3156
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
3076
3157
  */
3077
3158
  SceneKey: string
3078
3159
  /**
@@ -3204,9 +3285,7 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
3204
3285
  Agent: Agent
3205
3286
  /**
3206
3287
  * 自动签使用的场景值, 可以选择的场景值如下:
3207
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3208
-
3209
- 注: `现在仅支持电子处方场景`
3288
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
3210
3289
  */
3211
3290
  SceneKey: string
3212
3291
  /**
@@ -3227,7 +3306,7 @@ export interface ChannelCreateUserAutoSignEnableUrlRequest {
3227
3306
  /**
3228
3307
  * 是否通知开通方,通知类型:
3229
3308
  <ul><li>默认不设置为不通知开通方</li>
3230
- <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
3309
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li></ul>
3231
3310
  */
3232
3311
  NotifyType?: string
3233
3312
  /**
@@ -3736,6 +3815,7 @@ export interface FlowInfo {
3736
3815
  Deadline: number
3737
3816
  /**
3738
3817
  * 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
3818
+ 如果使用模板发起接口,此参数为必填。
3739
3819
 
3740
3820
  可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在**企业模板**中得到合同模板ID。
3741
3821
  */
@@ -4225,7 +4305,7 @@ export interface CreateSignUrlsRequest {
4225
4305
  Mobile?: string
4226
4306
  /**
4227
4307
  * 证件类型,支持以下类型
4228
- <ul><li>ID_CARD : 居民身份证(默认值)</li>
4308
+ <ul><li>ID_CARD : 居民身份证</li>
4229
4309
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4230
4310
  <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
4231
4311
  */
@@ -4954,9 +5034,7 @@ export interface ChannelDescribeUserAutoSignStatusRequest {
4954
5034
  Agent: Agent
4955
5035
  /**
4956
5036
  * 自动签使用的场景值, 可以选择的场景值如下:
4957
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4958
-
4959
- 注: `现在仅支持电子处方场景`
5037
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
4960
5038
  */
4961
5039
  SceneKey: string
4962
5040
  /**
@@ -5283,7 +5361,7 @@ export interface ChannelDisableUserAutoSignRequest {
5283
5361
  Agent: Agent
5284
5362
  /**
5285
5363
  * 自动签使用的场景值, 可以选择的场景值如下:
5286
- <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
5364
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li><li> **OTHER** : 通用场景</li></ul>
5287
5365
  */
5288
5366
  SceneKey: string
5289
5367
  /**
@@ -5872,7 +5950,7 @@ export interface GetDownloadFlowUrlRequest {
5872
5950
  */
5873
5951
  export interface ChannelCreateEmbedWebUrlResponse {
5874
5952
  /**
5875
- * 嵌入的web链接
5953
+ * 嵌入的web链接,5分钟有效
5876
5954
  */
5877
5955
  WebUrl?: string
5878
5956
  /**
@@ -5938,9 +6016,9 @@ export interface CreateChannelOrganizationInfoChangeUrlRequest {
5938
6016
 
5939
6017
  此接口下面信息必填。
5940
6018
  <ul>
5941
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
6019
+ <li>渠道应用标识: Agent.AppId</li>
5942
6020
  <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5943
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
6021
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
5944
6022
  </ul>
5945
6023
  */
5946
6024
  Agent: Agent
@@ -6841,29 +6919,41 @@ export interface DescribeExtendedServiceAuthInfoResponse {
6841
6919
  */
6842
6920
  export interface ChannelCreateEmbedWebUrlRequest {
6843
6921
  /**
6844
- * 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6922
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6923
+
6924
+ 此接口下面信息必填。
6925
+ <ul>
6926
+ <li>渠道应用标识: Agent.AppId</li>
6927
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6928
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6929
+ </ul>
6930
+ 第三方平台子客企业和员工必须已经经过实名认证
6845
6931
  */
6846
6932
  Agent: Agent
6847
6933
  /**
6848
6934
  * 要生成WEB嵌入界面的类型, 可以选择的值如下:
6849
6935
 
6850
- - CREATE_SEAL: 生成创建印章的嵌入页面
6851
- - CREATE_TEMPLATE:生成创建模板的嵌入页面
6852
- - MODIFY_TEMPLATE:生成修改模板的嵌入页面
6853
- - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
6854
- - PREVIEW_FLOW:生成预览合同文档的嵌入页面
6855
- - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
6856
- - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
6857
- - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
6858
- - EXTEND_SERVICE:生成扩展服务的嵌入页面
6936
+ <ul>
6937
+ <li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
6938
+ <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
6939
+ <li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li>
6940
+ <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
6941
+ <li>PREVIEW_FLOW:生成预览合同文档的嵌入页面</li>
6942
+ <li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面</li>
6943
+ <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
6944
+ <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
6945
+ <li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li>
6946
+ </ul>
6859
6947
  */
6860
6948
  EmbedType: string
6861
6949
  /**
6862
6950
  * WEB嵌入的业务资源ID
6863
6951
 
6864
- - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
6865
- - 当EmbedType取值PREVIEW_FLOWPREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
6866
- - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
6952
+ <ul>
6953
+ <li>当EmbedType取值MODIFY_TEMPLATEPREVIEW_TEMPLATE时需要填写模板id作为BusinessId</li>
6954
+ <li>当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId</li>
6955
+ <li>当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId</li>
6956
+ </ul>
6867
6957
  */
6868
6958
  BusinessId?: string
6869
6959
  /**
@@ -407,11 +407,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
407
407
  */
408
408
  ChannelCreateOrganizationModifyQrCode(req: ChannelCreateOrganizationModifyQrCodeRequest, cb?: (error: string, rep: ChannelCreateOrganizationModifyQrCodeResponse) => void): Promise<ChannelCreateOrganizationModifyQrCodeResponse>;
409
409
  /**
410
- * 创建预发起合同
411
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
412
- 可指定合同信息不可更改,签署人信息不可更改
413
- 合同发起后,填写及签署流程与现有操作流程一致
414
- 注意:目前仅支持模板发起
410
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
411
+
412
+ 注意:
413
+ 1. **仅支持模板**发起
414
+ 2. 只支持PC浏览器操作使用
415
+
416
+ 嵌入的页面样式如下:
417
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
415
418
  */
416
419
  ChannelCreatePrepareFlow(req: ChannelCreatePrepareFlowRequest, cb?: (error: string, rep: ChannelCreatePrepareFlowResponse) => void): Promise<ChannelCreatePrepareFlowResponse>;
417
420
  /**
@@ -760,6 +763,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
760
763
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
761
764
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
762
765
  </ul>
766
+
767
+
768
+ 注意:
769
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
770
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
763
771
  */
764
772
  CreateChannelOrganizationInfoChangeUrl(req: CreateChannelOrganizationInfoChangeUrlRequest, cb?: (error: string, rep: CreateChannelOrganizationInfoChangeUrlResponse) => void): Promise<CreateChannelOrganizationInfoChangeUrlResponse>;
765
773
  /**
@@ -886,8 +894,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
886
894
  ChannelCreateFlowGroupByFiles(req: ChannelCreateFlowGroupByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowGroupByFilesResponse) => void): Promise<ChannelCreateFlowGroupByFilesResponse>;
887
895
  /**
888
896
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
889
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
890
- 进入web连接后与当前控制台操作保持一致
897
+
898
+ 本接口下面功能的签署页面链接的生成
899
+ - 创建印章
900
+ - 创建模板
901
+ - 修改模板
902
+ - 预览模板
903
+ - 预览合同流程
891
904
  */
892
905
  ChannelCreateEmbedWebUrl(req: ChannelCreateEmbedWebUrlRequest, cb?: (error: string, rep: ChannelCreateEmbedWebUrlResponse) => void): Promise<ChannelCreateEmbedWebUrlResponse>;
893
906
  /**
@@ -476,11 +476,14 @@ class Client extends TencentCloudCommon.AbstractClient {
476
476
  return this.request("ChannelCreateOrganizationModifyQrCode", req, cb);
477
477
  }
478
478
  /**
479
- * 创建预发起合同
480
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
481
- 可指定合同信息不可更改,签署人信息不可更改
482
- 合同发起后,填写及签署流程与现有操作流程一致
483
- 注意:目前仅支持模板发起
479
+ * 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
480
+
481
+ 注意:
482
+ 1. **仅支持模板**发起
483
+ 2. 只支持PC浏览器操作使用
484
+
485
+ 嵌入的页面样式如下:
486
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
484
487
  */
485
488
  async ChannelCreatePrepareFlow(req, cb) {
486
489
  return this.request("ChannelCreatePrepareFlow", req, cb);
@@ -883,6 +886,11 @@ class Client extends TencentCloudCommon.AbstractClient {
883
886
  <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
884
887
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
885
888
  </ul>
889
+
890
+
891
+ 注意:
892
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
893
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
886
894
  */
887
895
  async CreateChannelOrganizationInfoChangeUrl(req, cb) {
888
896
  return this.request("CreateChannelOrganizationInfoChangeUrl", req, cb);
@@ -1023,8 +1031,13 @@ class Client extends TencentCloudCommon.AbstractClient {
1023
1031
  }
1024
1032
  /**
1025
1033
  * 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
1026
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
1027
- 进入web连接后与当前控制台操作保持一致
1034
+
1035
+ 本接口下面功能的签署页面链接的生成
1036
+ - 创建印章
1037
+ - 创建模板
1038
+ - 修改模板
1039
+ - 预览模板
1040
+ - 预览合同流程
1028
1041
  */
1029
1042
  async ChannelCreateEmbedWebUrl(req, cb) {
1030
1043
  return this.request("ChannelCreateEmbedWebUrl", req, cb);