API Reference

SENDLY SMS API

Pełny reference generowany z OpenAPI – zawsze zgodny ze specyfikacją. Endpointy, schematy pól, odpowiedzi i webhooki.

https://api.sendly.linkopenapi.json

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

Wysyłka wiadomości SMS

Domyślny tryb działania API, przeznaczony do wykorzystania z aplikacjami obsługującymi REST API.

Body żądania

fromstring
Numer wirtualnego numeru komórkowego w SENDLY (pole opcjonalne).
pattern: ^[0-9]{9,11}$
tostringwymagane
Docelowy numer komórkowy.
pattern: ^[0-9]{9,11}$
bodystringwymagane
Treść wiadomości.
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"}'

Odpowiedź · 200 – Wiadomość została przyjęta do wysyłki.

{
  "message_id": "a906cff7719bd889"
}

Odpowiedź · 403 – Problem z autoryzacją.

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

Odpowiedź · 422 – Problem z walidacją danych.

{
  "description": "Problem z walidacją danych."
}

Odpowiedź · 429 – Przekroczono limit żądań.

{
  "description": "Przekroczono limit żądań."
}

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

Wysyłka wiadomości na wiele numerów

Wysyłka tej samej wiadomości na wiele numerów. Aktywacja tej funkcji dla tokena dostępowego następuje wyłącznie poprzez kontakt z biurem obsługi klienta. Walidacja numerów na zasadzie „wszystko albo nic" – każdy numer musi być poprawnym polskim numerem komórkowym, numery muszą być unikalne; inaczej żądanie zostaje odrzucone w całości.

Body żądania

fromstring
Numer wirtualnego numeru komórkowego w SENDLY (pole opcjonalne).
pattern: ^[0-9]{9,11}$
toarray<string>wymagane
Docelowe numery komórkowe.
1–100 · unique
bodystringwymagane
Treść wiadomości.
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"}'

Odpowiedź · 200 – Wiadomość została przyjęta do wysyłki.

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

Odpowiedź · 403 – Problem z autoryzacją.

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

Odpowiedź · 422 – Problem z walidacją danych.

{
  "description": "Problem z walidacją danych."
}

Odpowiedź · 429 – Przekroczono limit żądań.

{
  "description": "Przekroczono limit żądań."
}

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

3CX SMS API

Tryb 3CX SMS API: wysyłka i odbiór wiadomości na podstawie aktualnej specyfikacji centrali 3CX Phone System. Aktywacja: w panelu klienta obie opcje (SMS API oraz 3CX SMS API); w sekcji SMS w 3CX podaje się token z panelu oraz ten adres URL. Format żądań/odpowiedzi zgodny ze specyfikacją 3CX.

Body żądania

Brak parametrów w żądaniu.

Odpowiedź · 200 – Zgodnie ze specyfikacją centrali 3CX Phone System.

{
  "description": "Zgodnie ze specyfikacją centrali 3CX Phone System."
}

Webhooki

Zdarzenia wysyłane przez SENDLY na Twój adres webhooka – odbiór wiadomości i potwierdzenia doręczenia.

POSTinboundMessage

Odbiór wiadomości (webhook)

Wiadomości przychodzące wysyłane są na podany w panelu klienta webhook. Jedna próba dostarczenia; bez śledzenia przekierowań i bez autoryzacji. Żądanie pochodzi z aktualnego adresu IP domeny api.sendly.link.

typestring
Typ wiadomości – dla przychodzącej „MESSAGE".
= MESSAGE
fromstring
Prezentacja numeru źródłowego; przy nadpisanym numerze – nadpis.
tostring
Docelowy numer telefonu.
bodystring
Treść wiadomości.

Payload

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

POSTdeliveryNotification

Potwierdzenie dostarczenia wiadomości (webhook)

Po aktywacji opcji (panel klienta lub BOK) żądanie wysyłane jest na podany adres webhooka. Jedna próba dostarczenia; bez śledzenia przekierowań i bez autoryzacji. Żądanie pochodzi z aktualnego adresu IP domeny api.sendly.link.

typestring
Typ wiadomości – dla statusu „NOTIFICATION".
= NOTIFICATION
message_idstring
Identyfikator wiadomości zwrócony po przyjęciu do wysyłki.
statusstring
DELIVERED – dostarczono; ERROR – błąd.
DELIVERED · ERROR

Payload

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