opensms :: docs

$ documentation

OpenSMS turns an Android phone and SIM into an HTTP SMS gateway. This documentation covers everything you need to send SMS from your application.

## how it works

A small job queue sits between your application and your phone. Your application creates a job, a paired gateway claims it, sends the SMS, and reports the outcome.

your application
      │  api key
      ▼
 opensms api  (/api/v1/*)
      │
 sms job queue
      │
 android gateway app
      │
    sim  →  sms

## authentication

External requests authenticate with an API key sent as a bearer token. You create keys from the dashboard; the full key is shown once.

header

Authorization: Bearer opensms_xxxxxxxxx

The dashboard itself uses Google sign-in, and the Android gateway app is paired separately with an API key. Your applications only ever need the API key.

## next steps

→ getting started
→ api reference