SuperVoIP API

➡️ Dzięki usłudze możesz:
– uzyskać informacje o trwających przychodzących i wychodzących połączeniach,
– pobrać statusy kont SIP (zalogowane, niezalogowane),
– zestawić połączenie pomiędzy numerami zewnętrznymi,
– zestawić połączenie z grupą numerów i numerem docelowym,
– wykonać połączenie poprzez kliknięcie w numer,
– wykonać połączenie ze sprawdzeniem numeru (system odrzuca numer z pocztą głosową lub faksem)
– pobrać biling według różnych filtrów,
– pobrać nagrane rozmowy,
– pobrać pliki audio z IVR.
– definiować kolejki,
– definiować przekierowania,
– dodawać numery

➡️ Dzięki API możesz dodatkowo:
– zestawiać połączenia ze zmienną prezentacją,
– transferować rozmowy na inny numer,
– wysyłać i odbierać wiadomości SMS

➡️ Dzięki API możesz zarządzać:
– numerami telefonów,
– kontami SIP,
– kolejkami,
– scenariuszami IVR

ℹ️ Jak działa API?
– możesz odpytywać nasze API w celu pobrania różnych danych,
– API może wywoływać webhook w momencie zmiany stanu połączenia przychodzącego lub wychodzącego, przekazując w żądaniu różne zmienne opisujące to zdarzenie.

Dokumentacja API

🔗 API rest: https://restapi.supervoip.pl/
🔗 API soap: https://panel.supervoip.pl/api/SoapApi/documentation_pdf
🔄 SoAP API nie jest dostępna dla kont zarejestrowanych po 01.01.2026

Instalacja usługi

Stary panel Nowy panel

Instalacja usługi możliwa jest w panelu w zakładce “Moje Usługi”, pod dolną belką w “Usługi globalne” wybierz z listy rozwijanej: SuperVoIP API

Po aktywacji usługi API SOAP w ustawieniach zobaczysz unikalny klucz API, który stanowi dodatkowe zabezpieczenie i jest generowany za każdym razem gdy aktywujemy usługę. Korzystanie z API jest możliwe od razu po otrzymaniu klucza API.

Aby dodać usługę kliknij Wirtualna Centrala > Usługi > Dodaj usługę > SuperVoIP API
🔄 lub Finanse > Pakiety i Usługi > Usługi -> SuperVoIP API

Jeśli usługa jest aktywna na koncie przejdź do konfiguracji usługi:

Po aktywacji usługi znajdziesz dostęp do API SOAP oraz API REST.

W ustawieniach API SOAP klucz wygeneruje się automatycznie. W Ustawieniach API REST będziesz mógł wygenerować własne klucze API. Korzystanie z API jest możliwe od razu po otrzymaniu / wygenerowaniu klucza API.

Webhook

Stary panel Nowy panel

Aby uruchomić wysyłanie webhooka, wystarczy wpisać w polu “Webhook” adres URL.
W API SOAP w adresie URL należy użyć nazw zmiennych, które zostaną automatycznie zastąpione odpowiednimi wartościami.

⚠️ W Rest API wartości zmiennych będą wysyłane w formacie XML. Rest API dostępne jest w nowym panelu.

Aby uruchomić wysyłanie webhooka, wystarczy wpisać w polu “Webhook” adres URL.

W API SOAP w adresie URL należy użyć nazw zmiennych, które zostaną automatycznie zastąpione odpowiednimi wartościami.
🛑  SoAP API nie jest dostępna dla kont zarejestrowanych po 01.01.2026

W Rest API wartości zmiennych będą wysyłane w formacie XML. Przejdź do ustawień Rest API:

Webhooki mogą zwrócić następujące parametry i ich wartości:
(dotyczy Rest API)

➡️ Dane połączenia wychodzącego :
‘status’ => ‘callstart’,’callend’
‘direction’ => ‘out’,
‘numberA’ => numer źródłowy
‘numberB’ => numer docelowy
‘uniqueid’ => uniqueid połączenia
‘disposition’ => answer,busy,chanunavail
‘sipnumber’ => numer konta sip
‘billseconds’ => czas rozmowy,
‘createdat’ => unixtimestamp,
‘callid’ => własne callid

➡️ Dane połączenia przychodzącego :
‘status’ => ‘callstart’,’callend’,’queuestart’
‘IVRaction’ => ‘akcja w IVR’,
‘direction’ => ‘in’,
‘numberA’ => numer źródłowy
‘numberB’ => numer docelowy
‘disposition’ => answer,busy,chanunavail
‘sipnumber’ => numer konta sip
‘billseconds’ => czas rozmowy,
‘createdat’ => unixtimestamp,
‘callid’ => własne callid

➡️ Informacje o SIP biorącym udział w połączeniu:
‘status’ => ‘callanswer’,’callringing’,
‘IVRaction’ => ‘nazwa akcji IVR’,
‘direction’ => ‘out’,’in’
‘numberA’ => numer źródłowy
‘numberB’ => numer docelowy
‘uniqueid’ => uniqueid połączenia
‘sipnumber’ => numer konta sip
‘createdat’ => unixtimestamp,
‘callid’ => własne callid

Wysyłanie SMS przez REST API

Aby wysłać wiadomość SMS przez REST API z numeru komórkowego znajdującego się na koncie, należy spełnić dwa kluczowe warunki: poprawnie wskazać numer w polu voipNumber oraz ustawić odpowiednią wartość pola sender.

1️⃣ Wskazanie numeru VoIP (voipNumber)
W polu voipNumber nie należy podawać numeru telefonu w formacie MSISDN, lecz ID numeru VoIP, pobrane wcześniej z API.
Format:
/api/voip_numbers/XXXXX
gdzie XXXXX to ID numeru VoIP przypisanego do konta, zwrócone przez API (np. endpoint listy numerów VoIP).

📌 Uwaga:
Podanie numeru telefonu zamiast ID spowoduje, że SMS nie zostanie wysłany z wybranego numeru.

2️⃣ Ustawienie pola sender
Pole sender musi być ustawione i mieć wartość:
“voipNumber”

📌 W przeciwnym wypadku:
pole voipNumber zostanie zignorowane,
SMS zostanie wysłany z losowego nadawcy,

3️⃣ 3. Przykład requesta (JSON)
{
“to”: “+48732123XXX”,
“content”: “Przykładowa treść SMS wysłanego przez REST API”,
“sender”: “voipNumber”,
“voipNumber”: “/api/voip_numbers/12345”
}

📌 W powyższym przykładzie:
SMS zostanie wysłany z tego konkretnego numeru +48732123XXX
12345 to ID numeru komórkowego, który znajduje się na koncie,

4️⃣ Podsumowanie
Aby wysłać SMS z numeru komórkowego dostępnego na koncie:

• ✅ pole voipNumber musi wskazywać na /api/voip_numbers/{ID}
• ✅ pole sender musi mieć wartość "voipNumber"

⚠️ Niespełnienie któregokolwiek z powyższych warunków spowoduje wysyłkę SMS z losowego nadawcy.

Info (API SOAP)

🔄 dotyczy API SOAP:
🔗 Gotową aplikację do testów napisaną w języku PHP można uruchomić pod adresem: https://panel.supervoip.pl/soap_client/
Aby z niej skorzystać należy posiadać konto w SuperVoIP i aktywną usługę SuperVoIP API.
🔗 Dla programów w języku Python zalecamy użycie pliku WSDL: https://panel.supervoip.pl/soap1.1.phpWSDL

🛑 SoAP API nie jest dostępna dla kont zarejestrowanych po 01.01.2026

⚠️ Jeżeli używasz domyślnej metody autoryzacji loginem i hasłem a masz na koncie dodanych innych użytkowników użyj danych konta głównego (admina) którymi logujesz się do panelu SuperVoIP.