/ Platform API
Platform API
    Chat Platform API v3
    Chat Platform API
    Chat Platform API
    Version 3

    Error codes

    Copy link

    This page contains the following information:

    • Error response: a JSON format which is used for Sendbird server to send an error response to a client's request.
    • Error codes: HTTP status of each error with the corresponding error detail. Error codes in the 4xx range indicate a client-side error while codes in the 5xx range indicate Sendbird server-side error.

    Error response

    Copy link

    All errors return a 400 or 500 HTTP response. The details of each error are included in the message field.

    {
        "error": boolean,
        "code": int,
        "message": string
    }
    

    List of error properties

    Copy link
    Property nameTypeDescription

    error

    boolean

    Indicates an error has occurred.

    code

    int

    Indicates a 400 or 500 HTTP response of an error.

    message

    string

    The description of an error.


    Error codes

    Copy link

    The following table lists client or server-side errors that Chat Platform API returns in response to calls.

    HTTP status codeError detail

    400
    (bad request)

    400100 (UnexpectedParameterType)
    The request specifies one or more parameters in an unexpected data type. The data type of the parameters should be string.

    400
    (bad request)

    400101 (UnexpectedParameterType)
    The request specifies one or more parameters in an unexpected data type. The data type of the parameters should be number.

    400
    (bad request)

    400102 (UnexpectedParameterType)
    The request specifies one or more parameters in an unexpected data type. The data type of the parameters should be list.

    400
    (bad request)

    400103 (UnexpectedParameterType)
    The request specifies one or more parameters in an unexpected data type. The data type of the parameters should be JSON.

    400
    (bad request)

    400104 (UnexpectedParameterType)
    The request specifies one or more parameters in an unexpected data type. The data type of the parameters should be boolean.

    400
    (bad request)

    400105 (MissingRequiredParameters)
    The request is missing one or more required parameters.

    400
    (bad request)

    400106 (NegativeNumberNotAllowed)
    The request specifies a negative number. It should specify a positive number.

    400
    (bad request)

    400108 (UnauthorizedRequest)
    The request isn't authorized and can't access the requested resource.

    400
    (bad request)

    400110 (ParameterValueLengthExceeded)
    The length of the parameter value is too long.

    400
    (bad request)

    400111 (InvalidValue)
    The request specifies an invalid value.

    400
    (bad request)

    400112 (IncompatibleValues)
    Two parameters of the request, which should have unique values, specify the same value.

    400
    (bad request)

    400113 (ParameterValueOutOfRange)
    The request specifies one or more parameters outside the accepted value range.

    400
    (bad request)

    400114 (InvalidURLOfResource)
    The resource identified with the URL in the request can't be found.

    400
    (bad request)

    400151 (NotAllowedCharacter)
    The request specifies an unacceptable value containing special character, empty string, or white space.

    400
    (bad request)

    400201 (ResourceNotFound)
    The resource identified with the request's resourceId parameter can't be found.

    400
    (bad request)

    400202 (ResourceAlreadyExists)
    The resource identified with the request's resourceId parameter already exists.

    400
    (bad request)

    400203 (TooManyItemsInParameter)
    The parameter specifies more items than allowed.

    400
    (bad request)

    400300 (DeactivatedUserNotAccessible)
    The request can't retrieve the deactivated user data.

    400
    (bad request)

    400301 (UserNotFound)
    The user identified with the request's userId parameter can't be found because either the user doesn't exist or has been deleted.

    400
    (bad request)

    400302 (InvalidAccessToken)
    The access token provided for the request specifies an invalid value.

    400
    (bad request)

    400303 (InvalidSessionKeyValue)
    The session key provided for the request specifies an invalid value.

    400
    (bad request)

    400304 (ApplicationNotFound)
    The application identified with the request can't be found.

    400
    (bad request)

    400305 (UserIdLengthExceeded)
    The length of the userId parameter value is too long.

    400
    (bad request)

    400306 (PaidQuotaExceeded)
    The request can't be completed because you have exceeded your plan's paid quota.

    400
    (bad request)

    400307 (DomainNotAllowed)
    The request can't be completed because it came from a restricted domain.

    400
    (bad request)

    400401 (InvalidApiToken)
    The API token provided for the request specifies an invalid value.

    400
    (bad request)

    400402 (MissingSomeParameters)
    The request is missing one or more necessary parameters.

    400
    (bad request)

    400403 (InvalidJsonRequestBody)
    The request body is an invalid JSON.

    400
    (bad request)

    400404 (InvalidRequestURL)
    The request specifies an invalid HTTP request URL that can't be accessed.

    400
    (bad request)

    400500 (TooManyUserWebsocketConnections)
    The number of the user's websocket connections exceeds the allowed amount.

    400
    (bad request)

    400501 (TooManyApplicationWebsocketConnections)
    The number of the application's websocket connections exceeds the allowed amount.

    400
    (bad request)

    400700 (BlockedUser.SendNotAllowed)
    The request can't be completed due to one of the following reasons: The sender is blocked by the recipient or has been deactivated, the message is longer than the maximum message length, or the message contains texts or URLs blocked by application settings or filters.

    400
    (bad request)

    400701 (BlockedUser.InvitedNotAllowed)
    The request can't be completed because the blocking user is trying to invite the blocked user to a channel.

    400
    (bad request)

    400702 (BlockedUser.InviteNotAllowed)
    The request can't be completed because a blocked user is trying to invite the user who blocked them to a channel.

    400
    (bad request)

    400750 (BannedUser.EnterChannelNotAllowed)
    The request can't be completed because the user is trying to enter a channel that they are banned from.

    400
    (bad request)

    400751 (BannedUser.EnterCustomChannelNotAllowed)
    The request can't be completed because the user is trying to enter a custom type channel that they are banned from.

    400
    (bad request)

    400920 (Unacceptable)
    The request is unacceptable because the combination of parameter values is invalid. Even if each parameter value is valid, a combination of parameter values becomes invalid when it doesn't follow specific conditions.

    400920 (RequestDenied)
    The request is denied because the API call was made from an unauthorized IP.
    400920 (ReadOnlyMode)
    When the application is in read-only mode, can't complete API requests except for GET.
    400920 (NotAccessible)
    You may get this error message in the following cases:
    - The push notification is turned off in your Sendbird application.
    - An invalid parameter value is used for an announcement.
    - The request DELETE fails when the corresponding message has a child message.

    400
    (bad request)

    400930 (InvalidEndpoint)
    The request failed because it is sent to an invalid endpoint that no longer exists.

    403
    (forbidden)

    403100 (ApplicationNotAvailable)
    The application identified with the request isn't available.

    429
    (too many request)

    500910 (RateLimitExceeded)
    The request can't be completed because you have exceeded your rate limits.

    500
    (internal server error)

    500601 (InternalError.PushTokenNotRegistered)
    The server encounters an error while trying to register the user's push token. Please retry the request.

    500
    (internal server error)

    500602 (InternalError.PushTokenNotUnregistered)
    The server encounters an error while trying to unregister the user's push token. Please retry the request.

    500
    (internal server error)

    500901 (InternalError)
    The server encounters an unexpected exception while trying to process the request. Please retry the request.

    503
    (service unavailable)

    N/A (ServiceUnavailable)
    The request failed due to a temporary failure of the server. Please retry the request.