API 概览
模板与文件相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeFlowTemplates | 查询模板信息 | 300 |
| UploadFiles | 上传文件 | 300 |
| CreateConvertTaskApi | 创建文件转换任务 | 300 |
| GetTaskResultApi | 查询转换任务状态 | 300 |
| DescribeFileUrls | 查询文件下载URL | 300 |
创建签署流程相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateFlowByFiles | 用PDF文件创建签署流程 | 300 |
| CreateFlow | 模板发起合同-创建签署流程 | 300 |
| CreateDocument | 模板发起合同-创建电子文档 | 300 |
| StartFlow | 模板发起合同-发起签署流程 | 300 |
| CreateFlowGroupByTemplates | 通过多模板创建合同组签署流程 | 20 |
| CreateFlowGroupByFiles | 通过多文件创建合同组签署流程 | 20 |
| CreateMultiFlowSignQRCode | 创建一码多扫流程签署二维码 | 300 |
| CreateSchemeUrl | 获取跳转至腾讯电子签小程序的签署链接 | 300 |
| CreateBatchSignUrl | 获取跳转至腾讯电子签小程序的批量签署链接 | 20 |
| CreateFlowSignUrl | 获取个人用户H5签署链接 | 20 |
| CreateBatchQuickSignUrl | 获取H5批量签署链接 | 20 |
查询签署流程相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeFlowBriefs | 查询流程基础信息 | 300 |
| DescribeFlowInfo | 查询合同流程的详情信息 | 20 |
| DescribeFlowComponents | 查询流程填写控件内容 | 20 |
控制签署流程相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateFlowSignReview | 提交签署流程审批结果 | 300 |
| CreateFlowApprovers | 补充签署流程签署人信息 | 20 |
| CreateFlowReminds | 合同催办 | 20 |
| CreateReleaseFlow | 发起解除协议 | 20 |
| CancelFlow | 撤销单个合同流程 | 300 |
| CreateBatchCancelFlowUrl | 批量撤销签署流程 | 300 |
| CancelMultiFlowSignQRCode | 取消一码多扫流程签署二维码 | 300 |
可嵌入页面相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| CreateWebThemeConfig | 设置本企业嵌入式页面主题配置 | 20 |
| CreatePrepareFlow | 创建发起流程web页面 | 20 |
| CreateOrganizationBatchSignUrl | 获取企业签署合同web页面 | 20 |
| CreateEmbedWebUrl | 获取其他可嵌入web页面 | 20 |
电子印章管理相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeOrganizationSeals | 查询企业电子印章 | 20 |
| CreateSealPolicy | 创建企业员工印章授权 | 20 |
| DeleteSealPolicies | 撤销企业员工的印章授权 | 20 |
| CreatePreparedPersonalEsign | 创建导入处方单个人印章 | 20 |
| CreateSeal | 创建企业电子印章 | 20 |
证书管理相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| VerifyPdf | 流程文件验签 | 20 |
| CreateFlowEvidenceReport | 提交申请出证报告任务 | 20 |
| DescribeFlowEvidenceReport | 获取出证报告任务执行结果 | 20 |
| DescribePersonCertificate | 查询个人证书接口 | 20 |
机构与组织相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeIntegrationDepartments | 获取企业部门信息列表 | 20 |
| CreateIntegrationDepartment | 创建企业部门 | 20 |
| ModifyIntegrationDepartment | 更新企业部门信息 | 20 |
| DeleteIntegrationDepartment | 删除企业部门 | 20 |
| ModifyApplicationCallbackInfo | 修改企业回调配置 | 20 |
| DescribeOrganizationGroupOrganizations | 查询集团企业列表 | 20 |
| DescribeExtendedServiceAuthInfos | 查询企业扩展服务授权信息 | 20 |
| CreateExtendedServiceAuthInfos | 创建企业扩展服务授权 | 20 |
| DeleteExtendedServiceAuthInfos | 删除企业扩展服务授权 | 20 |
| CreateOrganizationInfoChangeUrl | 创建企业信息变更链接 | 20 |
机构与员工相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeIntegrationEmployees | 查询企业员工信息列表 | 20 |
| CreateIntegrationEmployees | 创建企业员工 | 20 |
| UpdateIntegrationEmployees | 更新企业员工信息 | 20 |
| DeleteIntegrationEmployees | 移除企业员工 | 20 |
| BindEmployeeUserIdWithClientOpenId | 员工Userid与客户系统Openid绑定 | 20 |
| UnbindEmployeeUserIdWithClientOpenId | 解除员工UserId与客户系统OpenId的绑定 | 20 |
角色管理相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeIntegrationRoles | 查询企业角色列表 | 20 |
| CreateIntegrationUserRoles | 绑定员工角色 | 20 |
| DeleteIntegrationRoleUsers | 解绑员工角色 | 20 |
| CreateIntegrationRole | 创建企业角色 | 20 |
| ModifyIntegrationRole | 更新企业角色 | 20 |
个人账号管理相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeUserAutoSignStatus | 获取个人用户自动签的开通状态 | 20 |
| CreateUserAutoSignEnableUrl | 获取个人用户自动签的开通链接 | 20 |
| DisableUserAutoSign | 关闭个人用户自动签功能 | 20 |
| CancelUserAutoSignEnableUrl | 撤销个人用户自动签的开通链接 | 20 |
| DescribeThirdPartyAuthCode | 通过AuthCode查询个人用户是否实名 | 20 |
| CreatePersonAuthCertificateImage | 获取个人用户认证证书图片 | 20 |
| CreateUserAutoSignSealUrl | 获取设置自动签印章小程序链接 | 20 |
计费相关接口
| 接口名称 | 接口功能 | 频率限制（次/秒） |
|---|---|---|
| DescribeBillUsageDetail | 查询企业计费使用情况 | 20 |