Cookies disclaimer

I agree Our site saves small pieces of text information (cookies) on your device in order to deliver better content and for statistical purposes. You can disable the usage of cookies by changing the settings of your browser. By browsing our website without changing the browser settings you grant us permission to store that information on your device. More information

Api Documentation

Version Docs Docs-Swagger
Latest Api-latest docs Api-latest docs (Swagger)

You can send sms via the api or create webhooks to get notified in your own backend of received sms on your connected smartphone.

Before you can use the api, you should generate an access token.

Fetch list of sim cards
curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request GET https://www.sms-api-gateway.com/api/sim-card/
Send sms via a specific sim card
curl \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --data '{"sim_card":"<SIM_CARD_ID>", "to_number":"<RECEIVER_PHONE_NUMBER>", "text": "Hello!"}' \
    --request POST https://www.sms-api-gateway.com/api/sms-out/
Create webhook for received sms
curl \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --data '{"target": "http://example.com/target.php", "event": "sms.in.received"}' \
    --request POST https://www.sms-api-gateway.com/api/hooks/
Create webhook for sent sms
curl \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --data '{"target": "http://example.com/target.php", "event": "sms.out.created"}' \
    --request POST https://www.sms-api-gateway.com/api/hooks/
Fetch list of webhooks
curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request GET https://www.sms-api-gateway.com/api/hooks/
Delete a webhook
curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request DELETE https://www.sms-api-gateway.com/api/hooks/<HOOK_ID>/
Available webhooks
Event Description
sms.out.created Sms was sent to the Api for dispatch
sms.out.sent The sms was marked as sent
sms.in.received A sms was received
simcard.added A sim card was added
simcard.changed A sim card was changed
simcard.removed A sim card was removed

You can create a webhook via the Rest-Api (create webhook - api) or via the website (create webhook - web).

Copyright © 2019 Andrej Albrecht. All rights reserved.