sms4sats API Documentation

Send or Receive SMS programmatically, pay with Lightning.
Instructions on how to use sms4sats.com API to generate sms activation code orders from anywhere, pay with Lightning Bitcoin and receive the activation codes.
Contact

Node Info

Feel free to open a direct channel to our node if you have trouble with routing or let us know and we're happy to open balanced channels to high volume partners.

API info

API root is at: https://api2.sms4sats.com. You can also use this endpoint to check for availability.
You need to use below country code list to map country names into country codes and send this code in certain queries. For example, to get available services for USA, you may need to send country=187 and not country=USA.
Country Code List

Getting Prices

Use this endpoint to check the price (in satoshis) that user will need to pay to use services offered by this API.
get
https://api2.sms4sats.com
/price
Get Receive/Send/Rent Price (in satoshis)

Getting Available Services

Use this endpoint to check for available numbers to receive activation codes for each offered service for a specific country.
get
https://api2.sms4sats.com
/getnumbersstatus
Get Available Services

Creating a Receive Order

Use this endpoint to create a receive SMS order for a specific country and service.
post
https://api2.sms4sats.com
/createorder
Create Receive Order
sms4sats uses hold invoices for payment, this means:
  • When invoice is paid by the user, it's not finalized but HELD by the sms4sats Lightning Node.
  • For receive orders, Only when an activation code is successfully received the invoice is SETTLED.
  • For send orders, Only when SMS status is "sent or delivered" the invoice is SETTLED.
  • If no code is received within 20 minutes, invoice will be CANCELED and funds will automatically return to user's wallet.

Getting Order Status

Use this endpoint to check the status of an order
get
https://api2.sms4sats.com
/orderstatus
Get Order Status

Creating a Send Order

Use this endpoint to create a send SMS order for a phone number and message.
post
https://api2.sms4sats.com
/createsendorder
Create Send Order

Funding an Account

If you have an API Key, you can fund your prepaid balance using this endpoint.
post
https://api2.sms4sats.com
/fund
Create Fund Order

Getting Account Balance

Use this endpoint to check the balance of an account
get
https://api2.sms4sats.com
/balance
Get Balance
Get in touch for volume discounts: [email protected].
Last modified 10d ago