API-Referenz

SENDLY SMS API

Vollständige Referenz aus OpenAPI generiert – immer synchron mit der Spezifikation. Endpunkte, Feld-Schemas, Antworten und Webhooks.

https://api.sendly.linkopenapi.json PDF v1.3 herunterladen

POSThttps://api.sendly.link/api/sms

Versand von SMS-Nachrichten

Standardbetriebsmodus der API, vorgesehen für die Verwendung mit Anwendungen, die REST API unterstützen.

Request-Body

fromstring
Nummer der virtuellen Mobilnummer in SENDLY (optionales Feld).
pattern: ^[0-9]{9,11}$
tostringerforderlich
Ziel-Mobilnummer.
pattern: ^[0-9]{9,11}$
bodystringerforderlich
Nachrichtentext.
min 1

curl -X POST https://api.sendly.link/api/sms \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"48732129000","to":"48732129001","body":"Test SENDLY"}'

Antwort · 200 – Die Nachricht wurde zum Versand angenommen.

{
  "message_id": "a906cff7719bd889"
}

Antwort · 403 – Autorisierungsproblem.

{
  "errors": {
    "token": [
      "Invalid token"
    ]
  }
}

Antwort · 422 – Problem bei der Datenvalidierung.

{
  "description": "Problem bei der Datenvalidierung."
}

Antwort · 429 – Anfragelimit überschritten.

{
  "description": "Anfragelimit überschritten."
}

POSThttps://api.sendly.link/api/sms-multi

Versand von Nachrichten an mehrere Nummern

Versand derselben Nachricht an mehrere Nummern. Die Aktivierung dieser Funktion für den Zugriffstoken erfolgt ausschließlich über den Kontakt mit dem Kundenservice. Validierung der Nummern nach dem Prinzip „alles oder nichts“ – jede Nummer muss eine gültige polnische Mobilnummer sein, die Nummern müssen eindeutig sein; andernfalls wird die Anfrage vollständig abgelehnt.

Request-Body

fromstring
Nummer der virtuellen Mobilnummer in SENDLY (optionales Feld).
pattern: ^[0-9]{9,11}$
toarray<string>erforderlich
Ziel-Mobilnummern.
1–100 · unique
bodystringerforderlich
Nachrichtentext.
min 1

curl -X POST https://api.sendly.link/api/sms-multi \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"48732129000","to":["48732129001","48732129002"],"body":"Test SENDLY"}'

Antwort · 200 – Die Nachricht wurde zum Versand angenommen.

{
  "message_ids": [
    {
      "number": "48732129001",
      "message_id": "a906cff7719bd889"
    }
  ]
}

Antwort · 403 – Autorisierungsproblem.

{
  "errors": {
    "token": [
      "Invalid token"
    ]
  }
}

Antwort · 422 – Problem bei der Datenvalidierung.

{
  "description": "Problem bei der Datenvalidierung."
}

Antwort · 429 – Anfragelimit überschritten.

{
  "description": "Anfragelimit überschritten."
}

POSThttps://api.sendly.link/api/tcx

3CX SMS API

3CX SMS API-Modus: Versand und Empfang von Nachrichten auf Basis der aktuellen Spezifikation der 3CX Phone System-Telefonanlage. Aktivierung: im Kundenpanel beide Optionen (SMS API und 3CX SMS API); im SMS-Bereich in 3CX werden der token aus dem Panel sowie diese URL eingetragen. Format der Anfragen/Antworten gemäß der 3CX-Spezifikation.

Request-Body

Keine Anfrage-Parameter.

Antwort · 200 – Gemäß der Spezifikation der 3CX Phone System-Telefonanlage.

{
  "description": "Gemäß der Spezifikation der 3CX Phone System-Telefonanlage."
}

Webhooks

Ereignisse, die SENDLY an deine Webhook-URL sendet – eingehende Nachrichten und Zustellbestätigungen.

POSTinboundMessage

Nachrichtenempfang (Webhook)

Eingehende Nachrichten gehen an den Webhook aus dem Panel (SMS-Gateway → Diensteinstellungen: Zustellung und URL, beides nötig). POST application/json von der IP von api.sendly.link, bis zu 36 Versuche, ohne Redirects und ohne eigene Auth. 200 OK beendet die Wiederholungen; 404 und 418 ebenfalls.

typestring
Nachrichtentyp – für eingehende „MESSAGE“.
= MESSAGE
fromstring
Anzeige der Absendernummer; bei überschriebener Nummer – die Überschreibung.
tostring
Ziel-Telefonnummer.
bodystring
Nachrichtentext.

Payload

{
  "type": "MESSAGE",
  "from": "48732129000",
  "to": "48732129001",
  "body": "Test sms"
}

POSTdeliveryNotification

Zustellbestätigung der Nachricht (Webhook)

Nach Aktivierung der Zustellung und Eintragen der URL im Panel (beide Schritte nötig) sendet Sendly den Status per POST. Bis zu 36 Versuche, ohne Redirects und ohne eigene Auth, von der IP von api.sendly.link. 200 OK beendet die Wiederholungen; 404 und 418 ebenfalls. Speichere message_id aus der API-Antwort, um die NOTIFICATION der gesendeten SMS zuzuordnen.

typestring
Nachrichtentyp – für den Status „NOTIFICATION“.
= NOTIFICATION
message_idstring
Nachrichtenkennung, die nach der Annahme zum Versand zurückgegeben wird.
statusstring
DELIVERED – zugestellt; ERROR – Fehler.
DELIVERED · ERROR

Payload

{
  "type": "NOTIFICATION",
  "message_id": "a906cff7719bd889",
  "status": "DELIVERED"
}