tencentcloud-sdk-nodejs-ess 4.0.683 → 4.0.685

package/src/services/ess/v20201111/ess_models.ts

@@ -555,39 +555,39 @@ export interface CreateFlowOption {
 }
 
 /**
- * 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
-注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。
-注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。
-注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。
+ * 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
+`注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
+`注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
+`注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
  */
 export interface ReleasedApprover {
   /**
-   * 签署人姓名，最大长度50个字符
+   * 签署人姓名，最大长度50个字。
 
    */
   Name: string
   /**
-   * 签署人手机号
+   * 签署人手机号。
    */
   Mobile: string
   /**
-   * 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取（即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId ）
+   * 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
    */
   RelievedApproverReceiptId: string
   /**
    * 指定签署人类型，目前仅支持
-ORGANIZATION-企业
-ENTERPRISESERVER-企业静默签
+<ul><li> **ORGANIZATION**：企业（默认值）</li>
+<li> **ENTERPRISESERVER**：企业静默签</li></ul>
    */
   ApproverType?: string
   /**
-   * 签署控件类型，支持自定义企业签署方的签署控件为“印章”或“签名”
-- SIGN_SEAL-默认为印章控件类型
-- SIGN_SIGNATURE-手写签名控件类型
+   * 签署控件类型，支持自定义企业签署方的签署控件类型
+<ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
+<li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
    */
   ApproverSignComponentType?: string
   /**
-   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。  如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
+   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字。
    */
   ApproverSignRole?: string
 }
@@ -649,9 +649,9 @@ export interface CreateFlowEvidenceReportRequest {
 export interface StartFlowResponse {
   /**
    * 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
-START - 发起成功
-REVIEW - 提交审核成功
-EXECUTING - 已提交发起任务
+<ul><li> **START** : 发起成功, 合同进入签署环节</li>
+<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境  `白名单功能，使用前请联系对接的客户经理沟通。`</li>
+<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
    */
   Status?: string
   /**
@@ -754,23 +754,39 @@ export interface AuthorizedUser {
  */
 export interface CreateConvertTaskApiRequest {
   /**
-   * 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
+   * 需要进行转换的资源文件类型
+支持的文件类型如下：
+<ul><li>doc</li>
+<li>docx</li>
+<li>xls</li>
+<li>xlsx</li>
+<li>jpg</li>
+<li>jpeg</li>
+<li>png</li>
+<li>bmp</li>
+<li>txt</li></ul>
    */
   ResourceType: string
   /**
-   * 资源名称，长度限制为256字符
+   * 需要进行转换操作的文件资源名称，带资源后缀名。
+
+注:  `资源名称长度限制为256个字符`
    */
   ResourceName: string
   /**
-   * 文件Id，通过UploadFiles获取
+   * 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
+
+注:  `目前，此接口仅支持单个文件进行转换。`
    */
   ResourceId: string
   /**
-   * 调用方用户信息，userId 必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator?: UserInfo
   /**
-   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
@@ -1183,11 +1199,16 @@ false-未发布
  */
 export interface CreateDocumentResponse {
   /**
-   * 签署流程电子文档ID
+   * 合同流程的底层电子文档ID，为32位字符串。
+
+注:
+后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>，合同才能进入签署环节
    */
   DocumentId?: string
   /**
-   * 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
+   * 合同预览链接URL。
+
+注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
 注意：此字段可能返回 null，表示取不到有效值。
    */
   PreviewFileUrl?: string
@@ -1257,73 +1278,103 @@ export interface CreateIntegrationUserRolesResponse {
  */
 export interface CreateFlowRequest {
   /**
-   * 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
+   * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+支持填入集团子公司经办人 userId 代发合同。
+
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 签署流程名称,最大长度200个字符
+   * 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+
+该名称还将用于合同签署完成后的下载文件名。
    */
   FlowName: string
   /**
-   * 签署流程参与者信息，最大限制50方
-注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
+   * 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
+
+注:  `approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效`
    */
   Approvers: Array<FlowCreateApprover>
   /**
-   * 签署流程描述,最大长度1000个字符
+   * 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
    */
   FlowDescription?: string
   /**
-   * 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
+   * 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
    */
   FlowType?: string
   /**
-   * 客户端Token，保持接口幂等性,最大长度64个字符
+   * 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
    */
   ClientToken?: string
   /**
-   * 签署流程的签署截止时间。
-
-值为unix时间戳,精确到秒,不传默认为当前时间一年后
+   * 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
+如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
    */
   DeadLine?: number
   /**
-   * 合同到期提醒时间戳，单位秒。设定该值后，可以提前进行到期通知，方便客户处理合同到期事务，如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
+   * 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
+
+到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
    */
   RemindedOn?: number
   /**
-   * 用户自定义字段，回调的时候会进行透传，长度需要小于20480
+   * 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
+
+在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
    */
   UserData?: string
   /**
-   * 发送类型：
-true：无序签
-false：有序签
-注：默认为false（有序签），请和模板中的配置保持一致
+   * 合同流程的签署顺序类型：
+<ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
+<li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
+注：`请和模板中的配置保持一致`
    */
   Unordered?: boolean
   /**
-   * 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
+   * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
+<ul><li>{合同名称}   </li>
+<li>{发起方企业} </li>
+<li>{发起方姓名} </li>
+<li>{签署方N企业}</li>
+<li>{签署方N姓名}</li></ul>
+其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
+
+例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
+
+合同名称：租房合同 
+发起方：腾讯公司(张三) 
+签署方：李四
+
+
    */
   CustomShowMap?: string
   /**
-   * 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
-若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
-
-注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
+   * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
+<ul><li> **false**：（默认）不需要审批，直接签署。</li>
+<li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
+企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
+<ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
+<li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
+注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    */
   NeedSignReview?: boolean
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 被抄送人的信息列表。
-注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。
+   * 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
+
+注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
    */
   CcInfos?: Array<CcInfo>
   /**
-   * 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
+   * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签）  </li></ul>
+注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
    */
   AutoSignScene?: string
   /**
@@ -1425,50 +1476,49 @@ export interface DeleteIntegrationDepartmentResponse {
  */
 export interface AutoSignConfig {
   /**
-   * 自动签开通个人用户的三要素
+   * 自动签开通个人用户信息, 包括名字,身份证等
    */
   UserInfo: UserThreeFactor
   /**
-   * 接受回调URL地址。支持http://或者https://协议
-
-Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
-   */
-  CallbackUrl: string
-  /**
-   * 是否回调证书信息
-false-不需要 (默认值)
-true-需要
+   * 是否回调证书信息:
+<ul><li>**false**: 不需要(默认)</li>
+<li>**true**:需要</li></ul>
    */
   CertInfoCallback?: boolean
   /**
-   * 是否支持用户自定义签名印章
-false-不需要(默认)
-true-需要
+   * 是否支持用户自定义签名印章:
+<ul><li>**false**: 不能自己定义(默认)</li>
+<li>**true**: 可以自己定义</li></ul>
    */
   UserDefineSeal?: boolean
   /**
-   * 是否需要回调的时候返回印章(签名) 图片的 base64
-
-false-不需要(默认)
-true-需要
+   * 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
+<ul><li>**false**: 不需要(默认)</li>
+<li>**true**: 需要</li></ul>
    */
   SealImgCallback?: boolean
   /**
-   * 开通时候的验证方式, 分布为
-
-WEIXINAPP : 微信人脸识别
-INSIGHT : 慧眼人脸认别
-TELECOM : 运营商三要素验证
-
-如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。
-
-如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
+   * 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
+腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
+回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
+   * @deprecated
+   */
+  CallbackUrl?: string
+  /**
+   * 开通时候的身份验证方式, 取值为：
+<ul><li>**WEIXINAPP** : 微信人脸识别</li>
+<li>**INSIGHT** : 慧眼人脸认别</li>
+<li>**TELECOM** : 运营商三要素验证</li></ul>
+注：
+<ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
+<li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
    */
   VerifyChannels?: Array<string>
   /**
-   * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。
-0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
-1-不绑定，发起合同时将按标准合同套餐进行扣减
+   * 设置用户开通自动签时是否绑定个人自动签账号许可。
+
+<ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
+<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
 
    */
   LicenseType?: number
@@ -1762,20 +1812,23 @@ export interface DescribeUserAutoSignStatusResponse {
    */
   IsOpen?: boolean
   /**
-   * 自动签许可生效时间。当且仅当已开通自动签时有值。
+   * 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
 
 值为unix时间戳,单位为秒。
    */
   LicenseFrom?: number
   /**
-   * 自动签许可到期时间。当且仅当已开通自动签时有值。
+   * 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
+
 值为unix时间戳,单位为秒。
    */
   LicenseTo?: number
   /**
-   * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。
-0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
-1-不绑定，发起合同时将按标准合同套餐进行扣减
+   * 设置用户开通自动签时是否绑定个人自动签账号许可。
+
+<ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
+<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
+
    */
   LicenseType?: number
   /**
@@ -2068,20 +2121,22 @@ export interface CreateSealPolicyResponse {
  */
 export interface DisableUserAutoSignRequest {
   /**
-   * 操作人信息,UserId必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 自动签场景:
-E_PRESCRIPTION_AUTO_SIGN 电子处方
+   * 自动签使用的场景值, 可以选择的场景值如下:
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
    */
   SceneKey: string
   /**
-   * 关闭自动签的个人的三要素
+   * 需要关闭自动签的个人的信息，如姓名，证件信息等。
    */
   UserInfo: UserThreeFactor
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -2137,7 +2192,7 @@ export interface SuccessDeleteStaffData {
  */
 export interface CreateConvertTaskApiResponse {
   /**
-   * 转换任务Id
+   * 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
    */
   TaskId?: string
   /**
@@ -2236,27 +2291,37 @@ export interface CreateSchemeUrlResponse {
  */
 export interface CreateUserAutoSignEnableUrlResponse {
   /**
-   * 跳转短链
+   * 个人用户自动签的开通链接, 短链形式
    */
   Url?: string
   /**
-   * 小程序AppId
+   * 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+注: `如果获取的是H5链接, 则不会返回此值`
    */
   AppId?: string
   /**
-   * 小程序 原始 Id
+   * 腾讯电子签小程序的原始 Id,  ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+注: `如果获取的是H5链接, 则不会返回此值`
    */
   AppOriginalId?: string
   /**
-   * 跳转路径
+   * 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
+
+注: `如果获取的是H5链接, 则不会返回此值`
    */
   Path?: string
   /**
-   * base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
+   * base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
+
+注: `如果获取的是H5链接, 则不会返回此二维码图片`
    */
   QrCode?: string
   /**
-   * 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
+   * 返回的链接类型
+<ul><li> 空: 默认小程序端链接</li>
+<li> **H5SIGN** : h5端链接</li></ul>
    */
   UrlType?: string
   /**
@@ -2703,46 +2768,52 @@ export interface ModifyIntegrationRoleResponse {
  */
 export interface FlowCreateApprover {
   /**
-   * 参与者类型：
+   * 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
 0：企业
 1：个人
-3：企业自动签署
-注：类型为3（企业自动签署）时，会自动完成该签署方的签署。
-自动签署仅进行盖章操作，不能是手写签名。
-本方企业自动签署的签署人会默认是当前的发起人
-他方企业自动签署的签署人是自动签模板的他方企业授权人
+3：企业静默签署
+注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
 7: 个人自动签署，适用于个人自动签场景。
-注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
+注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
    */
   ApproverType: number
   /**
-   * 签署人企业名称
-当approverType=0 或 approverType=3时，必须指定
+   * 组织机构名称。
+请确认该名称与企业营业执照中注册的名称一致。
+如果名称中包含英文括号()，请使用中文括号（）代替。
+
+注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
 
 
    */
   OrganizationName?: string
   /**
-   * 签署方经办人姓名
-<br/>在未指定签署人电子签UserId情况下，为必填参数
+   * 签署方经办人的姓名。
+经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
+
+在未指定签署人电子签UserId情况下，为必填参数
    */
   ApproverName?: string
   /**
-   * 签署方经办人手机号码
-<br/>在未指定签署人电子签UserId情况下，为必填参数
+   * 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
+请确认手机号所有方为此合同签署方。
+
+在未指定签署人电子签UserId情况下，为必填参数
 
    */
   ApproverMobile?: string
   /**
-   * 签署人的证件类型
-ID_CARD 身份证
-HONGKONG_AND_MACAO 港澳居民来往内地通行证
-HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
-OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
+   * 证件类型，支持以下类型
+<ul><li>ID_CARD : 居民身份证 (默认值)</li>
+<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
+<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
    */
   ApproverIdCardType?: string
   /**
-   * 签署人证件号（长度不超过18位）
+   * 证件号码，应符合以下规则
+<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
    */
   ApproverIdCardNumber?: string
   /**
@@ -2753,15 +2824,17 @@ OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   RecipientId?: string
   /**
-   * 签署意愿确认渠道,WEIXINAPP:人脸识别
+   * 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
+
+注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
    */
   VerifyChannel?: Array<string>
   /**
-   * 是否发送短信
-<br/>sms--短信通知
-<br/>none--不通知
-<br/>默认为sms
-<br/>发起方=签署方时不发送短信
+   * 通知签署方经办人的方式,  有以下途径:
+<ul><li>  **sms**  :  (默认)短信</li>
+<li>   **none**   : 不通知</li></ul>
+
+注: `发起方也是签署方时不给此签署方发送短信`
    */
   NotifyType?: string
   /**
@@ -2775,32 +2848,30 @@ OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
   /**
    * 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
 
-若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息
+注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
    */
   UserId?: string
   /**
-   * 当前只支持true，默认为true
+   * 字段已经废弃，当前只支持true，默认为true
    */
   Required?: boolean
   /**
-   * 签署人用户来源，此参数仅针对企微用户开放
-
-企微侧用户请传入：WEWORKAPP
+   * 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
    */
   ApproverSource?: string
   /**
-   * 企业签署方或签标识，客户自定义，64位长度
-<br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
-<br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
-<br/>如果或签签署人为本方企微参与人，ApproverSource参数需要指定WEWORKAPP
+   * 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
+所有参与或签的人员均需具备该标识。
+注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
+如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
    */
   CustomApproverTag?: string
   /**
-   * 快速注册相关信息，目前暂未开放！
+   * 已经废弃, 快速注册相关信息
    */
   RegisterInfo?: RegisterInfo
   /**
-   * 签署人个性化能力值
+   * 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签等功能开关。
    */
   ApproverOption?: ApproverOption
   /**
@@ -2815,20 +2886,39 @@ OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   SignId?: string
   /**
-   * 当前签署方进行签署操作是否需要企业内部审批
-<br>true 则为需要
-<br/>false,无序企业内部审批（默认）
-<br/>为个人签署方时则由发起方企业审核。
+   * 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
+<ul><li>**false**：（默认）不需要审批，直接签署。</li>
+<li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
+企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
+<ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
+<li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
+
+注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    */
   ApproverNeedSignReview?: boolean
   /**
    * 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
-<br/>文件发起时，可通过该参数为签署人指定签署控件类型以及位置
+
+合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
+<ul><li> 个人签名/印章</li>
+<li> 企业印章</li>
+<li> 骑缝章等签署控件</li></ul>
+
+`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
    */
   SignComponents?: Array<Component>
   /**
    * 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
-<br/>文件发起时，可通过该参数为签署人指定填写控件类型以及位置
+
+合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
+<ul><li>单行文本控件</li>
+<li>多行文本控件</li>
+<li>勾选框控件</li>
+<li>数字控件</li>
+<li>图片控件</li>
+<li>动态表格等填写控件</li></ul>
+
+`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
    */
   Components?: Array<Component>
   /**
@@ -2840,15 +2930,30 @@ OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
    */
   ComponentLimitType?: Array<string>
   /**
-   * 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
+   * 指定个人签署方查看合同的校验方式,可以传值如下:
+<ul><li>  **1**   : （默认）人脸识别,人脸识别后才能合同内容</li>
+<li>  **2**  : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
+</li></ul>
+注: 
+<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式,    则忽略此签署人的查看合同的校验方式</li>
+<li>此字段不可传多个校验方式</li></ul>
+
+`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
 
-> 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
+.
    */
   ApproverVerifyTypes?: Array<number | bigint>
   /**
-   * 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
+   * 您可以指定签署方签署合同的认证校验方式，可传递以下值：
+<ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li>
+<li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>
+<li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>
+注：
+<ul><li>默认情况下，认证校验方式为人脸认证和签署密码两种形式；</li>
+<li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
 
-> 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
+注:
+`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
    */
   ApproverSignTypes?: Array<number | bigint>
 }
@@ -3146,11 +3251,13 @@ export interface CreateDocumentRequest {
    */
   Operator: UserInfo
   /**
-   * 签署流程编号,由CreateFlow接口返回
+   * 合同流程ID，为32位字符串。
+此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
    */
   FlowId: string
   /**
-   * 用户上传的模板ID
+   * 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
+可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
    */
   TemplateId: string
   /**
@@ -3158,24 +3265,30 @@ export interface CreateDocumentRequest {
    */
   FileNames?: Array<string>
   /**
-   * 内容控件信息数组
+   * 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
    */
   FormFields?: Array<FormField>
   /**
-   * 是否需要生成预览文件 默认不生成；
-预览链接有效期300秒；
+   * 是否为预览模式，取值如下：
+<ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
+<li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
    */
   NeedPreview?: boolean
   /**
-   * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
+   * 预览模式下产生的预览链接类型 
+<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
+<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
+注: `此参数在NeedPreview 为true时有效`
+
    */
   PreviewType?: number
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 客户端Token，保持接口幂等性,最大长度64个字符
+   * 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
    */
   ClientToken?: string
 }
@@ -3725,8 +3838,10 @@ export interface CreateReleaseFlowRequest {
    */
   Deadline?: number
   /**
-   * 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+   * 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
+
 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+
 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
    */
   UserData?: string
@@ -4210,29 +4325,31 @@ export interface CreateStaffResult {
  */
 export interface CreateUserAutoSignEnableUrlRequest {
   /**
-   * 操作人信息,UserId必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 自动签场景:
-E_PRESCRIPTION_AUTO_SIGN 电子处方
+   * 自动签使用的场景值, 可以选择的场景值如下:
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li></ul>
+
+注: `现在仅支持电子处方场景`
    */
   SceneKey: string
   /**
-   * 自动签开通，签署相关配置
+   * 自动签开通配置信息, 包括开通的人员的信息等
    */
   AutoSignConfig: AutoSignConfig
   /**
-   * 链接类型，
-空-默认小程序端链接
-H5SIGN-h5端链接
+   * 生成的链接类型：
+<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
+<li> **H5SIGN** : 生成H5端开通链接</li></ul>
    */
   UrlType?: string
   /**
-   * 通知类型
-
-默认不设置为不通知开通方，
-SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
+   * 是否通知开通方，通知类型:
+<ul><li>默认不设置为不通知开通方</li>
+<li>**SMS** :  短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
    */
   NotifyType?: string
   /**
@@ -4240,11 +4357,12 @@ SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
    */
   NotifyAddress?: string
   /**
-   * 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为30天。如果不传，默认有效期为7天。
+   * 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
    */
   ExpiredTime?: number
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -4312,14 +4430,14 @@ export interface CancelUserAutoSignEnableUrlRequest {
    */
   Operator: UserInfo
   /**
-   * 企业开通用户自动签场景，例如电子处方。
-<ul>
-<li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
-</ul>
+   * 自动签使用的场景值, 可以选择的场景值如下:
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li></ul>
+
+注: `现在仅支持电子处方场景`
    */
   SceneKey: string
   /**
-   * 指定撤销链接的用户指定撤销链接的用户信息，包含姓名、证件类型、证件号码。
+   * 预撤销链接的用户信息，包含姓名、证件类型、证件号码等信息。
 
    */
   UserInfo: UserThreeFactor
@@ -4677,8 +4795,8 @@ export interface StartFlowRequest {
   Agent?: Agent
   /**
    * 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
-0 - 合同发起时通知（默认）
-1 - 签署完成后通知
+<ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
+<li> **1** : 签署完成后通知对方来查看合同</li></ul>
    */
   CcNotifyType?: number
 }
@@ -5820,11 +5938,13 @@ export interface CancelMultiFlowSignQRCodeResponse {
  */
 export interface CreateFlowResponse {
   /**
-   * 签署流程编号，
+   * 合同流程ID，为32位字符串。
+建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+
+注:
+此返回的合同流程ID，需再次调用<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>接口将合同开始后，合同才能进入签署环节
 
-返回的流程编号，需要在CreateDocument，StartFlow中使用，
 
-注意：这三个接口（CreateFlow，CreateDocument，StartFlow）要一并调用，才算发起成功
    */
   FlowId?: string
   /**
@@ -5838,20 +5958,24 @@ export interface CreateFlowResponse {
  */
 export interface DescribeUserAutoSignStatusRequest {
   /**
-   * 操作人信息，UserId必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 自动签场景:
-E_PRESCRIPTION_AUTO_SIGN 电子处方
+   * 自动签使用的场景值, 可以选择的场景值如下:
+<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
+
+注: `现在仅支持电子处方场景`
    */
   SceneKey: string
   /**
-   * 要查询开启状态的用户信息
+   * 要查询状态的用户信息, 包括名字,身份证等
    */
   UserInfo: UserThreeFactor
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }