Dokumentacja SMS API

1.1 Wysyłka wiadomości

Typ zawartości: application/json · Autoryzacja: Bearer token

Pola ciała żądania

Przykładowe żądanie

curl -X POST https://msg-api.actio.pl/api/sms \
  -H "Authorization: Bearer TWOJ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "48732129000",
    "to": "48732129001",
    "body": "Test ACTIO"
  }'

Odpowiedź 200

Wiadomość przyjęta do wysyłki. Ciało zawiera message_id (16 znaków hex).

{"message_id":"a906cff7719bd889"}

Błędy

Ciało błędu może zawierać pola errors.token, errors.from, errors.to, errors.body (tablice komunikatów).

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

1.2 Wysyłka na wiele numerów

Wysyłka tej samej wiadomości na wiele numerów. Aktywacja funkcji dla tokena wyłącznie przez biuro obsługi klienta.

Pola ciała żądania

Przykładowe żądanie

curl -X POST https://msg-api.actio.pl/api/sms-multi \
  -H "Authorization: Bearer TWOJ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "48732129000",
    "to": ["48732129001", "48732129002"],
    "body": "Test ACTIO"
  }'

Odpowiedź 200

Pole message_ids – tablica obiektów z polami number i message_id.

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

Błędy

Ciało błędu może zawierać pola errors.token, errors.from, errors.to, errors.body (tablice komunikatów).

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

1.3 Odbiór wiadomości (webhook)

Wiadomości przychodzące wysyłane są na podany w panelu klienta webhook. Webhook można także podać w dyspozycji do biura obsługi klienta. Podjętych zostanie do 36 prób dostarczenia wiadomości. Interwały powiadomień oraz dodatkowe informacje na ten temat zostały opisane w sekcji „Notyfikacje”. Żądanie API nie śledzi przekierowań, nie autoryzuje się także do webhooka. Żądanie pochodzić będzie z aktualnego adresu IP domeny msg-api.actio.pl.

Metoda: POST · Typ zawartości: application/json

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

1.4 Potwierdzenie dostarczenia (webhook)

W przypadku chęci otrzymywania powiadomień o dostarczeniu wiadomości należy aktywować tę opcję w panelu klienta lub przez dyspozycję dla biura obsługi klienta. Aktywacja tej opcji spowoduje przesyłanie żądania na podany adres webhooka. Podjętych zostanie do 36 prób dostarczenia wiadomości. Interwały powiadomień oraz dodatkowe informacje na ten temat zostały opisane w sekcji „Notyfikacje”. Żądanie API nie śledzi przekierowań, nie autoryzuje się także do webhooka. Żądanie pochodzić będzie z aktualnego adresu IP domeny msg-api.actio.pl.

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

2. 3CX SMS API

Obsługuje wysyłkę i odbiór wiadomości zgodnie z aktualną specyfikacją centrali 3CX Phone System. Aby aktywować, w panelu klienta zaznacz obie opcje: SMS API oraz 3CX SMS API.

Połączenia wychodzące

W sekcji SMS w 3CX podaj token (z panelu klienta) oraz adres URL:

https://msg-api.actio.pl/api/tcx

Wiadomości przychodzące

W panelu klienta podaj webhook dostępny w centrali 3CX. Aktywacji może dokonać też biuro obsługi klienta – wówczas po podaniu webhooka w odpowiedzi przesłany zostanie token.

3. Notyfikacje

Opisane w 1.3 i 1.4 powiadomienia wysyłane są dopóki wywoływany webhook nie zwróci poprawnej odpowiedzi 200 OK lub nie zostanie wyczerpany limit notyfikacji. System przerywa także wysyłkę, jeśli zostanie zwrócona odpowiedź z kodem 404 (Not Found) lub 418 (I’m A Teapot). Poniżej przedstawione zostały interwały, w jakich wysyłane są powiadomienia: