Api Dokumentation

Version	Dokumentation
Neueste	Neueste Api-Dokumentation

Sie können SMS-Nachrichten durch die API versenden oder ihr Backend, bei eingehenden SMS durch Webhooks, Benachrichtigen lassen.

Optional: omit sim_card to use your primary SIM; if it is unavailable, the next SIM by route priority is used as fallback. Configure priorities under MCP Setup / Dashboard. MCP agent

Für die Verwendung der Rest-Api müssen sie einen Zugangstoken generieren.

Liste von Sim-Karten laden

curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request GET https://www.tincansmartphone.com/api/sim-card/

Sms über eine bestimmte Sim-Karte senden

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.tincansmartphone.com/api/sms-out/

Webhook für empfangene SMS anlegen

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.tincansmartphone.com/api/hooks/

Webhook für gesendete SMS anlegen

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.tincansmartphone.com/api/hooks/

Liste von Webhooks laden

curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request GET https://www.tincansmartphone.com/api/hooks/

Einen Webhook löschen

curl \
    --header 'Accept: application/json; indent=4' \
    --header 'Authorization: Token <ACCESS_TOKEN>' \
    --request DELETE https://www.tincansmartphone.com/api/hooks/<HOOK_ID>/

Verfügbare Webhooks

Ereignis	Beschreibung
sms.out.created	Eine SMS wurde zur Versendung an die Api geschickt.
sms.out.sent	Eine SMS wurde als versendet markiert.
sms.in.received	Eine SMS wurde empfangen.
simcard.added	Eine Sim-Karte wurde hinzugefügt.
simcard.changed	Eine Sim-Karte wurde geändert.
simcard.removed	Eine Sim-Karte wurde entfernt.

Sie können einen Webhook über die Rest-Api anlegen (Webhook anlegen - API) oder über die Webseite (Webhook anlegen - Web).