API ReferenceapicommsPOST /v1/admin/sla/sms-ping

POST /v1/admin/sla/sms-ping

Service: comms · operationId: (none)

Send canary SMS to verify Twilio delivery pipeline health

Required scopes

(no scope declared — review service config)

Responses

200 SMS ping result

{
  "type": "object",
  "properties": {
    "delivered": {
      "type": "boolean"
    },
    "latency_ms": {
      "type": "number"
    }
  },
  "required": [
    "delivered",
    "latency_ms"
  ]
}

500 Ping failed

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://comms.platform.loop.health/v1/admin/sla/sms-ping \
  -H "Authorization: Bearer $ACCESS_TOKEN"