错误码
功能说明
如果返回结果中存在 Error 字段,则表示调用 API 接口失败。例如:
 {
    "Response": {
        "Error": {
            "Code": "AuthFailure.SignatureFailure",
            "Message": "The provided credentials could not be validated. Please check your signature is correct."
        },
        "RequestId": "ed93f3cb-f35e-473f-b9f3-0d451b8b79c6"
    }
}
Error 中的 Code 表示错误码,Message 表示该错误的具体信息。
错误码列表
公共错误码
| 错误码 | 说明 | 
|---|---|
| ActionOffline | 接口已下线。 | 
| AuthFailure.InvalidAuthorization | 请求头部的 Authorization不符合腾讯云标准。 | 
| AuthFailure.InvalidSecretId | 密钥非法(不是云 API 密钥类型)。 | 
| AuthFailure.MFAFailure | MFA 错误。 | 
| AuthFailure.SecretIdNotFound | 密钥不存在。请在 控制台 检查密钥是否已被删除或者禁用,如状态正常,请检查密钥是否填写正确,注意前后不得有空格。 | 
| AuthFailure.SignatureExpire | 签名过期。Timestamp 和服务器时间相差不得超过五分钟,请检查本地时间是否和标准时间同步。 | 
| AuthFailure.SignatureFailure | 签名错误。签名计算错误,请对照调用方式中的签名方法文档检查签名计算过程。 | 
| AuthFailure.TokenFailure | token 错误。 | 
| AuthFailure.UnauthorizedOperation | 请求未授权。请参考 CAM 文档对鉴权的说明。 | 
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 | 
| FailedOperation | 操作失败。 | 
| InternalError | 内部错误。 | 
| InvalidAction | 接口不存在。 | 
| InvalidParameter | 参数错误(包括参数格式、类型等错误)。 | 
| InvalidParameterValue | 参数取值错误。 | 
| InvalidRequest | 请求 body 的 multipart 格式错误。 | 
| IpInBlacklist | IP 地址在黑名单中。 | 
| IpNotInWhitelist | IP 地址不在白名单中。 | 
| LimitExceeded | 超过配额限制。 | 
| MissingParameter | 缺少参数。 | 
| NoSuchProduct | 产品不存在 | 
| NoSuchVersion | 接口版本不存在。 | 
| RequestLimitExceeded | 请求的次数超过了频率限制。 | 
| RequestLimitExceeded.GlobalRegionUinLimitExceeded | 主账号超过频率限制。 | 
| RequestLimitExceeded.IPLimitExceeded | IP 限频。 | 
| RequestLimitExceeded.UinLimitExceeded | 主账号限频。 | 
| RequestSizeLimitExceeded | 请求包超过限制大小。 | 
| ResourceInUse | 资源被占用。 | 
| ResourceInsufficient | 资源不足。 | 
| ResourceNotFound | 资源不存在。 | 
| ResourceUnavailable | 资源不可用。 | 
| ResponseSizeLimitExceeded | 返回包超过限制大小。 | 
| ServiceUnavailable | 当前服务暂时不可用。 | 
| UnauthorizedOperation | 未授权操作。 | 
| UnknownParameter | 未知参数错误,用户多传未定义的参数会导致错误。 | 
| UnsupportedOperation | 操作不支持。 | 
| UnsupportedProtocol | http(s) 请求协议错误,只支持 GET 和 POST 请求。 | 
| UnsupportedRegion | 接口不支持所传地域。 | 
业务错误码
| 错误码 | 说明 | 
|---|---|
| AuthFailure | CAM签名/鉴权错误。 | 
| FailedOperation.AgeNotAchieveNormalLegal | 签署人未达到合法年龄。 | 
| FailedOperation.AuthFail | 鉴权失败。 | 
| FailedOperation.ErrNotSyncProxyOrganization | 当选择“企业实名认证(信任第三方认证源)”时,请先使用“同步企业信息”接口,同步企业名称、统一社会信用代码、法人姓名。 | 
| FailedOperation.ExistSameSealName | 存在同名印章。 | 
| FailedOperation.FlowNumExceed | 合同数目超出。 | 
| FailedOperation.HasAuthorized | 已授权。 | 
| FailedOperation.LicenseNoQuota | 自动签许可额度不足 | 
| FailedOperation.NoRoleAuth | 无角色授权,请确认数据是否存在 | 
| FailedOperation.NotAvailableSignReview | 当前合同状态无法进行签署审批。 | 
| FailedOperation.QrCodeCreatorSignComponents | 发起签署存在填写控件。 | 
| FailedOperation.QrCodeSignUsers | 模板签署人不存在。 | 
| FailedOperation.QrCodeTemplateId | 签署二维码模板信息有误,请检查参数后重试。 | 
| FailedOperation.StaffAlreadyVerify | 员工已实名。 | 
| FailedOperation.UserAutoSignEnableAlready | 无法撤销,用户已开通自动签。 | 
| FailedOperation.UserAutoSignEnableUrlNotExist | 无法撤销,用户未生成开通链接。 | 
| InternalError.Api | 其他API错误。 | 
| InternalError.Db | 数据库错误。 | 
| InternalError.DbConnection | 数据库连接出错。 | 
| InternalError.DbInsert | 数据库新增记录出错。 | 
| InternalError.DbRead | 数据库读取失败。 | 
| InternalError.DbUpdate | 数据库更新记录出错。 | 
| InternalError.Decryption | 解密错误。 | 
| InternalError.DependsApi | 依赖的其他api出错。 | 
| InternalError.DependsDb | 数据库异常。 | 
| InternalError.Encryption | 加密错误。 | 
| InternalError.GenerateId | 生成唯一ID错误。 | 
| InternalError.Pdf | Pdf合成错误。 | 
| InternalError.SealUpload | 上传印章失败。 | 
| InternalError.Serialize | 序列化错误。 | 
| InternalError.System | 系统错误。 | 
| InternalError.ThirdParty | 第三方错误。 | 
| InvalidParameter.Application | 应用号不存在。 | 
| InvalidParameter.ApproverType | 参数错误,不合法的签署人类型,请修改后重试。 | 
| InvalidParameter.ApproverVerifyType | ApproverVerifyType参数值非法 | 
| InvalidParameter.AuthorizationType | 不合法的授权方式, 请重新指定授权方式后发起 | 
| InvalidParameter.BizApproverAlreadyExists | 重复添加签署人。 | 
| InvalidParameter.BusinessLicense | 营业执照格式不合法。 | 
| InvalidParameter.CancelReason | 撤销理由填写格式错误。 | 
| InvalidParameter.CardNumber | 证件号码错误。 | 
| InvalidParameter.CardType | 证件类型错误。 | 
| InvalidParameter.ComponentPosition | 控件的位置错误 | 
| InvalidParameter.ComponentType | 控件类型错误 | 
| InvalidParameter.ComponentValue | 参数错误,控件内容无效。 | 
| InvalidParameter.ContentType | 查询内容参数有误。 | 
| InvalidParameter.CustomShowMap | 参数错误,无效的自定义页卡模板,仅支持{合同名称}{发起方姓名}{发起方企业}{签署方N姓名}{签署方N企业},请修改后重试。 | 
| InvalidParameter.CustomerData | 参数错误,UserData长度非法,请修改后重试。 | 
| InvalidParameter.DataNotFound | 数据不存在。 | 
| InvalidParameter.Date | 参数错误,不合法的日期,请检查后重试。 | 
| InvalidParameter.DepartUserId | 员工ID不正确。 | 
| InvalidParameter.DupTask | 重复提交任务。 | 
| InvalidParameter.EmptyParams | 参数为空。 | 
| InvalidParameter.EndPoint | 不合法的EndPoint,请检查修改后重试。 | 
| InvalidParameter.FileType | 文件类型不合法。 | 
| InvalidParameter.FlowApproverInfos | 参数错误,不合法的备选签署人数量,请检查后重试。 | 
| InvalidParameter.FlowApprovers | 参数错误,参与者数量不能为空且不能超过数量限制,请修改后重试。 | 
| InvalidParameter.FlowCallbackUrl | 参数错误,不合法的签署流程回调链接,请修改后重试。 | 
| InvalidParameter.FlowDeadLine | 参数错误,不合法的签署流程截止日期,请修改后重试。 | 
| InvalidParameter.FlowDescription | 参数错误,不合法的签署流程描述,请修改后重试。 | 
| InvalidParameter.FlowFileIds | 参数错误,目前仅支持单个文件发起,请修改后重试。 | 
| InvalidParameter.FlowIds | 参数错误,合同id列表长度非法,请检查后重试。 | 
| InvalidParameter.FlowInfos | 参数错误,FlowInfos非法,请修改后重试。 | 
| InvalidParameter.FlowName | 参数错误,不合法的签署流程名称,请修改后重试。 | 
| InvalidParameter.FlowType | 参数错误,不合法的FlowType,请修改后重试。 | 
| InvalidParameter.GenerateType | 参数错误,不受支持的GenerateType,请检查后重试。 | 
| InvalidParameter.Image | 图片不正确。 | 
| InvalidParameter.InvalidId | Id不存在或者符合规范。 | 
| InvalidParameter.Keyword | 关键字格式错误或者不存在。 | 
| InvalidParameter.Limit | 参数Limit不正确 | 
| InvalidParameter.LimitSealName | 印章名称长度超出。 | 
| InvalidParameter.MenuStatus | 菜单栏状态非法。 | 
| InvalidParameter.MissingRequiredParameterValue | 缺少必填参数的值。 | 
| InvalidParameter.Mobile | 手机号码不正确。 | 
| InvalidParameter.Name | 姓名不符合要求。 | 
| InvalidParameter.NonsupportMobile | 不支持的手机号。 | 
| InvalidParameter.OpenId | OpenId不合法。 | 
| InvalidParameter.OperatorId | 用户ID不正确 | 
| InvalidParameter.OrganizationId | OrganizationId不合法。 | 
| InvalidParameter.OrganizationName | 企业名称不合法。 | 
| InvalidParameter.ParamError | 参数错误。 | 
| InvalidParameter.ResourceType | 资源类型错误。 | 
| InvalidParameter.RoleId | 角色ID不正确 | 
| InvalidParameter.Sensitive | 存在敏感词 | 
| InvalidParameter.SensitiveFileContent | 上传的文件包含敏感(不合规)的内容,请确认。 | 
| InvalidParameter.SignComponentType | 参数错误,不合法的签署控件类型,请修改后重试。 | 
| InvalidParameter.SignComponents | 类型不支持。 | 
| InvalidParameter.Status | 状态异常。 | 
| InvalidParameter.UniformSocialCreditCode | 统一社会信用代码不符合要求 | 
| InvalidParameter.Unordered | 参数错误,不合法的签署顺序,请检查后重试。 | 
| InvalidParameter.UnsupportedComponentType | 参数错误,不支持的控件类型,请检查后重试。 | 
| InvalidParameter.fFowIds | 流程id不存在。 | 
| InvalidParameterValue.InvalidQuotaType | 非法的套餐类型 | 
| InvalidParameterValue.InvalidTime | 非法的时间参数 | 
| LimitExceeded.CallTimes | 超出调用次数限制。 | 
| LimitExceeded.CreateFlowNum | 超出流程创建数量限制。 | 
| LimitExceeded.FileSize | 文件大小限制。 | 
| LimitExceeded.FlowIds | 合同id数超出限制。 | 
| LimitExceeded.FlowInfos | 超出流程数量限制。 | 
| LimitExceeded.ProxyOrganizationOperator | 经办人数据超出。 | 
| MissingParameter.CompanyActiveInfo | 合作企业激活信息不存在。 | 
| MissingParameter.Date | 缺少时间参数,请检查后重试。 | 
| MissingParameter.FlowId | 缺少流程id,请检查后重试。 | 
| MissingParameter.FlowIds | 缺少流程id,请检查后重试。 | 
| MissingParameter.FlowIdsOrFlowGroupId | 请传入需要查询的合同或合同组的ID。 | 
| MissingParameter.FlowInfo | 未指定流程合同信息。 | 
| MissingParameter.MissComponentName | 缺少控件名称参数,请检查后重试。 | 
| MissingParameter.OrgOpenId | 企业OpenId不存在。 | 
| MissingParameter.OrganizationId | 企业信息为空。 | 
| MissingParameter.ProxyOperatorOpenId | ProxyOperatorOpenId不存在。 | 
| MissingParameter.ReportApplicant | reportApplicant 不存在 | 
| MissingParameter.ResourceName | 资源名称错误。 | 
| MissingParameter.SealId | 印章ID为空。 | 
| MissingParameter.SealImage | 印章图片为空。 | 
| MissingParameter.SealName | 印章名称为空。 | 
| MissingParameter.SignComponents | 签署人缺少签署控件。 | 
| MissingParameter.Templates | 缺少模板参数。 | 
| MissingParameter.UserId | 缺少用户ID参数 | 
| MissingParameter.UserOpenId | OpenId不存在。 | 
| OperationDenied | 操作被拒绝。 | 
| OperationDenied.AlreadyHas | 相关资源已经存证, 无法在创建新的相关资源 | 
| OperationDenied.ApproverRepeat | 参与人信息有重复 | 
| OperationDenied.AuthTag | 不支持的可见性标识。 | 
| OperationDenied.BannedApplication | 应用号已被禁止。 | 
| OperationDenied.ByFilesServerSignForbid | 文件发起静默签未开通白名单。 | 
| OperationDenied.DownLoadMoreThanOne | 只支持下载单个。 | 
| OperationDenied.ErrNoResourceAccess | 无资源访问权限。 | 
| OperationDenied.ErrNotOpenWeakAuthorization | 第三方应用平台未开通“平台子客企业实名认证(信任第三方认证源)”能力 | 
| OperationDenied.FileDeleted | 文件已删除。 | 
| OperationDenied.FlowHasTerminated | 流程已终止。 | 
| OperationDenied.FlowStatusForbid | 签署流程状态不正确,请检查后重试。 | 
| OperationDenied.Forbid | 禁止操作。 | 
| OperationDenied.InvalidApproverAge | 签署人未达到合法年龄。 | 
| OperationDenied.NoApiAuth | 没有API权限。 | 
| OperationDenied.NoApproverMobileCheckPermission | 企业暂未开通手机号验证身份的服务,请在企业中心开通再使用 | 
| OperationDenied.NoFlowPermission | 无权操作合同。 | 
| OperationDenied.NoIdentityVerify | 未通过个人实名。 | 
| OperationDenied.NoPermissionUseResource | 无权限进行操作 | 
| OperationDenied.NoPermissionUseServerSignSeal | 本企业自动签印章无权限使用 | 
| OperationDenied.NoQuota | 流程配额不足。 | 
| OperationDenied.NotBelongSuperAdminOrLegalPerson | 不属于企业超管或者法人。 | 
| OperationDenied.NotInAutoSignWhiteList | 不在此业务白名单中 | 
| OperationDenied.NotSupportOrgType | 不支持的企业类型 | 
| OperationDenied.OperateType | 操作类型不支持。 | 
| OperationDenied.OperatorHasNoPermission | 操作者权限不足。 | 
| OperationDenied.OrganizationClosing | 企业已经注销中 | 
| OperationDenied.OutQueryLimit | 超出查询上限。 | 
| OperationDenied.OverseaAbilityNotOpen | 当前企业员工没有开通境外签署能力。 | 
| OperationDenied.PersonHasNoSignature | 该用户名下没有可用签名 | 
| OperationDenied.PersonNoOpenServerSign | 该用户已关闭或者未开启自动签服务 | 
| OperationDenied.ProveNoQuota | 出证计费额度不足。 | 
| OperationDenied.RequiredComponentNotFill | 必填控件未填 | 
| OperationDenied.Sensitive | 存在敏感词 | 
| OperationDenied.UserNotInOrganization | 用户不归属于当前企业,无法操作,请检查后重试。 | 
| OperationDenied.WhiteListForbid | 接口功能暂未开放,请联系客户经理申请白名单使用 | 
| ResourceNotFound.Application | 应用号不存在。 | 
| ResourceNotFound.ApplicationAuth | 应用授权记录未找到。 | 
| ResourceNotFound.ApplicationId | ApplicationId不存在。 | 
| ResourceNotFound.File | 文件不存在。 | 
| ResourceNotFound.Flow | 未找到对应流程。 | 
| ResourceNotFound.FlowApprover | 签署流程的签署人不存在,请检查后重试。 | 
| ResourceNotFound.FlowApprovers | 签署人信息不存在,请检查后重试。 | 
| ResourceNotFound.FlowGroup | 合同组不存在。 | 
| ResourceNotFound.NotExistApplication | 应用号不存在 | 
| ResourceNotFound.Organization | 机构不存在。 | 
| ResourceNotFound.Resource | 资源不存在。 | 
| ResourceNotFound.SaveFlowGroup | 合同组不存在 | 
| ResourceNotFound.Seal | 印章不存在,请检查后重试。 | 
| ResourceNotFound.TeamWorkOrganization | 合作企业不存在。 | 
| ResourceNotFound.Template | 模板不存在。 | 
| ResourceNotFound.URL | Url不存在。 | 
| ResourceNotFound.User | 用户信息不存在。 | 
| ResourceNotFound.VerifyUser | 实名用户信息不存在。 | 
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 | 
| UnauthorizedOperation.UnauthorizedOperationDownload | 未授权下载权限。 | 
| UnauthorizedOperation.UnauthorizedOperationOrganization | 企业没有被授权。 |