SMS API

Send transactional SMS (OTP codes, alerts) worldwide with a single HTTP request. You compose the text — we deliver it to the number.

Authentication

All requests are authenticated with an API key in the Authorization header. Create a key in your dashboard → API keys.

Authorization: Bearer sk_live_xxx

⚠️ Keep the key secret — it grants access to your balance. Revoke a compromised key in the dashboard.

Send SMS

Sends a single message. Charges the cost to your balance.

Body parameters (JSON)

Request example

curl -X POST https://sendoor.org/api/v1/sms/send \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+919800000000",
    "text": "Your code is 1234"
  }'

Response 201 Created

{
  "id": "8f3a1c2e-...",
  "status": "sent",
  "parts": 1,
  "price": "0.1000"
}

Send a messenger message

Deliver a message over WhatsApp, Telegram, Viber or IMO. Same billing model as SMS — you are charged the per-channel price and refunded automatically if delivery fails. Each channel is enabled separately on your API key; a key without a channel's access gets 403.

Body parameters (JSON)

Request example

curl -X POST https://sendoor.org/api/v1/messages/send \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "whatsapp",
    "phone": "+919800000000",
    "text": "Your code is 1234",
    "image_url": "https://example.com/pic.jpg"
  }'

Response 201 Created

{
  "id": "8f3a1c2e-...",
  "channel": "whatsapp",
  "status": "sent",
  "price": "0.0500"
}

Delivery status is retrieved the same way as SMS — GET /sms/{id}.

Message status

Returns the current delivery status (refreshed automatically).

curl https://sendoor.org/api/v1/sms/MESSAGE_ID \
  -H "Authorization: Bearer sk_live_xxx"

Response

{
  "id": "8f3a1c2e-...",
  "phone": "+919800000000",
  "status": "delivered",
  "parts": 1,
  "price": "0.1000",
  "reference": "order-42",
  "createdAt": "2026-06-08T12:00:00.000Z"
}

Balance

Your account's current balance.

curl https://sendoor.org/api/v1/balance \
  -H "Authorization: Bearer sk_live_xxx"

Response

{ "balance": "42.50", "currency": "USD" }

Your available countries

Returns the countries enabled for your account, with prices. Just send the full E.164 number — the country is detected automatically.

curl https://sendoor.org/api/v1/countries \
  -H "Authorization: Bearer sk_live_xxx"

Response

{
  "countries": [
    { "iso": "IN", "name": "India", "dial": "91", "price": "0.1000" }
  ],
  "defaultPrice": null,
  "currency": "USD"
}

Status values

Errors

On error, the matching HTTP code and a { error, message } body are returned.

Idempotency

Pass a unique reference field in the send request. A repeated request with the same reference won't create a duplicate or charge again — the existing message is returned. Handy for network-timeout retries.

Countries

The country is detected automatically from the number. Available destinations and prices are configured by your manager. The ISO code is the one used in pricing.

SMPP connectivity

For platforms with their own SMS engine we provide a standard SMPP 3.4 interface. Pricing, enabled countries, balance and refunds are the same as for the HTTP API — you can use both channels in parallel on a single account.

Credentials (system_id + password) are issued by your account manager. They are separate from your API key.

Connection parameters

Notes

• •Destination numbers in international (E.164) format, e.g. 919800000000.
• •Encodings: GSM 7-bit and UCS-2 (data_coding 8) for Unicode.
• •Long SMS: concatenation via UDH (8/16-bit ref) or message_payload — parts are reassembled and billed as one message.
• •DLR: set registered_delivery=1 to receive deliver_sm with a standard receipt (stat: DELIVRD / UNDELIV / EXPIRED). Undelivered messages are refunded automatically.
• •The message_id from submit_sm_resp is the same id as in the HTTP API — you can also check status via GET /sms/{id}.

Error codes (command_status)