Appearance
HTTP Responses
Our APIs are RESTful. Here is an outline of common HTTP responses you might encounter while interacting with the endpoints, along with their meanings and suggested actions:
| HTTP Status Code | Meaning | What You Should Do |
|---|---|---|
| 200 OK | Request was successful. | Everything’s working. Move forward with your next operations. |
| 201 Created | Resource was successfully created. | Confirm creation. You can now interact with the new resource. |
| 202 Accepted | Request received, processing in progress. | The request is being processed asynchronously. Wait for a completion callback or follow-up status. |
| 204 No Content | Success but no content returned. | No further action needed. Common after DELETE operations. |
| 400 Bad Request | The request is invalid (missing parameters or syntax issues). | Double-check your request payload or parameters. Fix any errors in formatting or required fields. |
| 401 Unauthorized | Authentication failed or missing API key. | Ensure the Authorization header contains your API key, the API Key is valid and you’re authenticated properly using Bearer API_KEY |
| 403 Forbidden | You don't have permission to access this resource. | Your API key may lack the required permissions. Verify your access rights and adjust accordingly. |
| 404 Not Found | The endpoint or resource doesn't exist. | Double-check the URL or resource ID. Ensure you're querying the right path or resource. |
| 405 Method Not Allowed | You're using the wrong HTTP method. | Confirm you’re using the correct method (GET, POST, PUT, DELETE) for the endpoint you're targeting. |
| 409 Conflict | Request conflicts with the current resource state. | This usually happens with duplicate data. Review your input to ensure there's no conflict and try again. |
| 429 Too Many Requests | You've hit the rate limit. | Slow down your request rate or wait for the rate limit window to reset. |
| 500 Internal Server Error | Something went wrong on the server side. | This is on the API’s end. Retry the request after a short delay. If it keeps happening, contact the provider. |
| 502 Bad Gateway | Bad response from an upstream server. | Likely a temporary issue. Retry the request after a few minutes. |
| 503 Service Unavailable | Server is overloaded or under maintenance. | Wait a bit and retry. If it persists, the service might be down or undergoing maintenance. |
| 504 Gateway Timeout | Server is taking too long to respond. | Timeout usually means the server is slow or unavailable. Retry after a short wait, or investigate further. |
| 523 Origin is Unreachable | Could not establish connection with Cecula API Service. | Service is temporarily down (possibly on maintenance). Please try again after a while. If issue persist, contact our support. |
Key Points:
- 4xx errors are issues with your request (incorrect parameters, missing data, or lack of permissions).
- 5xx errors mean the problem is on the server's end. In most cases, a retry or reporting the issue to the API provider is the next step.
Important
The fact that a broadcast returned 200 OK does not guarantee that everything is fine. The status code within the JSON response is your source of truth. See full list of SMS Broadcast responses.