API 概览
模板与文件相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeFlowTemplates | 查询模板信息 | 300 |
UploadFiles | 上传文件 | 300 |
CreateConvertTaskApi | 创建文件转换任务 | 300 |
GetTaskResultApi | 查询转换任务状态 | 300 |
DescribeFileUrls | 查询文件下载URL | 300 |
创建签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateFlowByFiles | 用PDF文件创建签署流程 | 20 |
CreateFlow | 模板发起合同-创建签署流程 | 50 |
CreateDocument | 模板发起合同-创建电子文档 | 300 |
StartFlow | 模板发起合同-发起签署流程 | 300 |
CreateFlowGroupByTemplates | 通过多模板创建合同组签署流程 | 20 |
CreateFlowGroupByFiles | 通过多文件创建合同组签署流程 | 20 |
CreateMultiFlowSignQRCode | 创建一码多签签署码 | 300 |
CreateSchemeUrl | 获取跳转至腾讯电子签小程序的签署链接 | 300 |
CreateBatchSignUrl | 获取跳转至腾讯电子签小程序的批量签署链接 | 20 |
CreateFlowSignUrl | 获取H5签署链接 | 20 |
CreateBatchQuickSignUrl | 获取H5批量签署或查看链接 | 20 |
查询签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeFlowBriefs | 查询流程基础信息 | 300 |
DescribeFlowInfo | 查询合同流程的详情信息 | 50 |
DescribeFlowComponents | 查询合同的填写控件信息 | 20 |
DescribeSignFaceVideo | 查询H5签署认证人脸视频 | 20 |
控制签署流程相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateFlowGroupSignReview | 提交合同组签署流程审批结果 | 20 |
CreateFlowSignReview | 提交签署流程审批结果 | 300 |
ModifyFlowDeadline | 修改签署流程截止时间 | 20 |
CreateFlowApprovers | 补充签署流程签署人信息 | 30 |
CreateFlowReminds | 合同催办 | 20 |
CreateReleaseFlow | 发起解除协议 | 20 |
ArchiveDynamicFlow | 结束动态签署流程 | 20 |
CancelFlow | 撤销单个合同流程 | 300 |
CreateBatchCancelFlowUrl | 获取批量撤销签署流程腾讯电子签小程序链接 | 300 |
DescribeCancelFlowsTask | 查询批量撤销签署流程任务结果 | 20 |
CancelMultiFlowSignQRCode | 取消一码多签签署码 | 300 |
CreateDynamicFlowApprover | 补充动态签署合同的签署方 | 20 |
可嵌入页面相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateWebThemeConfig | 设置本企业嵌入式页面主题配置 | 20 |
CreatePrepareFlow | 创建发起流程web页面 | 20 |
CreateOrganizationBatchSignUrl | 获取企业签署合同web页面 | 20 |
CreateEmbedWebUrl | 获取其他可嵌入web页面 | 20 |
电子印章管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateLegalSealQrCode | 获取到电子签小程序创建法人章二维码 | 20 |
DescribeOrganizationSeals | 查询企业电子印章 | 20 |
CreateSealPolicy | 创建企业员工印章授权 | 20 |
DeleteSealPolicies | 撤销企业员工的印章授权 | 20 |
CreatePreparedPersonalEsign | 创建导入处方单个人印章 | 20 |
CreateSeal | 创建企业电子印章 | 20 |
CreateEmployeeQualificationSealQrCode | 创建个人印章授权给企业使用的授权二维码 | 20 |
证书管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
VerifyPdf | 流程文件验签 | 20 |
CreateFlowEvidenceReport | 提交申请出证报告任务 | 20 |
DescribeFlowEvidenceReport | 获取出证报告任务执行结果 | 20 |
DescribePersonCertificate | 查询个人证书接口 | 20 |
CreateFlowBlockchainEvidenceUrl | 获取签署存证证书查看二维码 | 20 |
机构与组织相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateOrganizationAuthUrl | 创建企业认证链接 | 20 |
DescribeIntegrationDepartments | 获取企业部门信息列表 | 20 |
CreateIntegrationDepartment | 创建企业部门 | 20 |
ModifyIntegrationDepartment | 更新企业部门信息 | 20 |
DeleteIntegrationDepartment | 删除企业部门 | 20 |
ModifyApplicationCallbackInfo | 修改企业回调配置 | 20 |
DescribeOrganizationGroupOrganizations | 查询集团企业列表 | 20 |
DescribeExtendedServiceAuthDetail | 查询企业扩展服务授权详情 | 20 |
DescribeExtendedServiceAuthInfos | 查询企业扩展服务授权信息 | 20 |
ModifyExtendedService | 管理企业扩展服务 | 20 |
CreateExtendedServiceAuthInfos | 创建企业扩展服务授权 | 20 |
DeleteExtendedServiceAuthInfos | 删除企业扩展服务授权 | 20 |
CreateOrganizationInfoChangeUrl | 创建企业信息变更链接 | 20 |
CreateBatchOrganizationRegistrationTasks | 创建企业批量认证链接 | 20 |
CreateBatchOrganizationAuthorizationUrl | 创建企业批量认证链接-单链接 | 20 |
DescribeBatchOrganizationRegistrationUrls | 查询企业批量认证链接 | 20 |
DeleteOrganizationAuthorizations | 批量清除未认证的企业认证流 | 20 |
CreatePartnerAutoSignAuthUrl | 创建他方企业自动签授权链接(他方授权,我方授权) | 20 |
机构与员工相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeIntegrationEmployees | 查询企业员工信息列表 | 20 |
CreateIntegrationEmployees | 创建企业员工 | 20 |
UpdateIntegrationEmployees | 更新企业员工信息 | 20 |
DeleteIntegrationEmployees | 离职企业员工 | 20 |
BindEmployeeUserIdWithClientOpenId | 员工Userid与客户系统Openid绑定 | 20 |
UnbindEmployeeUserIdWithClientOpenId | 解除员工UserId与客户系统OpenId的绑定 | 20 |
DescribeOrganizationAuthStatus | 查询企业认证状态 | 20 |
角色管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeIntegrationRoles | 查询企业角色列表 | 20 |
CreateIntegrationUserRoles | 绑定员工角色 | 20 |
DeleteIntegrationRoleUsers | 解绑员工角色 | 20 |
CreateIntegrationRole | 创建企业角色 | 20 |
ModifyIntegrationRole | 更新企业角色 | 20 |
个人账号管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeUserAutoSignStatus | 获取个人用户自动签的开通状态 | 20 |
CreateUserAutoSignEnableUrl | 获取个人用户自动签的开通链接 | 20 |
DisableUserAutoSign | 关闭个人用户自动签功能 | 20 |
CancelUserAutoSignEnableUrl | 撤销个人用户自动签的开通链接 | 20 |
DescribeThirdPartyAuthCode | 通过AuthCode查询个人用户是否实名 | 20 |
CreateUserMobileChangeUrl | 生成修改用户手机号链接 | 20 |
CreateUserVerifyUrl | 获取个人用户实名链接 | 20 |
DescribeUserVerifyStatus | 查询用户实名状态 | 20 |
CreatePersonAuthCertificateImage | 获取个人用户认证证书图片 | 20 |
CreateUserAutoSignSealUrl | 获取设置自动签印章小程序链接 | 20 |
RenewAutoSignLicense | 续期医疗自动签许可 | 20 |
集团管理相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
CreateBatchInitOrganizationUrl | 批量操作企业初始化 | 20 |
CreateIntegrationSubOrganizationActiveRecord | 创建子企业激活记录 | 20 |
CreateOrganizationGroupInvitationLink | 生成集团加入邀请二维码 | 20 |
计费相关接口
接口名称 | 接口功能 | 频率限制(次/秒) |
---|---|---|
DescribeBillUsageDetail | 查询企业计费使用情况 | 20 |
DescribeBillUsage | 查询企业套餐使用情况 | 50 |
! 以上给出的接口频率限制维度为
API + 接入地域 + 子账号
,有关限频更多说明参考:API 频率限制说明