API 概览
账号管理相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| CreateConsoleLoginUrl | 生成子客登录链接 | 20 |
| ChannelDescribeEmployees | 查询企业员工列表 | 20 |
| SyncProxyOrganization | 同步企业信息 | 20 |
| SyncProxyOrganizationOperators | 企业员工新增或离职 | 20 |
| CreateBatchOrganizationRegistrationTasks | 创建企业批量认证链接任务 | 20 |
| CreateModifyAdminAuthorizationUrl | 生成变更超管授权书链接 | 20 |
| DescribeBatchOrganizationRegistrationTasks | 查询企业批量认证状态 | 20 |
| DescribeBatchOrganizationRegistrationUrls | 查询子企业批量认证链接 | 20 |
| CreateBatchOrganizationAuthorizationUrl | 创建企业批量认证链接-单链接 | 20 |
| DeleteOrganizationAuthorizations | 批量清除未认证的企业认证流 | 20 |
| ChannelDescribeRoles | 获取角色列表 | 20 |
| ChannelCreateUserRoles | 绑定员工角色 | 20 |
| ChannelDeleteRoleUsers | 删除员工绑定角色 | 20 |
| ChannelCreateRole | 创建角色 | 20 |
| ChannelDeleteRole | 删除角色 | 20 |
| ChannelModifyRole | 更新角色 | 20 |
| CreateBatchInitOrganizationUrl | 批量操作企业初始化 | 20 |
| CreateCloseOrganizationUrl | 创建企业注销链接 | 20 |
| CreateChannelSubOrganizationActive | 激活或者续期子企业 | 20 |
文档模板相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| DescribeTemplates | 查询模板信息列表 | 20 |
| OperateChannelTemplate | 第三方应用模板库管理 | 200 |
| ChannelCreateMultiFlowSignQRCode | 创建一码多签签署码 | 20 |
| ChannelCancelMultiFlowSignQRCode | 取消一码多签签署码 | 20 |
| OperateTemplate | 企业模板管理 | 20 |
| DescribeUserFlowType | 查询用户合同类型 | 20 |
文件上传下载相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| UploadFiles | 文件上传 | 20 |
| ChannelCreateConvertTaskApi | 创建文件转换任务 | 20 |
| ChannelGetTaskResultApi | 查询转换任务状态 | 20 |
| GetDownloadFlowUrl | 获取控制台下载合同页面跳转链接 | 20 |
| DescribeResourceUrlsByFlows | 获取合同PDF下载链接 | 50 |
流程发起相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| CreateFlowsByTemplates | 用模板创建签署流程 | 20 |
| ChannelCreateFlowByFiles | 用PDF文件创建签署流程 | 20 |
| ChannelCreateFlowGroupByTemplates | 通过多模板创建合同组签署流程 | 20 |
| ChannelCreateFlowGroupByFiles | 通过多文件创建合同组签署流程 | 20 |
| ChannelCreateReleaseFlow | 发起解除协议 | 20 |
| PrepareFlows | 准备待发起文件 | 20 |
流程签署相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| ChannelCreateFlowSignReview | 提交企业签署流程审批结果 | 50 |
| CreateFlowGroupSignReview | 提交合同组签署流程审批结果 | 20 |
| ChannelCancelFlow | 撤销合同流程 | 20 |
| ChannelBatchCancelFlows | 批量撤销合同流程 | 20 |
| DescribeCancelFlowsTask | 查询批量撤销签署流程任务结果 | 20 |
| ChannelCreateBatchCancelFlowUrl | 获取批量撤销合同流程的腾讯电子签小程序链接 | 20 |
| ArchiveDynamicFlow | 结束动态签署流程 | 20 |
| CreateSignUrls | 获取跳转至腾讯电子签小程序的签署链接 | 20 |
| ChannelCreateBatchSignUrl | 获取跳转至腾讯电子签小程序的批量签署链接 | 20 |
| ChannelCreateFlowSignUrl | 获取用户H5签署链接 | 20 |
| ChannelCreateBatchQuickSignUrl | 获取H5批量签署或查看链接 | 20 |
流程管理相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| ModifyFlowDeadline | 修改签署流程截止时间 | 20 |
| ChannelCreateFlowReminds | 合同催办 | 20 |
| ChannelCreateBoundFlows | 领取未归属的合同 | 20 |
| DescribeFlowDetailInfo | 获取合同信息 | 20 |
| ChannelDescribeFlowComponents | 获取合同填写控件内容 | 20 |
| ChannelCreateFlowApprovers | 补充签署流程签署人信息 | 20 |
| ChannelDescribeSignFaceVideo | 查询签署认证人脸视频 | 20 |
| ChannelCreateDynamicFlowApprover | 渠道版补充动态合同签署人接口 | 20 |
| CreateFlowForwards | 变更本企业待签合同的经办人 | 20 |
可嵌入页面相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| ChannelCreatePrepareFlow | 获取发起合同嵌入链接 | 20 |
| ChannelCreateEmbedWebUrl | 获取常规模块嵌入页面链接 | 20 |
| ChannelCreateWebThemeConfig | 创建页面主题配置 | 20 |
| ChannelCreateOrganizationBatchSignUrl | 获取企业签署合同web页面 | 20 |
| ChannelCreatePrepareFlowGroup | 获取发起合同组嵌入链接 | 20 |
证书管理相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| ChannelVerifyPdf | 合同验签 | 20 |
| CreateChannelFlowEvidenceReport | 提交申请出证报告任务 | 20 |
| DescribeChannelFlowEvidenceReport | 获取出证报告任务执行结果 | 20 |
| CreateFlowBlockchainEvidenceUrl | 获取签署存证证书查看二维码 | 20 |
印章管理相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| CreateLegalSealQrCode | 获取到电子签小程序创建法人章二维码 | 20 |
| ChannelDescribeOrganizationSeals | 查询子企业电子印章 | 20 |
| ChannelCreateSealPolicy | 创建印章授权 | 20 |
| ChannelUpdateSealStatus | 更新印章状态 | 20 |
| ChannelDeleteSealPolicies | 删除印章授权 | 20 |
| CreateSealByImage | 创建企业电子印章 | 20 |
| ChannelCreatePreparedPersonalEsign | 创建导入处方单个人印章 | 20 |
| CreateEmployeeQualificationSealQrCode | 创建个人印章授权给企业使用的授权二维码 | 20 |
企业及个人相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| CreateEmployeeChangeUrl | 创建员工信息变更链接 | 20 |
| CreateOrganizationAuthFile | 生成企业授权书 | 20 |
| CreatePartnerAutoSignAuthUrl | 创建企业自动签授权链接 | 20 |
| ModifyPartnerAutoSignAuthUrl | 更新企业自动签授权链接 | 20 |
| DescribeExtendedServiceAuthDetail | 查询企业扩展服务授权详情 | 20 |
| DescribeExtendedServiceAuthInfo | 查询企业扩展服务授权信息 | 20 |
| ModifyExtendedService | 管理企业扩展服务 | 20 |
| ChannelCreateOrganizationModifyQrCode | 生成渠道子客编辑企业信息二维码 | 20 |
| DescribeChannelOrganizations | 查询企业信息 | 20 |
| DescribeChannelSealPolicyWorkflowUrl | 生成渠道子客用印申请审批链接 | 20 |
| ChannelCreateUserAutoSignEnableUrl | 获取个人用户自动签的开通链接 | 20 |
| ChannelDescribeUserAutoSignStatus | 查询个人用户开通自动签状态 | 20 |
| ChannelDisableUserAutoSign | 关闭个人自动签功能 | 20 |
| ChannelCancelUserAutoSignEnableUrl | 撤销自动签开通链接 | 20 |
| ChannelCreateUserAutoSignSealUrl | 获取设置自动签印章小程序链接 | 20 |
| CreateChannelOrganizationInfoChangeUrl | 获取变更企业信息电子签小程序链接 | 20 |
| ChannelRenewAutoSignLicense | 续期医疗自动签许可 | 20 |
| CreatePersonAuthCertificateImage | 获取个人用户认证证书图片 | 20 |
费用相关接口
| 接口名称 | 接口功能 | 频率限制(次/秒) |
|---|---|---|
| DescribeUsage | 合同消耗数量查询 | 20 |
| ChannelDescribeAccountBillDetail | 查询“子客账号”套餐消耗情况 | 20 |
| ChannelDescribeBillUsageDetail | 查询渠道计费消耗情况 | 20 |
! 以上给出的接口频率限制维度为
API + 接入地域 + 子账号,有关限频更多说明参考:API 频率限制说明