API Error codes

HTTP Error Codes

8x8 API might return the following HTTP error codes:

200OK, The request has succeeded.
201Created, The request has succeeded and a new resource has been created as a result.
202Accepted, The request has been received but not yet acted upon.
204No Content, The request has succeeded, but there is no content to send as a response.
400Bad Request, Request has invalid syntax.
401Unauthorized, The client must provide the correct API key in the Authorization header.
403Forbidden, The client is authenticated but does not have permissions to the content
404Not Found, The server can not find the requested resource.
410Gone, The requested content has been permanently deleted from the server, with no forwarding address. This usually applied to the API version that's not supported anymore.
422422 Unprocessable Entity, The request was well-formed but was unable to be followed due to semantic errors.
429Too Many Requests, The user has sent too many requests in a given amount of time ("rate limiting").
500Internal Server Error, The server has encountered a situation it doesn't know how to handle.

All API responses with HTTP code 400 and above has the following properties:

  • code (integer) - Error code
  • message (string) - Human-readable error description
  • errorId (UUID) - Unique id of the error. You can use it as a reference when sending inquiries to 8x8 support.
  • timestamp (string, date-time) - Date and time of the error occurrence. Format: yyyy-MM-ddTHH:mm:ss.ffZ
    "code": 1300,
    "message": "Object wasn't found or is already expired",
    "errorId": "1cc1eda1-f5dd-ea11-8288-0263195dd35a",
    "timestamp": "2020-12-22T05:52:01.85Z"

JSON Code Property Values

The table below refers to the possible values of the "code" parameter, in the response body returned by the API as shown above. They can be used for additional clarity of what type of error was encountered.

SMS API, Chat Apps API

1000Invalid parameter
1001Illegal SubAccountId
1002Invalid MSISDN
1003Invalid Endoding
1004Invalid Text
1005Invalid Source
1006Invalid Expiry
1007Invalid SMS Template
1008Invalid ID
1009Invalid Country Code
1010Parameter out of range
1011Invalid Schedule Time
1100Bulk limit reached
1200Unauthorized Access
1201Access forbidden
1300Not found
1400Resending interval violation
2000Internal Error
2001Function not implemented
2002Unsupported API version
2003Unsupported product
3001Missed User
3002Missed MSISDN
3003Invalid MSISDN
3004Missed Content
3005Missed Text
3006Too long text
3007Missed Media URL
3008Invalid Media URL
3009Too long ClientMessageId
3010Invalid Content Type
3011Too long SMS Source
3012Missed messages
3013Too much messages
3014Too long ClientBatchId
3015Missed UserId
3016Missed WeChatUserId
3017Too long Fallback text
3018Invalid Country code
3019Missed FacebookUserId
3020Invalid DR Callback URL
3021Empty or Invalid Location
3022Invalid Fallback Channel
3023Invalid Fallback Delay range
3024Invalid Fallback Status
3025Invalid Fallback Status Delivered
3026Invalid Fallback Status Read
3027Invalid Fallback SubAccount Channel
3028Missed ZaloUserId
3029Missed UMID
3030Empty Template
3031Invalid Template Name Length
3032Invalid Template Name
3033Too much template parameters passed
3034Invalid template components combination
3035SubAccount don’t have channels, supported templates
3036Empty Template language
3037Invalid Template language
3038Template not found
3039Invalid Template Component type
3040Empty template parameters
3041Invalid Template parameter
3042Invalid Template parameter type
3043Template Text parameter length exceeded
3044Template Location parameter empty
3045Template parameter not allowed
3046Template parameter URL is invalid
3047Missed WhatsApp UserID
3048Using ChatGroupId with UserId not allowed
3049Invalid button parameter
3050Missed KakaoId
3051Invalid Fallback ChannelID
3052Invalid Template Component SubType
3053Invalid Button index