SmsPing¶

GET sms/ping

Liveness probe for monitoring. Costs one SELECT 1 and reads process counters, so it can be polled often.

"The process answers" is not enough for this module: it can still be on the bus after losing its database or its queue cron, and in that state messages pile up in PENDING while nothing is sent. An empty problems array is what actually means healthy.

Access Control¶

Allowed role: admin. The handler does not read __access, so service-to-service calls over the bus work without a token.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/ping
Authorization: <JWT_TOKEN>

{
  "command": "SmsPing",
  "extID": "1",
  "data": {}
}

const res = await platform.SmsPing({});

Request Data¶

This method takes no parameters.

Behavior¶

The queue cron marks itself on every tick, even when the queue is empty, so silence longer than five intervals is a fault rather than an absence of messages.
Use SmsHealth when you need the full picture instead of a probe.

Response Data¶

Problem codes: DATABASE_UNAVAILABLE, ADAPTERS_FAILED, QUEUE_CRON_STALLED.

{
  "ok": true,
  "problems": [],
  "service": "sct-sms",
  "nodeID": "sct-sms-3227647",
  "version": "0.0.1",
  "startedAt": "2026-08-24T13:32:41.702Z",
  "uptimeSec": 412,
  "time": "2026-08-24T13:39:33.118Z",
  "database": { "ok": true, "latencyMs": 1 },
  "adapters": { "loaded": 11, "failed": [] },
  "crons": {
    "enabled": true,
    "queueIntervalSec": 5,
    "lastQueueRunAt": "2026-08-24T13:39:30.004Z",
    "lastQueueAgoSec": 3,
    "runs": 84
  }
}

Errors¶

Code	Error	Description
`502`	`MOL_CALL_FAILED`	The module is not on the bus