Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
Features & Server APIs
  • On-Cloud Recording
  • Relay to CDN
  • RTMP Streaming with TRTC
  • Event Callbacks
    • Event Callbacks
    • Relay to CDN Callback
    • Cloud Recording Callback
    • Verify Signature Example
  • Sending and Receiving Messages
  • Access Management
    • Overview
    • Manageable Resources and Actions
    • Preset Policies
    • Custom Policies
  • Enabling Advanced Permission Control
  • How to push stream to TRTC room with OBS WHIP
  • Server APIs
    • API Category
    • History
    • Making API Request
      • Request Structure
      • Common Params
      • Signature v3
      • Signature
      • Responses
    • Room Management APIs
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • Call Quality Monitoring APIs
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • Pull Stream Relay Related Interface
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • On-cloud Recording APIs
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • Stream Mixing and Relay APIs
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • Usage Statistics APIs
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • Data Types
    • Error Codes
    • Appendix
      • Event ID Mapping Table
Features & Server APIs

Error Codes

Feature Description

If there is an Error field in the response, it means that the API call failed. For example:

 {
    "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"
    }
}

Code in Error indicates the error code, and Message indicates the specific information of the error.

Error Code List

Common Error Codes

Error CodeDescription
ActionOfflineThis API has been deprecated.
AuthFailure.InvalidAuthorizationAuthorization in the request header is invalid.
AuthFailure.InvalidSecretIdInvalid key (not a TencentCloud API key type).
AuthFailure.MFAFailureMFA failed.
AuthFailure.SecretIdNotFoundKey does not exist. Check if the key has been deleted or disabled in the console, and if not, check if the key is correctly entered. Note that whitespaces should not exist before or after the key.
AuthFailure.SignatureExpireSignature expired. Timestamp and server time cannot differ by more than five minutes. Please ensure your current local time matches the standard time.
AuthFailure.SignatureFailureInvalid signature. Signature calculation error. Please ensure you’ve followed the signature calculation process described in the Signature API documentation.
AuthFailure.TokenFailureToken error.
AuthFailure.UnauthorizedOperationThe request is not authorized. For more information, see the CAM documentation.
DryRunOperationDryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperationOperation failed.
InternalErrorInternal error.
InvalidActionThe API does not exist.
InvalidParameterIncorrect parameter.
InvalidParameterValueInvalid parameter value.
InvalidRequestThe multipart format of the request body is incorrect.
IpInBlacklistYour IP is in uin IP blacklist.
IpNotInWhitelistYour IP is not in uin IP whitelist.
LimitExceededQuota limit exceeded.
MissingParameterA parameter is missing.
NoSuchProductThe product does not exist.
NoSuchVersionThe API version does not exist.
RequestLimitExceededThe number of requests exceeds the frequency limit.
RequestLimitExceeded.GlobalRegionUinLimitExceededUin exceeds the frequency limit.
RequestLimitExceeded.IPLimitExceededThe number of ip requests exceeds the frequency limit.
RequestLimitExceeded.UinLimitExceededThe number of uin requests exceeds the frequency limit.
RequestSizeLimitExceededThe request size exceeds the upper limit.
ResourceInUseResource is in use.
ResourceInsufficientInsufficient resource.
ResourceNotFoundThe resource does not exist.
ResourceUnavailableResource is unavailable.
ResponseSizeLimitExceededThe response size exceeds the upper limit.
ServiceUnavailableService is unavailable now.
UnauthorizedOperationUnauthorized operation.
UnknownParameterUnknown parameter.
UnsupportedOperationUnsupported operation.
UnsupportedProtocolHTTP(S) request protocol error; only GET and POST requests are supported.
UnsupportedRegionAPI does not support the requested region.

Service Error Codes

Error CodeDescription
AuthFailureCAM signature/authentication error.
AuthFailure.UnRealNameAuthenticatedIdentity verification has not been completed, so this operation is not allowed.
AuthFailure.UnsupportedOperationUnsupported operation.
FailedOperation.CRUnsupportMethodUnsupported on-cloud recording method.
FailedOperation.NotRtmpFunction
FailedOperation.QueryTaskInfoFailedQuery task failed
FailedOperation.RestrictedConcurrencyMaximum number of concurrent on-cloud recording tasks reached. Contact us to raise the limit.
FailedOperation.RoomNotExistThe room does not exist.
FailedOperation.SdkAppIdNotExistThe application ID does not exist.
FailedOperation.TaskExistTask already exists
FailedOperation.TaskFinishedTask has ended when calling the interface.
FailedOperation.UserNotExistThe user is not in the room.
InternalError.CRInternalErrorOn-cloud recording internal error.
InternalError.DBErrorAn error occurred while querying the database.
InternalError.EsQueryErrorAn error occurred during an ES query.
InternalError.GetRoomCacheIpErrorFailed to query the room.
InternalError.GetRoomFromCacheErrorFailed to get room information.
InternalError.HttpParaseFaliedFailed to parse the HTTP request.
InternalError.HttpParseFailedHTTP request parsing failed.
InternalError.InterfaceErrAPI error.
InternalError.InternalErrorInternal error, please retry.
InternalError.MethodErrUnsupported method.
InternalError.UserNotExistThe user is not in the room.
InvalidParameter.BodyParamsErrorFailed to parse body parameters.
InvalidParameter.EncodeParamsInvalid EncodeParams.
InvalidParameter.EndTsInvalid EndTs.
InvalidParameter.OutOfRangeParameter value is out of range.
InvalidParameter.PageNumberInvalid PageNumber.
InvalidParameter.PageSizeInvalid PageSize.
InvalidParameter.PageSizeOversizeThe value of PageSize exceeds 100.
InvalidParameter.QueryScaleOversizeThe query period exceeds the limit.
InvalidParameter.RoomIdRoomId is incorrect.
InvalidParameter.SdkAppIdSdkAppId is incorrect.
InvalidParameter.SdkAppidInoperable SdkAppid.
InvalidParameter.StartTimeExpireThe start time for query exceeded the limit.
InvalidParameter.StartTimeOversizeThe query start time exceeds the range allowed by the current dashboard edition. For details, see https://intl.cloud.tencent.com/document/product/647/81331?from_cn_redirect=1
InvalidParameter.StartTsInvalid StartTs.
InvalidParameter.StartTsOversizeThe start time for query exceeded the limit.
InvalidParameter.StrRoomIdStrRoomId parameter error.
InvalidParameter.TaskIdTaskId parameter error.
InvalidParameter.UrlParamsErrorFailed to parse URL parameters.
InvalidParameter.UserIdInvalid UserId.
InvalidParameter.UserIdsUserIds is incorrect.
InvalidParameter.UserIdsMorethanSixThe number of users exceeds 6.
InvalidParameter.UserSig
InvalidParameterValue.RoomIdInvalid RoomId.
MissingParameter.AccessKeyAccessKey parameter missing.
MissingParameter.AppIdAppId missing.
MissingParameter.BucketBucket parameter missing.
MissingParameter.CloudStorageCloudStorage parameter missing.
MissingParameter.CommIdCommId is missing.
MissingParameter.CommIdOrSdkAppIdSdkAppId or CommID missing.
MissingParameter.EndTsendTS_s is missing.
MissingParameter.RecordModeRecordMode parameter missing.
MissingParameter.RecordParamsRecordParams parameter missing.
MissingParameter.RegionRegion parameter missing.
MissingParameter.RoomIdRoomId is missing.
MissingParameter.RoomNumRoomNum is missing.
MissingParameter.SdkAppIdSdkAppId is missing.
MissingParameter.SecretKeySecretKey parameter missing.
MissingParameter.StartTsstartTS_s is missing.
MissingParameter.StorageParamsStorageParams parameter missing.
MissingParameter.StreamTypeStreamType parameter missing.
MissingParameter.TaskIdTaskId parameter missing.
MissingParameter.UserIdMissing UserId parameter.
MissingParameter.UserIdsUserIds is missing.
MissingParameter.UserSigUserSig parameter missing.
MissingParameter.VendorVendor parameter missing.
ResourceInsufficient.RequestRejectionInsufficient resources.
UnauthorizedOperation.SdkAppIdNo permission to manipulate SdkAppId.