Dokumentacja zawiera listę funkcji związanych z działaniem usługi API dla konta i numeracji Premium
Wszystkie opcje dostępne są także po zalogowaniu się do Panlu Zarządzania Usługą. Usługa API jest płatna ( 40 zł netto/miesiąc). Nie ma obowiązku korzystania z tej usługi i nie jest ona włączana domyślnie na koncie Partnera. Usługa może Ci się przydać w sytuacji, gdy chcesz poprzez swoją stronę/aplikację kontrolować numerację (dodawać/usuwać/zmieniać przekierowania numeracji Premium), swoje konto, a także m.in billing z rozszerzonymi informacjami. Na tej stronie dowiesz się jak korzystać z API.
W celu właczenia usługi należy wejść do Panelu Zarządzania Usługą z lewego MENU wybrać opcję API. API dla SMS jest bezpłatne włączone dla kazdego klienta, ale nie musisz z niego korzystać. Pełną obsługe obsługę zarówno SMSów, jak i połączeń masz przez Panel Zarzadzania Usługą. Jesli potrzebujesz API dla połączeń, swojego konta uaktywnij je w tym właśnie miejscu. Po aktywacji zostanie Ci przydzielony APIKEY, który zawsze będzie widoczny w tym miejscu. Nie udostępniaj go nigdy nikomu. Jest on tak samo istotny jak Twoje hasło!
Mozliwości jakie daje API 70x poznasz zapoznając sie z dokumentacją. Jesli potrzebujesz innej, lub dodatkowej opcji skontaktuj się z nami poprzez zakładkę Kontakt. Opisz dokładnie co potrzebujesz, a w ciągu max 14 dni (zazwyczaj odbywa się to do 2 dni roboczych (choć statystyka mówi o 2-3 godzinach)) wprowadzimy Twoją funkcjonalność :).
Numery-Premium.PL kontaktują się z Partnerami z adresu IP: 77.237.17.9/32, 77.237.17.10/32 oraz 86.106.91.171/32.
API Numery-Premium.PL po wykonaniu każdej opcji zwraca odpowiedni komunikat.
KOD | Status | Info |
---|---|---|
200 | OK | Zapytanie zostało odebrane prawidłowo i wykonane poprawnie |
201 | CREATED | Zapytanie utworzyło nowy element. |
202 | ACCEPTED | Zapytanie zostało prawidłowo zaakceptowane i wstawione do kolejki. |
204 | NO CONTENT | Zwracany przy prawidłowym usunięciu elementu. |
KOD | Status | Info |
---|---|---|
401 | UNAUTHORIZED | Brak prawidłowej autoryzacji, lub odpowiednich uprawnień do wykonania akcji. |
403 | FORBIDDEN | Brak uprawnień do danego zasobu. |
404 | NOT FOUND | Nie znaleziono zasobu. |
405 | METHOD NOT ALLOWED | Metoda niedozwolona. Zastosuj się do dokumentacji. |
422 | UNPROCESSABLE ENTITY | Zwracany wraz z informacją o błędach w zasobie. |
Numery-Premium.PL API 70x odpowiada zawsze:
{starus:0/1 (0 dla niepowodzenia, 1 jesli wszystko przebiegło ok),message: 'informacja dla użytkownika'}
Bez względu na funkcję, której chcemy użyć każde zapytanie musi zawierać parametr w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
apikey | string | znajdziesz go po zalogowaniu w lewym menu zakładka API -> 70x |
string | Twój adres email. Znajdziesz go w Panelu Zarzadzania Usługą w lewym MENU zakładka Twoje Dane. |
W API 70x nie wysyłamy żadnych danych do klientów jako pierwsi. Oczekujemy na dane od Partnera. Po otrzymaniu danych od partnera w czasie rzeczywistym zwrócimy odpowiedź.
Funkcja showNumbers pokazuje wszystkie numery Premium dostępne/zakupione na koncie Partnera, wraz z numerami podanymi jako numer do przekierowania dla Usługi.
Poniżej znajdziesz listę wymaganych parametrów do obsługi showNumbers w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/prm/voice/showNumbers
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/prm/voice/showNumbers,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:
200 zapytanie zostało poprawnie wykonane. Szczegółów szukaj w services.
401 email, lub apikey jest nieprawidłowy.
Jeśli inny kod błędu wróć do początku dokumentacji.
{
"status": 1,
"services": [
{
"premium": "708600001",
"netto": "3.46",
"tax": "23",
"tariff": "6",
"redirect": {
"appdata": "number=123456789"
}
},
{
"premium": "7087000001",
"netto": "4.00",
"tax": "23",
"tariff": "7",
"redirect": {
"appdata": "number=601123456"
}
}
]
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W services dostępne są szczegoły Twoich usług takie jak:
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 200 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
Funkcja setRedirect umożliwa zmianę numeru do przekierowania dla danej usługi.
Poniżej znajdziesz listę wymaganych parametrów do obsługi setRedirect w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/prm/voice/setRedirect/{number}
Metoda: PUT
$client = new \GuzzleHttp\Client();
$client->request('PUT','https://numery-premium.pl/api/prm/voice/setRedirect/708123456,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
'redirect_to_number' => 'nowy numer do przekierowania dla usługi. (Bez +48 czy 00, w formacie 601123456)',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
{number} | string | Numer Premium bez +48 bez 00 bez spacji np. 7081234567 |
string | Adres email Partnera | |
apikey | string | Apikey |
redirect_to_number | string | Numer do przekierowania rozmów bez +48, bez 00, sam numer w formaci 601123456 Informujemy, że bez kontaktu z Biurem Obsługi Klienta nie ma mozliwości ustawienia numeru spoza Polski, jako numeru do pzrekierowania rozmów. |
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
prezentacja | string | 'prezentacjaA', lub 'prezentacja' 'prezentacjaA' to prezentacja numerem zastrzeżonym lub +48228966667 (domyślna opcja), lub 'prezentacja' to prezentacja numerem klienta, jeśli Twoje usługi to umożliwiają. |
zapowiedz | int | 0, lub 1 0 bez zapowiedzi, 1 z zapowiedzią. Domyślnie 0. Jeśli 1 pamiętaj, aby wgrać wcześniej stosowną zapowiedź w Panelu Zarządzania Usługą, inaczej zwrócimy kod 422. |
Oczekiwany kod odpowiedzi:202 zapytanie zostało wykonane. Szczegółów szukaj w message.
{
"status": 1,
"message": "Zmiany w przekierowaniach zapisane poprawnie!"
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W message dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 202 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
404 Nie znaleziono wskazanego numeru na twoim koncie.
405 Zła metoda.
422 Brak wgranej zapowiedzi, lub szczegółów szukaj w message.
Jeśli inny kod błedu wróc do początku dokumentacji sprawdzając uprzednio czy nie masz oczywistego błędu w swoim kodzie.
Funkcja addNumber umożliwa dodanie numeru Premium w wybranej taryfie, pod warunkiem wcześniejszego doładowania konta na platformie.
Poniżej znajdziesz listę wymaganych parametrów do obsługi addNumber w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/prm/voice/addNumber/{tariff}
Metoda: POST
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/prm/voice/addNumber/5,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
{tariff} | int | Taryfa numeru Premium. Min 4 max 8. |
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:201 Numeru i stanu konta szukaj w message.
{
"status": 1,
"message": {
"number": "708412345",
"tariff": 4,
"WalletBalance": 0
}
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W message dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 201 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
lub
{
"status": 0,
"message": "Brak wystarczających środków na koncie do zakupu usługii. Doładuj konto."
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
422 Szczegoły znajdziesz w messages.
405 Zła metoda.
Funkcja delete usunie numer Premium z Twojego konta.
Poniżej znajdziesz listę wymaganych parametrów do obsługi delete w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/prm/voice/delete/{number}
Metoda: DELETE
$client = new \GuzzleHttp\Client();
$client->request('DELETE','https://numery-premium.pl/api/prm/voice/delete/708123456,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
{number} | string | Numer Premium bez +48 bez 00 bez spacji np. 7081234567 |
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:
204 zapytanie zostało poprawnie wykonane.
401 email, lub apikey jest nieprawidłowy.
404 Sprawdź czy podany {number} na pewno należy do Ciebie.
Jeśli inny kod błędu wróć do początku dokumentacji.
{
"status": 0,
"message": "Unauthorized"
}
Funkcja billing umożliwa pobranie aktualnego billingu dla wszystkich numerów usługowych, bądź jednego konkretnego numeru. Domyślnie odpowiadamy z zakresu "Aktualny Miesiąc". Podając dodatkowe parametry można wybrać każdy miesiąc i rok.
Poniżej znajdziesz listę wymaganych parametrów do obsługi billing w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/prm/voice/billing/{number}
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/prm/voice/billing/{number},[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
{number} | string | Numer Premium bez +48 bez 00 bez spacji np. 7081234567 |
month | int | Dla stycznia '01', dla Grudnia '12' |
year | int | np. 2021 |
Oczekiwany kod odpowiedzi:200 zapytanie zostało wykonane. Szczegółów szukaj w services.
{
"status": 1,
"services": [
{
"id": 12328, //id w naszym systemie.
"src": "123456789", //numer klienta.
"dst": "708708708", //Usługa.
"start": "2021-06-25 21:47:47", //Godzina, w której połączenie zacząło dzwonić pod 'toDst' (czyli numer do przekierowania usługi).
"answer": "2021-06-25 21:48:02", //Godzina, w której odebrano połączenie.
"end": "2021-06-25 22:07:14", //Godzina zakończenia połączenia.
"duration": 1166, //całkowity czas połączenia.
"billsec": 1152, // czas rozmowy.
"disposition": "ANSWERED",
"billcost": 1.92, //koszt przekierowania odjęty od zarobku.
"toDst": "601123456" //numer podany jako numer do przekierowania w chwili wdzwniania, czyli ten pod który przekazaliśmy połączenie.
},
{
"id": 12330,
"src": "123456789",
"dst": "708600700",
"start": "2021-06-25 22:46:00",
"answer": "2021-06-25 22:46:22",
"end": "2021-06-25 22:59:23",
"duration": 802,
"billsec": 780,
"disposition": "ANSWERED",
"billcost": 1.3,
"toDst": "601123456"
},
]
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W services dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 200 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
lub
{
"status": 0,
"message": "Not found number in your account"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
404 Nie znaleziono wskazanego numeru na twoim koncie.
405 Zła metoda.
Jeśli inny kod błedu wróc do początku dokumentacji sprawdzając uprzednio czy nie masz oczywistego błędu w swoim kodzie.
Funkcja balance pokazuje aktualny stan konta klienta.
Poniżej znajdziesz listę wymaganych parametrów do obsługi billing w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/account/balance
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/account/balance,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:200 zapytanie zostało wykonane. Szczegółów szukaj w message.
{
"status": 1,
"message": {
"netto": 20,
"tax": 23,
"brutto": 24.6
}
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W message dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 200 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
405 Zła metoda.
Jeśli inny kod błedu wróc do początku dokumentacji sprawdzając uprzednio czy nie masz oczywistego błędu w swoim kodzie.
Funkcja historyWallet przekazuje historie portfela/zakupów/doładowań konta klienta. Wyświetlanych jest ostatnich 50 rekordów.
Poniżej znajdziesz listę wymaganych parametrów do obsługi billing w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/account/balance/history
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/account/balance/history,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:200 zapytanie zostało wykonane. Szczegółów szukaj w message.
{
"status": 1,
"message": [
{
"cost": 2000,
"balance": 0,
"description": "Aktywacja usługi nagrywanie rozmów",
"type": 0,
"created_at": "2021-06-05T12:41:40.000000Z"
},
{
"cost": 2000, //kwota usługi
"balance": 2000, //saldo po operacji
"description": "Doładowanie konta", //opis operacji
"type": 1, //1=>uznanie, 0=> obciążenie
"created_at": "2021-06-01T12:34:37.000000Z"
}
]
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W message dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 200 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
405 Zła metoda.
Jeśli inny kod błedu wróc do początku dokumentacji sprawdzając uprzednio czy nie masz oczywistego błędu w swoim kodzie.
Funkcja invoices przekazuje ostatnich 30 ostatnich faktur. Aby pobrać fakturę skorzystaj z funkcji invoiceDownload, podając {id} danej faktury.
Poniżej znajdziesz listę wymaganych parametrów do obsługi billing w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/account/invoices
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/account/invoices,[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
Oczekiwany kod odpowiedzi:200 zapytanie zostało wykonane. Szczegółów szukaj w message.
{
"status": 1,
"message": [
{
"id": 309, //niezbędne do pobrania faktury
"title": "3/01/2021", //numer faktury
"netto": "89",
"status": 1, //opłacona
"created_at": "2021-01-01T23:44:12.000000Z"
},
{
"id": 308,
"title": "2/01/2021",
"netto": "89",
"status": 1,
"created_at": "2020-12-31T23:44:12.000000Z"
}
]
}
Gdzie: status => 1 oznacza, że zapytanie zostało prawidłowo przetworzone. W message dostępne są dodatkowe informacje.
Jeśli status inny niż 1 szukaj informacji w message. Zazwyczaj w tym miejscu, jesli kod inny niż 200 wystąpił problem z logowaniem do usługi. Sprawdź czy parametr email, oraz apikey jest prawidłowy, lub czy używasz wspieranej metody.
{
"status": 0,
"message": "Unauthorized"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
405 Zła metoda.
Jeśli inny kod błedu wróc do początku dokumentacji sprawdzając uprzednio czy nie masz oczywistego błędu w swoim kodzie.
Funkcja invoiceDownload umożliwia pobranie wybranej faktury. Aby pobrać fakturę musisz najpierw skorzystać z opcji invoices, skąd otrzymasz {id}, które jest niezbędne do pobrania faktury.
Poniżej znajdziesz listę wymaganych parametrów do obsługi billing w formacie:
Wymagany Parametr – Typ Danych – Wyjaśnienie.
Adres: https://numery-premium.pl/api/account/invoice/{id}
Metoda: GET
$client = new \GuzzleHttp\Client();
$client->request('GET','https://numery-premium.pl/api/account/invoice/{id},[
'form_params' => [
'email' => 'email przypisany do konta w Numery-Premium.PL',
'apikey' => 'apikey otrzymany od Numery-Premium.PL',
]);
Parametr | Typ Danych | Wyjaśnienie |
---|---|---|
string | Adres email Partnera | |
apikey | string | Apikey |
{id} | string | id faktury, którą chcesz pobrać |
Oczekiwany kod odpowiedzi:200 zapytanie zostało wykonane. Zwrócimy odpowiedni plik.
{
"status": 0,
"message": "Unauthorized"
}
Błedne kody odpowiedzi:
401 email, lub apikey jest nieprawidłowy.
403 brak dostępu do wybranego zasobu.
405 Zła metoda.