Check the service status.
For the full technical reference, see the OpenAPI specification
- URL:
/api/Services/checkServiceStatus - Method:
POST
No authentication required — this endpoint is public.
If the SMS Gateway is completely unavailable, this endpoint will return 503 Service Unavailable. Implement appropriate error handling for this case.
This endpoint does not require any body parameters.
Success (200 OK)
{
"globalStatus":true,
"dbStatus":true,
"servicesStatus":true,
"errorMessage":"",
"versionNumber":"27.0.0.13"
}| Field | Type | Description |
|---|---|---|
globalStatus | boolean | Overall service availability |
dbStatus | boolean | Database connectivity status |
servicesStatus | boolean | Internal services availability |
errorMessage | string | Error message if any component is unavailable. Empty string when all systems are operational |
versionNumber | string | Current API version (e.g. 27.1.0.2) |