跳到主要内容

API 概览

模板与文件相关接口

接口名称接口功能频率限制(次/秒)
DescribeFlowTemplates查询模板信息300
UploadFiles上传文件300
CreateConvertTaskApi创建文件转换任务300
GetTaskResultApi查询转换任务状态300
DescribeFileUrls查询文件下载URL300

创建签署流程相关接口

接口名称接口功能频率限制(次/秒)
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
DescribeSignFaceVideo查询签署认证人脸视频20

控制签署流程相关接口

接口名称接口功能频率限制(次/秒)
CreateFlowGroupSignReview提交合同组签署流程审批结果20
CreateFlowSignReview提交签署流程审批结果300
ModifyFlowDeadline管理签署流程截止时间20
CreateFlowApprovers补充签署流程签署人信息30
CreateFlowReminds合同催办20
CreateReleaseFlow发起解除协议20
CancelFlow撤销单个合同流程300
CreateBatchCancelFlowUrl获取批量撤销签署流程腾讯电子签小程序链接300
DescribeCancelFlowsTask查询批量撤销签署流程任务结果20
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

机构与组织相关接口

接口名称接口功能频率限制(次/秒)
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
DescribeBatchOrganizationRegistrationUrls查询企业批量认证链接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
CreateUserMobileChangeUrl生成修改用户手机号链接20
CreateUserVerifyUrl获取c端用户实名链接20
DescribeUserVerifyStatus查询用户实名状态20
CreatePersonAuthCertificateImage获取个人用户认证证书图片20
CreateUserAutoSignSealUrl获取设置自动签印章小程序链接20
RenewAutoSignLicense续期医疗自动签许可20

集团管理相关接口

接口名称接口功能频率限制(次/秒)
CreateIntegrationSubOrganizationActiveRecord创建子企业激活记录20
CreateOrganizationGroupInvitationLink生成集团加入邀请二维码20

计费相关接口

接口名称接口功能频率限制(次/秒)
DescribeBillUsageDetail查询企业计费使用情况20
DescribeBillUsage查询企业套餐使用情况50
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062