opensms :: docs

$ api reference

The public API is authenticated with an API key. All endpoints return JSON.

## base url

https://opensms.dev

header

Authorization: Bearer opensms_xxxxxxxxx

method	path	description
POST	/api/v1/messages	Create an SMS job. Body: to, message, optional deviceId, optional simId.
GET	/api/v1/messages/:id	Get a job and its delivery status.

Errors use a consistent envelope with a machine-readable code.

error

{
  "error": {
    "message": "Invalid or revoked API key",
    "code": "invalid_api_key"
  }
}

The API applies a simple fixed-window rate limit and returns 429 with a retry-after header when exceeded.

Ready to send? See send sms .