Dokumentacja PLICBD API

Sprawdź dokumentację API dla poszczególnych usług, klikając w nazwę usługi.

Niezależnie od wszystkich poniższych metod do każdej metody należy dodać nagłówek Authorization i w jego treści podać Bearer {wygenerowany w panelu operatora Klucz Api}

Generowanie klucza API

W celu wygenerowania klucza API, który będzie autoryzował Twoje zapytania, należy kolejno:

  1. Zalogować się do panelu operatora.
  2. Z lewego menu wybrać Konto następnie Klucze API.
  3. Wprowadzić nazwę dla tokena API i kliknąć przycisk Utwórz klucz.

Elementy wspólne i informacje dt API

Do każdego zapytania dodaj w headers: Accept: application/json, oraz Authorization jak wyżej opisano.
Każdy parametr musi być pisany z małej litery.

Uniwersalne błędy/kody odpowiedzi:

  • 200 Wszystko przebiegło prawidłowo. Sprawdź przykładowe odpowiedzi.
  • 201 Wszystko przebiegło prawidłowo. Element został utworzony.
  • 401 Nieautoryzowany dostęp. Wygeneruj Api Token (klucz do API) wyżej opisane, jak naprawić.
  • 402 Payment required - Próba uzyskania dostępu do funkcji, która nie jest wliczona w Twój obecny plan.
  • 403 Próbujesz wyświetlić dany zasób bez uprawnień - prosisz o nie swoje dane, lub takie, do których nie powinieneś mieć dostępu. Użyj innych (swoich) danych w zapytaniu.
  • 405 Wybrana metoda GET/POST/PUT/DELETE jest nie możliwa do zastosowania w tej funkcji. Wykonaj zapytanie zgodnie z niniejszą dokumentacją.
  • 422 Walidacja wprowadzonych danych zakończona niepomyślnie. W messages znajdziesz szczegóły.
  • 500 Błędne zapytanie. Zapoznaj się z dokumentacją. Niepoprawnie sformułowane zapytanie, błąd leży po Twojej stronie.

Przykładowy błąd 422:

								
{
	"message": "Pole eme_call jest obowiązkowe, jest to Numer Kierowania Alarmowego (NKA) na który zostało wykonane połączenie (and 1 more error)",
	"errors": {
		"eme_call": [
			Pole eme_call musi składać się z numeru kierunkowego WSN, wyróżnika HEX, IDLAUS Al., oraz NR AUS Al. np. 22C701112"
		],
		"customer_name": [
			"Pole customer_name jest obowiązkowe, musi zawierać dane Abonenta dzwoniącego pod numer alarmowy"
		]
	}
}
								
							

W powyższym wypadku należy w polu eme_call podać prawidłowy numer NKA, zgodnie z przykładem i wytycznymi Urzędu Komunikacji Elektronicznej. W przypadku customer_name należy uzupełnić to pole, ponieważ w tym wypadku w ogóle go nie dostarczono.

W przypadku korzystania z komunikatów Exx tj. PLICBD2 - przenośności numerów przez API należy przestrzegać norm narzuconych przez UKE tzn. Nie można wysłac komunikatu E13, bez E03 (i pełnej drogi), ani E12 bez E06, czy E12 po E18. Takie elementy są walidowane przez UKE. Pełna droga wysyłki komunikatów jest obowiązkowa. Szczegóły znajdziesz w dokumentacjach PLI CBD od UKE. Z błędami reason zapoznasz się w instrukacjach.

Adres: https://plicbd.arkanavoip.pl/api/finance/invoices
Metoda: GET

Funkcja zwraca listę faktur, numer faktury, kwotę faktury netto oraz informację czy dokument jest opłacony.

Parametry do obsługi funkcji invoices

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja)

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
[{
	"id":1,				// przyda się do pobrania faktury
	"title":"1/01/2020",		// numery faktury
	"netto":"10000",		// kwota netto wyrażona w groszach
	"payed":1,			// czy opłacono ? Tak => 1 , Nie => 0
	"created_at":"2020-05-07T23:23:10.000000Z",
	"updated_at":"2020-05-07T23:23:10.000000Z"
}]
										
									

Adres: https://plicbd.arkanavoip.pl/api/finance/invoices/{id}
Metoda: GET

Pobieranie wybranej faktury do PDF.

Parametry do obsługi funkcji invoicesDownload

{id} uzyskane z metody invoices

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz application/pdf do pobrania.

Adres: https://plicbd.arkanavoip.pl/api/user
Metoda: GET

Parametry do obsługi funkcji User

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja)

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
{
	"firstname":"Jan",
	"lastname":"Kowalski",
	"street":"ul. Testowa 125\/88",
	"postcode":"00-001",
	"city":"Warszawa",
	"company":"Firma ABC",
	"rpt":"00001",
	"created_at":"2020-04-03T01:11:19.000000Z",
	"updated_at":"2020-10-08T02:52:38.000000Z"
}
										
									

Adres: https://plicbd.arkanavoip.pl/api/user/update
Metoda: POST

Funkcja pozwala edytować niektóre dane uzytkownika.

Parametry do obsługi funkcji UserEdit
Parametry do obsługi funkcji UserEdit
Parametr Typ Danych Wyjaśnienie
postcode required|regex:/^\d{2}-\d{3}$/ kod pocztowy w formacie xx-xxx (gdzie x to cyfra od 0 do 9)
street required|string ulica i numer
city required|string Miejscowość
auto_e13_afert_e12 sometimes|bool Automatyczne wysyłanie E13 po otrzymaniu E12 dla NP. Po otrzymaniu E12 masz 2 godziny na wysłanie E13. Jeśli chcesz możemy automatycznie wysłac komunikat E13, gdy tylko otrzymamy E12. Oznacz true|1 jeśli chcesz, aby wysyłka E13 odbywała się z automatu. W przeciwnym wypadku 0|false.
Oczekiwane kody odpowiedzi

200W zwrocie otrzymasz bool np. 1|0 (true|false), co oznacza, że wyżej wymienione dane zostały zaaktualizowane (dla 1), lub nie (dla 0).

Adres: https://plicbd.arkanavoip.pl/api/plans
Metoda: GET

Funkcja zwraca listę wszystkich możliwych do zakupu i/lub przedłużenia planów.

Parametry do obsługi funkcji getPlans

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja), a podany niżej przykład nie musi stanowić obecnej oferty.

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
[
	{
		"id": 1,
		"name": "PLICBD1_push",
		"netto_gross": "14999",
		"desc": "Wysyłka danych lokalizacyjnych E112..."
	},
	{
		"id": 2,
		"name": "PLICBD1_ftps",
		"netto_gross": "29999",
		"desc": "Metoda wsadowa FTPS..."
	},
	{
		"id": 3,
		"name": "PLICBD2",
		"netto_gross": "29999",
		"desc": "Przenoszenie numerów fix + mobile..."
	},
	{
		"id": 4,
		"name": "PLICBD1_2",
		"netto_gross": "39999",
		"desc": "Lokalizacja + przenoszenie numerów..."
	},
	{
		"id": 5,
		"name": "PLICBD_full",
		"netto_gross": "49999",
		"desc": "Pełen dostęp do PLICBD i obsługa SOU..."
	},
	{
		"id": 6,
		"name": "API_start",
		"netto_gross": "4999",
		"desc": "Dostęp do API dla przedsiębior..."
	},
	{
		"id": 7,
		"name": "API_popular",
		"netto_gross": "9999",
		"desc": "Oferta doty..."
	},
	{
		"id": 8,
		"name": "PLICBD_shared",
		"netto_gross": "4999",
		"desc": "Panel udos..."
	},
	{
		"id": 9,
		"name": "shared_fix",
		"netto_gross": "2600",
		"desc": "Udostępnienie 100 szt. numeracji stacj..."
	}
]
										
									
desc to tekst w htmlu z jego znacznikami np. <p>.

Adres: https://plicbd.arkanavoip.pl/api/user/plans
Metoda: GET

Funkcja zwróci aktywne plany użytkownika na jego koncie.

Parametry do obsługi funkcji userPlans

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja)

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
[
	{
		"payed_to": "2093-05-31 14:09:02",
		"plan": {
			"id": 4,
			"name": "PLICBD1_2",
			"netto_gross": "39999"
		}
	},
	{
		"payed_to": "2099-07-06 18:47:59",
		"plan": {
			"id": 6,
			"name": "API_start",
			"netto_gross": "4999"
		}
	}
]
										
									

Adres: https://plicbd.arkanavoip.pl/api/user/plan/odnowienie
Metoda: PUT

Metoda pozwala na zakupienie lub przedłużenie wybranego planu. Id planu pobierzesz z funcki getPlans lub userPlans.

Parametry do obsługi funkcji renewalPlan
Parametry do obsługi funkcji renewalPlan
Parametr Typ Danych Wyjaśnienie
planId required|numeric id planu do odnowienia (z metody userPlans, lub getPlans)
quantity required|numeric|min:1|max:12 Ilość miesięcy do zakupienia/przedłużenia wybranej usługi
desc sometimes|required_if|string|min:2|max:2 Wymagane w przypadku, gdy wybrany plan to udostępnienie numeracji stacjonarnej i tylko w przypadku, gdy jest to pierwszy zakup (a nie odnowienie).
Oczekiwane kody odpowiedzi

302 W zwrocie nastąpi przekierowanie do bramki płatności

Adres: https://plicbd.arkanavoip.pl/api/user/cert
Metoda: GET

Parametry do obsługi funkcji getUserCert

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja). Wskazuje datę wygaśnięcia Twoich certyfikatów (jeśli zostały wgrane). Będziesz otrzymywał od nas przypomnienia email i SMS o kończącym się certyfikacie. W instrukcjach znajdziesz informację jak je odnowić.

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
{
    "message": [
        {
            "expiry": "2027-03-12 16:03:59",
            "type": "OPR"
        },
        {
            "expiry": "2028-03-21 11:19:21",
            "type": "SRO"
        },
        {
            "expiry": "2028-04-12 13:13:56",
            "type": "SOU"
        }
    ]
}
										
									

Adres: https://plicbd.arkanavoip.pl/api/user/cert/store/{type}
Metoda: PUT
Content-Type: multipart/form-data

Funkcja pozwalająca na upload pliku pfx z certyfikatem otrzymanym od UKE w celu jego automatycznej instalacji w naszym PLICBD.

Parametry do obsługi funkcji UserCertStore
Parametry do obsługi funkcji UserCertStore
Parametr Typ Danych Wyjaśnienie
{type} required|string|in:OPR,SRO,SOO Typ certyfikatu jaki chcemy przesłać - parametr url
pfx_file required|file|max:1024 Plik z certyfikatem w formacie pfx otrzymany od UKE - dla certyfikatu OPR i SOO
pass required|string Hasło do certyfikatu otrzymane od UKE - tylko dla certyfikatu OPR i SOO
crt_file required|file|max:1024 Certyfikat FTP (rozszerzenie .crt) - dla certyfikatu SRO
key_file required|file|max:1024 Klucz do certyfiaktu dla FTP (rozszerzenie .key) - dla certyfikatu SRO
Oczekiwane kody odpowiedzi

201

Adres: https://plicbd.arkanavoip.pl/api/e112/ips
Metoda: GET

Funkcja pobiera zgłoszone adresy IP użytkownika, wraz z danymi Abonentów korzystających z E112 push.

Parametry do obsługi funkcji getIpE112
Parametry do obsługi funkcji getIpE112
Parametr Typ Danych Wyjaśnienie
ip required|ip_address Prawidłowy adres IP4 lub IPv6
Oczekiwane kody odpowiedzi

200W zwrocie otrzymasz jsona z danymi np.

										
[{
	"ip": "22.33.44.55",
	"confirm": 1,
	"created_at": "2020-04-12T02:17:29.000000Z",
	"deleted_at": null,
	"emergency_api_ip_data": []
},{
	"ip": "33.44.55.66",
	"confirm": 1,
	"created_at": "2020-04-12T02:17:36.000000Z",
	"deleted_at": null,
	"emergency_api_ip_data": [{
		"data": "Adam|Kowalski|ul. Jasna 72/40, 00-112 Warszawa|adam.kowalski@o2.pl|1:68112002345",
		"xml_1_status": 200,
		"xml_2_status": 200,
		"created_at": "2020-04-12 18:49:54"
	}]
},{
	"ip": "44.55.66.77",
	"confirm": 1,
	"created_at": "2020-04-14T11:07:36.000000Z",
	"deleted_at": null,
	"emergency_api_ip_data": [{
		"data": "Adam|Kowalski|ul. Jasna 72 lok 40, 00-112 Warszawa|adam.kowalski@o2.pl|1:68112002345",
		"xml_1_status": "200",
		"xml_2_status": "200",
		"created_at": "2020-04-14 13:14:39"
	},{
		"data": "Adam|Nowak|ul. Jasna 72 lok 40, 00-112 Warszawa|adam.kowalski@o2.pl|1:68112002345",
		"xml_1_status": "200",
		"xml_2_status": "200",
		"created_at": "2020-04-14 13:31:03"
	}]
}]
										
									

Adres: https://plicbd.arkanavoip.pl/api/e112/ip
Metoda: PUT

Funkcja pozwala na zapis dodatkowego adresu IP, z którego autoryzowane będą Państwa komunikaty E112 push.

Parametry do obsługi funkcji addIpAddressToE112
Parametry do obsługi funkcji addIpAddressToE112
Parametr Typ Danych Wyjaśnienie
ip required|ip Prawidłowy adres IPv4, lub IPv6
Oczekiwane kody odpowiedzi

201 W zwrocie otrzymasz jsona z danymi np.

										
{
    "ip": "10.10.10.10",
    "confirm": false	// jeśli wysłano z adresu ip, który wprowadzasz confirm będzie true, jeśli z innego należy potwierdzić IP, zgodnie z dokumentacją.
}
										
									

Adres: https://plicbd.arkanavoip.pl/api/xnn/{confirm?}
Metoda: GET

Funkcja pobiera potwierdzone (lub nie) udostępnienia numeracji w ramach komunikatów XNN.

Parametry do obsługi funkcji getXnn
Parametry do obsługi funkcji addIpAddressToE112
Parametr Typ Danych Wyjaśnienie
confirm nullable|bool 1 => potwierdzone, 0 => oczekujące na potwierdzenie. Parametr w URL.
page nullable|int numer strony (paginacja po 25 sztuk) - parametr GET URL (?page=1)

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja)

Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "effective_date": "2022-03-15",
            "providing_operator": "00001",
            "using_operator": "00001",
            "services_operator": "00001",
            "network_operator": "00001",
            "allocation_type": "U",						// 'U' => udostępnienie, 'I' => Implementacja
            "reference_id": "000010000000000032",
            "description": "OK",
            "confirm": 1,
            "services_operator": "00001",
            "network_operator": "00001",
            "numbers": [
                {
                    "dirnum": "507504000",
                    "dirnum_end": "507504999",
                    "operation_type": "INS"					// 'INS' => dodanie, 'DEL' => Usunięcie
                }
            ]
        }
    ],
    "first_page_url": "https://plicbd.arkanavoip.pl/api/xnn/1?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://plicbd.arkanavoip.pl/api/xnn/1?page=1",
    "links": [
        {
            "url": null,
            "label": "« Poprzednia",
            "active": false
        },
        {
            "url": "https://plicbd.arkanavoip.pl/api/xnn/1?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Następna »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://plicbd.arkanavoip.pl/api/xnn/1",
    "per_page": 25,
    "prev_page_url": null,
    "to": 1,
    "total": 1
}
										
									

Adres: https://plicbd.arkanavoip.pl/api/xnn/create
Metoda: POST

Wysyłka wniosku X01 (wniosek udostępniający numerację innemu operatorowi).

Parametry do obsługi funkcji x01
Parametry do obsługi funkcji x01
Parametr Typ Danych Wyjaśnienie
number_from required|array Początek zakresu numerów (dla FIX ostatnie cyfry 00, dla MOB 000)
number_to required|array Koniec zakresu numerów (dla FIX ostatnie cyfry 00, dla MOB 000)
operation_type required|array INS => dodanie udostępnienia, DEL => usunięcie istniejącego udostępnienia
number_type required|digits:1 1 => FIX, 2 => NDID, 3 => VoIP, 7 => MOB (mobile)
allocation_type required|string:1 I => implementacja, U => świadczenie usług detalicznych
effective_date required|date Data udostępnienia "od" np. 2020-07-01 (nie może być to weekend, ani dzień ustawowo wolny od pracy)
providing_operator required|digits:5 numer RPT
using_operator required|digits:5 numer RPT
services_operator required|digits:5 numer RPT
network_operator required|digits:5 numer RPT
Oczekiwane kody odpowiedzi

202 W zwrocie otrzymasz jsona z danymi np.

										
{
    "message": "Wysłano wniosek. Oczekujemy na zwrotkę z PLICBD, celem potwierdzenia wysłania wniosku do operatora."
}
										
									

Notyfikacje na adres URL podany przez Partnera

Jeśli Partner poda adres URL dla notyfikacji Xnn w Zakładce Konto -> Klucze API, przy każdym przyjściu komunikatu X01 wyślemy metodą POST następujące dane:

									
'id'			// id komunikatu (unikalne)
'type'			// nazwa komunikatu, w tym wypadku: X01
'effective_date' 	// data, od kiedy udostępnienie będzie miało miejsce
'providing_operator'	// operator udostępniający numerację (RPT)
'using_operator'	// operator, który będzie wykorzystywał numerację (RPT)
'services_operator'	// operator usług
'network_operator'	// operator sieci (RPT)
'number_type'		// 1 => FIX, 2 => NDID, 3 => VoIP, 7 => MOB (mobile)
'allocation_type'	// 'U' => udostępnienie, 'I' => Implementacja
'reference_id' 		// unikalny numer sprawy nadany przez wysyłającego komunikat w procesie składania wniosku udostępnienia
'numbers'		// tablica z numerami (number_from, number_to, operation_type)
'services_operator'	// operator usług towarzyszących
'network_operator'	// operator sieci
									
								

Powyższe dane będą wysyłane w form-data. Nie oczekujemy żadnej odpowiedzi. W przypadku błędu odbioru po Państwa stronie - komunikaty nie będą wysyłane ponownie. Całość komunikatów można pobrać korzystając z metody getXnn.

Adres: https://plicbd.arkanavoip.pl/api/xnn/update/{sharedNumber}
Metoda: PUT

Odpowiedź na otrzymany wniosek X01. Sprawdź również kody reason dla Xnn, niezbędne przy wysyłce odmowy.

Parametry do obsługi funkcji x02
Parametry do obsługi funkcji x02
Parametr Typ Danych Wyjaśnienie
sharedNumber required|int Id rekordu z metody getXnn, który zamierzamy aktualizować. Parametr w URL.
confirm required|bool 1 => Potwierdzenie, 0 => Odrzucenie udostępnienia.
reason required_if:confirm,0|digits:3 Odpowiedni kod odrzucenia. Kody znajdziesz tutaj: Kody reason dla Xnn.
description required_if:confirm,0|string|min:1|max:250 Opis dla operatora dawcy, dlaczego odrzucasz wniosek.
Oczekiwane kody odpowiedzi

202 W zwrocie otrzymasz jsona z danymi np.

										
{
    "message": "Udostępniona numeracja zostanie potwierdzona, lub usunięta. Zgodnie z żądaniem."
}
										
									

Może wystąpić także kod odpowiedzi:
200 Oznaczający próbę wysyłki komunikatu, który został już wysłany.

										
{
    "message": "Jest X01, wysłałeś również X02. Nic więcej nie możesz już zrobić."
}
										
									

Notyfikacje na adres URL podany przez Partnera

Jeśli Partner poda adres URL dla notyfikacji Xnn w Zakładce Konto -> Klucze API, przy każdym przyjściu komunikatu X02 wyślemy metodą POST następujące dane:

									
'id'			// id komunikatu (unikalne)
'type'			// nazwa komunikatu, w tym wypadku: X02
'desc' 			// opis, który przyszedł od PLICBD UKE
'reason' 		// kod stanu jaki przyszedł od PLICBD UKE
'reference_id' 		// unikalny numer sprawy nadany przez ciebie w procesie składania wniosku udostępnienia
									
								

Powyższe dane będą wysyłane w form-data. Nie oczekujemy żadnej odpowiedzi. W przypadku błędu odbioru po Państwa stronie - komunikaty nie będą wysyłane ponownie. Całość komunikatów można pobrać korzystając z metody getXnn.

Adres: https://plicbd.arkanavoip.pl/api/exx
Metoda: GET

Funkcja pobiera komunikaty w procesie przenoszenia numerów od E03 do E13. (Zwroty i zmiany będą w oddzielnych metodach). Na jednej stronie znajduje się 25 rekordów. Wynik pokaże linki do kolejnych stron.

Parametry do obsługi funkcji getExx
Parametry do obsługi funkcji getExx
Parametr Typ Danych Wyjaśnienie
status somettimes|nullable|in:0,1,2 Oznaczenie jakie pobrać komunikaty - o statusie zamkniętym (1), otwartym (0), archiwum (2). Domyślnie 0.
type somettimes|nullable|string Możliwe wartości: 'in' lub 'out'. Wybiera odpowiednie komunikaty (przychodzące, lub wychodzące).
Oczekiwane kody odpowiedzi

200W zwrocie otrzymasz jsona z danymi np.

										
{
    "current_page": 1,
    "data": [
        {
            "id": 10,							//unikalne id naszego systemu - niezbędne do kolejnych komunikatów
            "event_id": "000010000000009040",
            "case_id": "000010000000007662",
            "recipient": "00001",					//Biorca (przejmujący numer)
            "donor": "00001",						//Dawca usługi głosowej
            "services_operator": "00001",
            "network_operator": "00001",
            "case_document_1_id": "00001",				//Numer wniosku o Przeniesienie Numeru
            "case_pending_activation_date": "2020-06-19 00:00:00",	//Wnioskowana data rozpoczęcia świadczenia usług przez Biorcę
            "case_termination_date": null,				//ustalona data przeniesienia
            "porting_mode": "DAY",					//Tryb wypowiedzenia umowy z Dawcą DAY|END|EOP 
            "routing_number": "C2492",
            "process_type": "1",					//Rodzaj procesu 1 => postpaid, 2 => prepaid
            "porting_type": "1",					//Rodzaj numeracji 1 => pojedyńczy numer, 2 => zakres numerów, 3 => usługa WLR
            "attorney": 1,						//Pełnomocnictwo 1|0
            "name": "ghghgfhgfdhdf hdghghfghdf",			//Imię Nazwisko (lub nazwa firmy) Abonenta
            "identifier_type": "NIP",					//Rodzaj dokumentu NIP|REG|PES|DOC
            "identifier_value": "0000000000",				//Identyfikacja dokumentu (numer)
            "operation": "INSERT",					//Typ operacji INSERT|INTERVENTION|MIGRATION|TRANSFORMATION
            "confirm": 0,						//Czy wniosek potwierdzony przez OD
            "closed": 0,						//czy sprawa zamknięta
            "reason": null,						//Kod błędu
            "desc": "null",						//opis sukcesu (OK), lub błędu
            "archive" 0,						//bool Czy sprawa jest w archiwum
            "created_at": "2020-06-15T16:57:01.000000Z",
            "updated_at": "2020-06-15T16:57:42.000000Z",
            "numbers": [						//lista numerów
                {
                    "dirnum": "222222222",
                    "dirnum_end": "222222222"
                }
            ]
        }
    ],
    "first_page_url": "https://plicbd.arkanavoip.pl/api/exx?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://plicbd.arkanavoip.pl/api/exx?page=1",
    "links": [
        {
            "url": null,
            "label": "« Poprzednia",
            "active": false
        },
        {
            "url": "https://plicbd.arkanavoip.pl/api/exx?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Następna »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://plicbd.arkanavoip.pl/api/exx",
    "per_page": 25,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}
										
									

Notyfikacje na adres URL podany przez Partnera

Jeśli Partner poda adres URL dla notyfikacji Exx w Zakładce Konto -> Klucze API, przy każdym przyjściu jakiegokolwiek komunikatu Exx wyślemy metodą POST następujące dane:

									
'id'
'type'			// typ komunikatu np. E03, E06, E12, E16, E17, E18
'case_id' 		// numer sprawy
'recipient'
'donor'
'services_operator'
'network_operator'
'case_document_1_id'
'case_pending_activation_date'
'case_termination_date'
'porting_mode'
'routing_number'
'process_type'
'porting_type'
'attorney'
'name'
'identifier_type'
'identifier_value'
'operation'
'np_type'
'confirm'
'closed'
'reason'
'desc'
'created_at'
'updated_at'
'numbers'		// tablica z numerami (number_from, number_to)
//wyjaśnienia tych pól są tożsame z wyjaśnieniami w getExx
									
								

Powyższe dane będą wysyłane w form-data. Nie oczekujemy żadnej odpowiedzi. W przypadku błędu odbioru po Państwa stronie - komunikaty nie będą wysyłane ponownie. Całość komunikatów można pobrać korzystając z metody getExx.

Adres: https://plicbd.arkanavoip.pl/api/exx/create
Metoda: POST

Funkcja tworzy nowy komunikat E03 - wniosek o przeniesienie numeru. Jeśli masz aktywną opcję "Chcę pobierać dokumenty przed faktyczną wysyłką E03" to komunikat NIE zostanie wysłany - do jego wysłania użyj poniższych metod. Jeśli nie masz aktywnej wspomnianej opcji komunikat od razu zostanie wysłany do Operatora Dawcy.

Parametry do obsługi funkcji e03create
Parametry do obsługi funkcji e03create
Parametr Typ Danych Wyjaśnienie
name required|string|min:7|max:255 Imię i nazwisko Abonenta (lub nazwa firmy).
city sometimes|nullable|string|min:1|max:32 Miasto abonenta. Jeśli korzystasz z PLICBD1 w formie FTPS powinieneś podać. City musi być zgodne z TERYT (my tego nie weryfikujemy - Ty za to odpowiadasz. My w plikach INCR oraz FULL podamy dokładnie to co Ty nam podałeś).
post_code sometimes|nullable|string|regex:/^\d{2}-\d{3}$/ Kod pocztowy abonenta. Jeśli korzystasz z PLICBD1 w formie FTPS powinieneś podać.
street sometimes|nullable|string|min:6|max:255 Ulica i numer abonenta. Jeśli korzystasz z PLICBD1 w formie FTPS powinieneś podać. Dane powinny być zgodne z TERYT.
identifier_type required|PES|NIP|DOC Identyfikator rodzaju danych identyfikacyjnych PESEL|NIP|DOKUMENT OBCOKRAJOWCA.
identifier_value required|string Jeśli PES dokładnie 11 znaków. Jeśli NIP|REG dokładnie 9 znaków. Jeśli DOC max 11 znaków.
np_type required|int|1|2 Komunikat dotyczy numeracji 1=> stacjonarnej, 2 => mobilnej.
ruting_number required|size:5|regex:/^C\d{4}$/ Numer rutingowy, pod który należy kierować połączenia po prawidłowym przeniesieniu.
donor required|min:1|max:5/ Dawca usługi głosowej. Identyfikator Dawcy – wydającego numer. Jeśli RPT nie ma 5 znaków poprzedź go zerami.
services_operator required|min:1|max:5/ Identyfikator Operatora Usług Towarzyszących po Przeniesieniu Numeru. Jeśli RPT nie ma 5 znaków poprzedź go zerami.
network_operator required|min:1|max:5/ Identyfikator Operatora Sieci po Przeniesieniu Numeru. Jeśli RPT nie ma 5 znaków poprzedź go zerami.
process_type required|int|1|2 1 => postpaid; 2 => prepaid.
porting_type required|int|in:1,2 Oznaczenie czy zmiana dotyczy 1 numeru (dla mobile, tylko ta opcja możliwa), czy zakres numerów (dla fix) 2.
dirnum required|array Początek zakresu dla jednego numeru: np. 22 123 45 67 i koniec zakresu dla tego samego numeru: 22 123 45 67. Zakres numerów może obejmować minimalnie 10 numerów począwszy od 0 skończywszy na 9 na ostatniej cyfrze, tzn od AB SPQ MC D0 do AB SPQ MC D9.
dirnum_end required|array Jak wyżej. Musi zakończyć się cyfrą 9.
operation required|string|INSERT|
INTERVENTION|TRANSFORMATION
Typ operacji. Dozwolone warości: INSERT|INTERVENTION|TRANSFORMATION. Inne nie będą przyjmowane.
porting_mode required|string|DAY|END|EOP Tryb wypowiedzenia umowy z Dawcą.
case_pending_activation_date required|date Wnioskowana data rozpoczęcia świadczenia usług przez Biorcę (Data Umowna Przeniesienia Numeru / Numerów). Akceptowalna data to: rrrr-mm-ddT00:00:00 - obowiązkowo taki format.
Oczekiwane kody odpowiedzi

201

W zwrocie otrzymasz status 201 dla poprawnie utworzonego elementu, case_id (aktualny numer sprawy).

Adres: https://plicbd.arkanavoip.pl/api/exx/download/{portabilityNumber}
Metoda: GET

Funkcja pobiera umowę w formacie PDF, którą należy w kolejnym kroku wrzucić na nasze serwery.

Parametry do obsługi funkcji getAttorney
Parametry do obsługi funkcji getAttorney
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
Oczekiwane kody odpowiedzi

200W zwrocie otrzymasz application/pdf do pobrania.

Adres: https://plicbd.arkanavoip.pl/api/exx/send/{portabilityNumber}
Metoda: POST

Funkcja wysyła komunikat E03 (wniosek o przeniesienie numeru) do PLICBD UKE.

Parametry do obsługi funkcji sendE03
Parametry do obsługi funkcji sendE03
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
attorney required|mimes:pdf|max:6000 Dokument pełnomocnictwa. Nie walidujemy czy jest podpisany. Można wysłać pobrany plik PDF.
Oczekiwane kody odpowiedzi

202

Adres: https://plicbd.arkanavoip.pl/api/exx/e18/{portabilityNumber}
Metoda: POST

Funkcja wysyła komunikat E18 (wniosek o anulowanie przeniesienie numeru) do PLICBD UKE.

Parametry do obsługi funkcji sendE18
Parametry do obsługi funkcji sendE18
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
reason sometimes|nullable|
in:20,21,22,23,24,25,26,27
Powód anulowania wniosku. W przypadku braku tego parametru domyślnie zostanie ustawiony parametr 20 (Abonent zrezygnował z usługi przeniesienia numeru katalogowego).
Oczekiwane kody odpowiedzi

202

Adres: https://plicbd.arkanavoip.pl/api/exx/sende06ore17/{portabilityNumber}
Metoda: POST

Funkcja wysyła komunikat odpowiedź na komunikat E03 tj. komunikat E06 (potwierdzenie możliwości przeniesienia numeru), lub E17 w przypadku braku możliwości przeniesienia numeru.

Parametry do obsługi funkcji sendE06orE17
Parametry do obsługi funkcji sendE06orE17
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
operation sometimes|nullable|in:INSERT,INTERVENTION,TRANSFORMATION Domyślnie: INSERT. Nawet gdy E03 przyjdzie w trybie INTERVENTION - według dokumentacji PLICBD powinniśmy E06 wysłać w trybie INSERT.
decision required|bool Jeśli 1 to wysyłamy E06 (potwierdzenie możliwości przeniesienia), jeśli 0 wysyłamy E17 (odmowa przeniesienia numeru).
case_termination_date required_if:decision,true|date Możliwa data wydania numeru.
reason required_if:decision,false|in:1,2,3,4,5,6,7,8,9 Kod reason. Listę kodów reason dla E17 znajdziesz po kliknięciu w ten tekst.
Oczekiwane kody odpowiedzi

202

Adres: https://plicbd.arkanavoip.pl/api/exx/sendE12/{portabilityNumber}
Metoda: POST

Funkcja wysyła informację (niezbędną) o podpisaniu z Abonentem umowy tj. komunikat E12. Komunikat powinien być wysłany w przeddzień planowanego przeniesienia.

Parametry do obsługi funkcji sendE12
Parametry do obsługi funkcji sendE12
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
case_pending_activation_date sometimes|date Możliwa data aktywacji numeru Jeśli pole nie zostanie wysłane pobierzemy datę z ostatniego komunikatu (E06).
Oczekiwane kody odpowiedzi

202

Adres: https://plicbd.arkanavoip.pl/api/exx/sendE13/{portabilityNumber}
Metoda: POST

Funkcja wysyła komunikat E13 - żądanie przeniesienia numeru.

Parametry do obsługi funkcji sendE13
Parametry do obsługi funkcji sendE13
Parametr Typ Danych Wyjaśnienie
{portabilityNumber} required|int id z naszego systemu dla danego rekordu. Id znajdziesz w funkcji getExx, oraz w przychodzącej notyfikacji, jeśli podałeś adres URL.
Oczekiwane kody odpowiedzi

202

W panelu operatora możesz ustawić automatyczne wysyłanie komunikatu E13 w momencie odbioru komunikatu E12.

Adres: https://plicbd.arkanavoip.pl/api/exx/getE23
Metoda: GET

Funkcja listuje komunikaty dotyczące zmian w numeracji przeniesionej (wysłane komunikaty E23)

Parametry do obsługi funkcji getE23

Funkcja wymaga jedynie autoryzacji w nagłówku (jak każda inna funkcja)

200 W zwrocie otrzymasz jsona z danymi np.

										
{
    "current_page": 1,
    "data": [
        {
            "porting_date": "2022-06-27 15:23:49",
            "recipient": 13148,
            "services_operator": "13148",
            "network_operator": "13148",
            "routing_number": "C2492",
            "operation": "INTERVENTION",
            "desc": "Błąd wysyłki. Komunikatu NIE przekazano do PLICBD",
            "numbers": [
                {
                    "dirnum": "221002030",
                    "dirnum_end": "221002030"
                }
            ]
        },
        {
            "porting_date": "2022-03-25 20:40:00",
            "recipient": 13148,
            "services_operator": "13148",
            "network_operator": "13148",
            "routing_number": "C2492",
            "operation": "INTERVENTION",
            "desc": "komunikat zaakceptowany",
            "numbers": [
                {
                    "dirnum": "123456789",
                    "dirnum_end": "123456789"
                }
            ]
        }
    ],
    "first_page_url": "https://plicbd.arkanavoip.pl/api/exx/getE23?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://plicbd.arkanavoip.pl/api/exx/getE23?page=1",
    "links": [
        {
            "url": null,
            "label": "« Poprzednia",
            "active": false
        },
        {
            "url": "https://plicbd.arkanavoip.pl/api/exx/getE23?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Następna »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://plicbd.arkanavoip.pl/api/exx/getE23",
    "per_page": 25,
    "prev_page_url": null,
    "to": 5,
    "total": 5
}
										
									

Adres: https://plicbd.arkanavoip.pl/api/exx/e23/create
Metoda: POST

Funkcja wysyła komunikat E23 - informujący o zmianach w numeracji przeniesionej.

Parametry do obsługi funkcji sendE23
Parametry do obsługi funkcji sendE23
Parametr Typ Danych Wyjaśnienie
packageKind required|digits|in:1,2 oznaczenie numeracji 1 => stacjonarnej, 2 => komórkowej.
porting_date required|date Data wprowadzenia zmiany (może być dzisiejsza, wtedy automatycznie utworzymy tag "intervention", w przeciwnym wypadku komunikat pójdzie z tagiem insert). Data nie może być z przeszłości.
services_operator required|digits:5 Operator usług po dokonaniu zmiany (RPT).
network_operator required|digits:5 Operator sieci po dokonaniu zmiany (RPT).
routing_number required|regex:/^C\d{4}$/ Numer rutingowy.
porting_type required|in:1,2 Oznaczenie czy zmiana dotyczy 1 numeru (dla mobile, tylko ta opcja możliwa), czy zakres numerów (dla fix) 2.
dirnum required|array Początek zakresu dla jednego numeru: np. 22 123 45 67 i koniec zakresu dla tego samego numeru: 22 123 45 67. Zakres numerów może obejmować minimalnie 10 numerów począwszy od 0 skończywszy na 9 na ostatniej cyfrze, tzn od AB SPQ MC D0 do AB SPQ MC D9.
dirnum_end required|array Ostatni numer zakresu. Jeśli pojedyńczy numer wprowadź go w dirnum i dirnum_end
Oczekiwane kody odpowiedzi

201

Adres: https://plicbd.arkanavoip.pl/api/exx/zwroty
Metoda: GET

Funkcja listuje zgłoszone zwroty numeracji przeniesionej i wnioski o jej zwrot.

Parametry do obsługi funkcji getE14
Parametry do obsługi funkcji getE14
Parametr Typ Danych Wyjaśnienie
status somettimes|nullable|bool Oznaczenie jakie pobrać komunikaty - o statusie zamkniętym (1) lub otwartym (0). Domyślnie 0.
Oczekiwane kody odpowiedzi

200 W zwrocie otrzymasz jsona z danymi np.

										
{
    "current_page": 1,
    "data": [
        {
            "id": 3,
            "case_id": "131480000000007710",
            "recipient": "00001",
            "donor": "13148",
            "np_type": "1",
            "confirm": 1,
            "closed": 1,
            "reason": 0,
            "desc": 'OK',
            "created_at": "2022-06-27T23:45:15.000000Z",
            "updated_at": "2022-06-27T23:45:15.000000Z",
            "numbers": [
                {
                    "dirnum": "221002030",
                    "dirnum_end": "221002030"
                }
            ]
        },
        {
            "id": 2,
            "case_id": "131480000000007708",
            "recipient": "00001",
            "donor": "13148",
            "np_type": "1",
            "confirm": 0,
            "closed": 0,
            "reason": "666",
            "desc": "Błąd wysyłki. Komunikatu NIE przekazano do PLICBD",
            "created_at": "2022-06-27T11:53:26.000000Z",
            "updated_at": "2022-06-27T11:54:17.000000Z",
            "numbers": [
                {
                    "dirnum": "221002030",
                    "dirnum_end": "221002030"
                }
            ]
        },
    ],
    "first_page_url": "https://plicbd.arkanavoip.pl/api/exx/zwroty?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://plicbd.arkanavoip.pl/api/exx/zwroty?page=1",
    "links": [
        {
            "url": null,
            "label": "« Poprzednia",
            "active": false
        },
        {
            "url": "https://plicbd.arkanavoip.pl/api/exx/zwroty?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Następna »",
            "active": false
        }
    ],
    "next_page_url": null,
    "path": "https://plicbd.arkanavoip.pl/api/exx/zwroty",
    "per_page": 25,
    "prev_page_url": null,
    "to": 3,
    "total": 3
}
										
									

Notyfikacje na adres URL podany przez Partnera

Jeśli Partner poda adres URL dla notyfikacji Exx w Zakładce Konto -> Klucze API, przy każdym przyjściu jakiegokolwiek komunikatu Exx wyślemy metodą POST następujące dane:

									
'id'
'type'			// typ komunikatu np. 40
'case_id'
'recipient'
'donor'
'np_type'
'confirm'
'closed'
'reason'
'desc'
'created_at'
'updated_at'
'numbers'
//wyjaśnienia tych pól są tożsame z wyjaśnieniami w getExx
									
								

Powyższe dane będą wysyłane w form-data. Nie oczekujemy żadnej odpowiedzi. W przypadku błędu odbioru po Państwa stronie - komunikaty nie będą wysyłane ponownie. Całość komunikatów można pobrać korzystając z metody getExx.

Adres: https://plicbd.arkanavoip.pl/api/exx/e14/create
Metoda: POST

Funkcja wysyła komunikat E14 - zwrot numeru.

Parametry do obsługi funkcji sendE14
Parametry do obsługi funkcji sendE14
Parametr Typ Danych Wyjaśnienie
np_type required|int|in:1,2 1 => stacjonarna, 2 => komórkowe
dirnum required|array Początek zakresu dla jednego numeru: np. 22 123 45 67 i koniec zakresu dla tego samego numeru: 22 123 45 67. Zakres numerów może obejmować minimalnie 10 numerów począwszy od 0 skończywszy na 9 na ostatniej cyfrze, tzn od AB SPQ MC D0 do AB SPQ MC D9.
dirnum_end required|array Ostatni numer zakresu. Jeśli pojedyńczy numer wprowadź go w dirnum i dirnum_end
recipient required|digits:5 Zwrot do jakiego operatora. W przypadku, gdy recipient wynosi np. 00001, pamiętaj aby wprowadzić zera na początku. Przyjmowana wartość to dokładnie 5 cyfr.
porting_type required|int|in:1,2 1 => jeden numer, 2 => zakres numerów
Oczekiwane kody odpowiedzi

202 Accepted => Zaakceptowano zapis. Nastąpi próba wysyłki do PLICBD UKE w najbliższym możliwym terminie (zgodnym z dokumentacją godzin wysyłki komunikatów do PLICBD).

Adres: https://plicbd.arkanavoip.pl/api/exx/e41/send
Metoda: POST

Funkcja wysyła komunikat E41 - poprawność danych zwracanego numeru.

Parametry do obsługi funkcji sendE41
Parametry do obsługi funkcji sendE41
Parametr Typ Danych Wyjaśnienie
status required|bool 0 => Błędne dane, 1 => Dane poprawne.
Oczekiwane kody odpowiedzi

202 Accepted => Zaakceptowano komunikat. Nastąpi próba wysyłki do PLICBD UKE w najbliższym możliwym terminie (zgodnym z dokumentacją godzin wysyłki komunikatów do PLICBD).

Sprawdź ofertę PLICBD