Introduction

LiSco SMS sends SMS from the SIM cards in your own Android phones. You call one HTTP API from your server; a phone running the LiSco SMS Gateway app sends the message from its SIM and reports back.

How it works#

The phone never waits for incoming connections. It pulls: every 3 seconds it makes an outgoing HTTPS request to LiSco SMS, reports what happened to the messages it holds, and picks up new ones. That is why you need no public URL, no fixed IP and no port forwarding: if the phone can open a website, it can send for you.

  • Dual SIM: a phone uses both of its SIM cards; when one SIM fails, the phone tries the other.
  • Several phones: link more than one phone to a workspace and a message that fails on one phone is handed to another.
  • Any country, any network: messages go out as normal SMS from your SIMs.

A message's journey#

  1. Your server calls POST /v1/messages. The message is stored with status pending and you get its id back at once.
  2. Within about 3 seconds a linked phone pulls it: status claimed.
  3. The phone sends it from one of its SIMs: status sent.
  4. If the network returns a delivery report: status delivered.
  5. At every step you can read the message with GET /v1/messages/{id}, or receive the change as a webhook.

If no phone sends it before it expires, it becomes expired; if every attempt fails, failed. See Message statuses.

Base URL#

All endpoints live under one base URL; the examples in these docs use it:

https://sms.liscosolutions.com/v1

Requests and responses are JSON (Content-Type: application/json), times are ISO 8601 in UTC, and every request needs an API key.

OpenAPI#

The whole API is described in an OpenAPI 3.1 document. Import it into Postman, Insomnia or a client generator:

curl "https://sms.liscosolutions.com/v1/openapi.json"
Response · 200
{
  "openapi": "3.1.0",
  "info": {
    "title": "LiSco SMS API",
    "version": "1.0.0"
  }
}
Import into Postman: File → Import → Link, then paste the URL of /v1/openapi.json.