tencentcloud-sdk-nodejs-ess 4.0.685 → 4.0.687

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

@@ -406,7 +406,10 @@ export interface ReviewerInfo {
  */
 export interface DescribeThirdPartyAuthCodeResponse {
   /**
-   * 用户是否实名，VERIFIED 为实名，UNVERIFIED 未实名
+   * AuthCode 中对应个人用户是否实名
+<ul>
+<li> **VERIFIED** : 此个人已实名</li>
+<li> **UNVERIFIED**: 此个人未实名</li></ul>
    */
   VerifyStatus?: string
   /**
@@ -587,7 +590,10 @@ export interface ReleasedApprover {
    */
   ApproverSignComponentType?: string
   /**
-   * 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字。
+   * 参与方在合同中的角色是按照创建合同的时候来排序的，解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`,  第三个叫`丙方`，以此类推。
+
+如果需改动此参与人的角色名字，可用此字段指定，由汉字,英文字符,数字组成，最大20个字。
+
    */
   ApproverSignRole?: string
 }
@@ -1235,7 +1241,9 @@ export interface DescribeIntegrationEmployeesRequest {
    */
   Agent?: Agent
   /**
-   * 查询过滤实名用户，Key为Status，Values为["IsVerified"]
+   * 查询过滤实名用户，Key为Status，Values为["IsVerified"]，查询过滤未实名用户，Key为Status，Values为["NotVerified"]
+查询某个部门的用户，Key为DepartmentId，Values为["DepartmentId"]
+根据用户Id查询员工时，Key为UserId，Values为["UserId"]
 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
    */
   Filters?: Array<Filter>
@@ -1529,15 +1537,17 @@ export interface AutoSignConfig {
  */
 export interface DescribeThirdPartyAuthCodeRequest {
   /**
-   * 电子签小程序跳转客户小程序时携带的授权查看码
+   * 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码，AuthCode由腾讯电子签小程序生成。
    */
   AuthCode: string
   /**
-   * 操作人信息
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator?: UserInfo
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -1689,6 +1699,35 @@ export interface Permission {
   Children?: Array<Permission>
 }
 
+/**
+ * 签署控件的类型和范围限制条件，用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
+ */
+export interface ComponentLimit {
+  /**
+   * 控件类型，支持以下类型
+<ul><li>SIGN_SEAL : 印章控件</li>
+<li>SIGN_PAGING_SEAL : 骑缝章控件</li>
+<li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
+<li>SIGN_SIGNATURE : 用户签名控件</li></ul>
+   */
+  ComponentType: string
+  /**
+   * 签署控件类型的值(可选)，用与限制签署时印章或者签名的选择范围
+
+1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id（支持多个）
+
+2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型（支持多个）
+
+<ul><li>HANDWRITE : 手写签名</li>
+<li>OCR_ESIGN : OCR印章（智慧手写签名）</li>
+<li>ESIGN : 个人印章</li>
+<li>SYSTEM_ESIGN : 系统印章</li></ul>
+
+3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
+   */
+  ComponentValue?: Array<string>
+}
+
 /**
  * CreateIntegrationDepartment返回参数结构体
  */
@@ -1926,26 +1965,33 @@ export interface OccupiedSeal {
  */
 export interface CreatePersonAuthCertificateImageResponse {
   /**
-   * 个人用户证明证书的下载链接
+   * 个人用户认证证书图片下载URL，`有效期为5分钟`，超过有效期后将无法再下载。
    */
   AuthCertUrl?: string
   /**
-   * 证书图片上的证书编号，20位数字
+   * 个人用户认证证书的编号, 为20位数字组成的字符串,  由腾讯电子签下发此编号 。
+该编号会合成到个人用户证书证明图片。
+
+注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ImageCertId?: string
   /**
-   * 图片证明对应的CA证书序列号
+   * CA供应商下发给用户的证书编号，在证书到期后自动续期后此证书编号会发生变动，且不会合成到个人用户证书证明图片中。
+
+注意：`腾讯电子签接入多家CA供应商以提供容灾能力，不同CA下发的证书编号区别较大，但基本都是由数字和字母组成，长度在200以下。`
 注意：此字段可能返回 null，表示取不到有效值。
    */
   SerialNumber?: string
   /**
-   * CA证书颁发时间戳
+   * CA证书颁发时间，格式为Unix标准时间戳（秒）   
+该时间格式化后会合成到个人用户证书证明图片
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ValidFrom?: number
   /**
-   * CA证书有效截止时间戳
+   * CA证书有效截止时间，格式为Unix标准时间戳（秒）
+该时间格式化后会合成到个人用户证书证明图片
 注意：此字段可能返回 null，表示取不到有效值。
    */
   ValidTo?: number
@@ -2677,20 +2723,6 @@ DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
   ComponentName?: string
 }
 
-/**
- * CreateChannelSubOrganizationModifyQrCode请求参数结构体
- */
-export interface CreateChannelSubOrganizationModifyQrCodeRequest {
-  /**
-   * 操作人信息，userId必填
-   */
-  Operator: UserInfo
-  /**
-   * 应用编号
-   */
-  ApplicationId: string
-}
-
 /**
  * 用户信息
  */
@@ -3294,65 +3326,23 @@ export interface CreateDocumentRequest {
 }
 
 /**
- * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
+ * 催办接口返回的详细信息。
  */
-export interface FlowDetailInfo {
-  /**
-   * 合同(流程)的ID
-   */
-  FlowId?: string
-  /**
-   * 合同(流程)的名字
-   */
-  FlowName?: string
-  /**
-   * 合同(流程)的类型
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowType?: string
-  /**
-   * 流程状态
-- 0 还没有发起
-- 1 待签署
-- 2 部分签署
-- 3 已拒签
-- 4 已签署
-- 5 已过期
-- 6 已撤销
-- 7 还没有预发起
-- 8 等待填写
-- 9 部分填写
-- 10 拒填
-- 21 已解除
-   */
-  FlowStatus?: number
-  /**
-   * 合同(流程)的信息
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowMessage?: string
-  /**
-   * 流程的描述
-注意：此字段可能返回 null，表示取不到有效值。
-   */
-  FlowDescription?: string
-  /**
-   * 合同(流程)的创建时间戳，单位秒
-   */
-  CreatedOn?: number
+export interface RemindFlowRecords {
   /**
-   * 合同(流程)的签署方数组
+   * 合同流程是否可以催办：
+true - 可以，false - 不可以。
+若无法催办，将返回RemindMessage以解释原因。
    */
-  FlowApproverInfos?: Array<FlowApproverDetail>
+  CanRemind?: boolean
   /**
-   * 合同(流程)的关注方信息列表
+   * 合同流程ID，为32位字符串。
    */
-  CcInfos?: Array<FlowApproverDetail>
+  FlowId?: string
   /**
-   * 合同发起人UserId
-注意：此字段可能返回 null，表示取不到有效值。
+   * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
    */
-  Creator?: string
+  RemindMessage?: string
 }
 
 /**
@@ -3392,7 +3382,8 @@ export interface DescribeOrganizationSealsResponse {
  */
 export interface CreateEmbedWebUrlRequest {
   /**
-   * 操作者信息
+   * 执行本接口操作的员工信息。
+<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
@@ -3417,7 +3408,8 @@ export interface CreateEmbedWebUrlRequest {
    */
   BusinessId?: string
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作
+   * 代理企业和员工的信息。
+<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
@@ -3425,7 +3417,7 @@ export interface CreateEmbedWebUrlRequest {
    */
   Reviewer?: ReviewerInfo
   /**
-   * 个性化参数
+   * 个性化参数，用于控制页面展示内容
    */
   Option?: EmbedUrlOption
 }
@@ -3816,7 +3808,7 @@ export interface CreateReleaseFlowRequest {
    */
   NeedRelievedFlowId: string
   /**
-   * 解除协议内容。
+   * 解除协议内容, 包括解除理由等信息。
    */
   ReliveInfo: RelieveInfo
   /**
@@ -3824,12 +3816,12 @@ export interface CreateReleaseFlowRequest {
    */
   Agent?: Agent
   /**
-   * 解除协议的签署人列表(如不指定该参数，默认使用原流程的签署人列表)。 <br/>
-如需更换原合同中的签署人，可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
-解除协议的签署人数量不能多于原流程的签署人数量。<br/>
+   * 替换解除协议的签署人， 如不指定替换签署人,  则使用原流程的签署人。 <br/>
+如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
 
-`注意：只能更换同企业的签署人。`<br/>
-`注意：不支持更换个人类型的签署人。`<br/>
+注意：
+`只能更换自己企业的签署人,  不支持更换个人类型或者其他企业的签署人。`
+`可以不指定替换签署人, 使用原流程的签署人 `
    */
   ReleasedApprovers?: Array<ReleasedApprover>
   /**
@@ -3870,21 +3862,65 @@ export interface CreateIntegrationUserRolesRequest {
 }
 
 /**
- * CreateChannelSubOrganizationModifyQrCode返回参数结构体
+ * 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
  */
-export interface CreateChannelSubOrganizationModifyQrCodeResponse {
+export interface FlowDetailInfo {
   /**
-   * 二维码下载链接
+   * 合同(流程)的ID
    */
-  QrCodeUrl?: string
+  FlowId?: string
   /**
-   * 二维码失效时间 UNIX 时间戳 精确到秒
+   * 合同(流程)的名字
    */
-  ExpiredTime?: number
+  FlowName?: string
   /**
-   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   * 合同(流程)的类型
+注意：此字段可能返回 null，表示取不到有效值。
    */
-  RequestId?: string
+  FlowType?: string
+  /**
+   * 流程状态
+- 0 还没有发起
+- 1 待签署
+- 2 部分签署
+- 3 已拒签
+- 4 已签署
+- 5 已过期
+- 6 已撤销
+- 7 还没有预发起
+- 8 等待填写
+- 9 部分填写
+- 10 拒填
+- 21 已解除
+   */
+  FlowStatus?: number
+  /**
+   * 合同(流程)的信息
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowMessage?: string
+  /**
+   * 流程的描述
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  FlowDescription?: string
+  /**
+   * 合同(流程)的创建时间戳，单位秒
+   */
+  CreatedOn?: number
+  /**
+   * 合同(流程)的签署方数组
+   */
+  FlowApproverInfos?: Array<FlowApproverDetail>
+  /**
+   * 合同(流程)的关注方信息列表
+   */
+  CcInfos?: Array<FlowApproverDetail>
+  /**
+   * 合同发起人UserId
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Creator?: string
 }
 
 /**
@@ -3910,7 +3946,8 @@ export interface SuccessUpdateStaffData {
  */
 export interface CreatePersonAuthCertificateImageRequest {
   /**
-   * 操作人信息
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
@@ -3918,20 +3955,24 @@ export interface CreatePersonAuthCertificateImageRequest {
    */
   UserName: string
   /**
-   * 身份证件类型取值：
-ID_CARD 身居民身份证
-PASSPORT 护照
-HONGKONG_AND_MACAO 港澳居民来往内地通行证
-FOREIGN_ID_CARD 外国人永久居留身份证
-HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
+   * 证件类型，支持以下类型
+<ul><li> ID_CARD  : 居民身份证 (默认值)</li>
+<li> PASSPORT  : 护照</li>
+<li> FOREIGN_ID_CARD  : 外国人永久居留身份证</li>
+<li> HONGKONG_AND_MACAO  : 港澳居民来往内地通行证</li>
+<li> HONGKONG_MACAO_AND_TAIWAN  : 港澳台居民居住证(格式同居民身份证)</li></ul>
    */
   IdCardType: string
   /**
-   * 身份证件号码
+   * 证件号码，应符合以下规则
+<ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
+<li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
+<li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
    */
   IdCardNumber: string
   /**
-   * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -4242,6 +4283,12 @@ export interface ApproverInfo {
 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
    */
   ApproverNeedSignReview?: boolean
+  /**
+   * [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型（骑缝章、普通章法人章等）和具体的印章（印章ID）或签名方式。
+
+注：`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章（通过传递ComponentValue,支持多个），他方企业或个人只支持限制控件类型。`
+   */
+  AddSignComponentsLimits?: Array<ComponentLimit>
 }
 
 /**
@@ -4372,11 +4419,11 @@ export interface CreateUserAutoSignEnableUrlRequest {
  */
 export interface CreateOrganizationBatchSignUrlResponse {
   /**
-   * 批量签署入口链接
+   * 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
    */
   SignUrl?: string
   /**
-   * 链接过期时间戳
+   * 链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
    */
   ExpiredTime?: number
   /**
@@ -4400,26 +4447,6 @@ export interface DescribeIntegrationMainOrganizationUserResponse {
   RequestId?: string
 }
 
-/**
- * 催办接口返回的详细信息。
- */
-export interface RemindFlowRecords {
-  /**
-   * 合同流程是否可以催办：
-true - 可以，false - 不可以。
-若无法催办，将返回RemindMessage以解释原因。
-   */
-  CanRemind?: boolean
-  /**
-   * 合同流程ID，为32位字符串。
-   */
-  FlowId?: string
-  /**
-   * 在合同流程无法催办的情况下，系统将返回RemindMessage以阐述原因。
-   */
-  RemindMessage?: string
-}
-
 /**
  * CancelUserAutoSignEnableUrl请求参数结构体
  */
@@ -4547,27 +4574,37 @@ export interface DeleteSealPoliciesRequest {
  */
 export interface CreateOrganizationBatchSignUrlRequest {
   /**
-   * 调用方用户信息，UserId 必填，支持填入集团子公司经办人UserId。
+   * 执行本接口操作的员工信息。使用此接口时，必须填写userId。
+支持填入集团子公司经办人 userId 代发合同。
+
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 指定需要进行批量签署的流程id，数量1-100，填写后用户将通过链接对这些合同进行批量签署。
+   * 请指定需执行批量签署的流程ID，数量范围为1-100。</br>
+您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。</br>
+用户将利用链接对这些合同实施批量操作。
    */
   FlowIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填。
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
   /**
-   * 员工的UserId，该UserId对应的员工必须已经加入企业并实名，Name和Mobile为空时该字段不能为空。（优先使用UserId对应的员工）
+   * 员工在腾讯电子签平台的独特身份标识，为32位字符串。</br>
+您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。</br>
+UserId必须是传入合同（FlowId）中的签署人。
+- 1. 若UserId为空，Name和Mobile 必须提供。
+- 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。
    */
   UserId?: string
   /**
-   * 员工姓名，该字段需要与Mobile组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+   * 员工姓名，必须与手机号码一起使用。</br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
    */
   Name?: string
   /**
-   * 员工手机号码，该字段需要与Name组合使用，UserId为空时该字段不能为空。（UserId为空时，使用Name和Mbile对应的员工）
+   * 员工手机号，必须与姓名一起使用。</br> 如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
    */
   Mobile?: string
 }
@@ -4709,10 +4746,11 @@ export interface DeleteIntegrationDepartmentRequest {
  */
 export interface WebThemeConfig {
   /**
-   * 是否页面底部显示电子签logo
-<br/>true：允许在页面底部隐藏电子签logo
-<br/>false：不允许允许在页面底部隐藏电子签logo
-<br/>默认false，不隐藏logo
+   * 是否显示页面底部电子签logo，取值如下：
+<ul>
+<li> **true**：页面底部显示电子签logo</li>
+<li> **false**：页面底部不显示电子签logo（默认）</li>
+</ul>
    */
   DisplaySignBrandLogo?: boolean
   /**
@@ -4938,7 +4976,7 @@ export interface ApproverOption {
 export interface CreateEmbedWebUrlResponse {
   /**
    * 嵌入的web链接，有效期：5分钟
-EmbedType=PREVIEW_CC_FLOW，该url为h5链接
+<br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
    */
   WebUrl?: string
   /**
@@ -5487,15 +5525,20 @@ export interface UpdateIntegrationEmployeesRequest {
  */
 export interface DescribeFlowBriefsRequest {
   /**
-   * 调用方用户信息，userId 必填
+   * 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
    */
   Operator: UserInfo
   /**
-   * 需要查询的流程ID列表，限制最大100个
+   * 查询的合同流程ID列表最多支持100个流程ID。 
+如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
+
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
    */
   FlowIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+   * 代理企业和员工的信息。
+在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }
@@ -5590,7 +5633,8 @@ export interface DeleteStaffsResult {
  */
 export interface DescribeFlowBriefsResponse {
   /**
-   * 流程列表
+   * 合同流程基础信息列表，包含流程的名称、状态、创建日期等基本信息。 
+注：`与入参 FlowIds 的顺序可能存在不一致的情况。`
    */
   FlowBriefs?: Array<FlowBrief>
   /**
@@ -5744,27 +5788,24 @@ DISABLE：未开通
  */
 export interface RelieveInfo {
   /**
-   * 解除理由，最大支持200个字
+   * 解除理由，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
    */
   Reason: string
   /**
-   * 解除后仍然有效的条款，保留条款，最大支持200个字
+   * 解除后仍然有效的条款，保留条款，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
 
    */
   RemainInForceItem?: string
   /**
-   * 原合同事项处理-费用结算，最大支持200个字
-
+   * 原合同事项处理-费用结算，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
    */
   OriginalExpenseSettlement?: string
   /**
-   * 原合同事项处理-其他事项，最大支持200个字
-
+   * 原合同事项处理-其他事项，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
    */
   OriginalOtherSettlement?: string
   /**
-   * 其他约定，最大支持200个字
-
+   * 其他约定，长度不能超过200，只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
    */
   OtherDeals?: string
 }
@@ -5794,17 +5835,18 @@ export interface EmbedUrlOption {
  */
 export interface CreateBatchCancelFlowUrlRequest {
   /**
-   * 调用方用户信息，userId 必填
+   * 执行本接口操作的员工信息。
+<br/>注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
    */
   Operator: UserInfo
   /**
    * 需要执行撤回的流程(合同)的编号列表，最多100个.
-列表中的流程(合同)编号不要重复.
+<br>列表中的流程(合同)编号不要重复.
    */
   FlowIds: Array<string>
   /**
-   * 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
-
+   * 代理企业和员工的信息。
+<br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
    */
   Agent?: Agent
 }