Wyświetl stronę numerów telefonów

Pobierz stronę numerów telefonów

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

page_sizeintegerOpcjonalny1-1000Domyślnie 100

Liczba numerów telefonów na stronę

searchstring or nullOpcjonalny<=100 characters

Filtruj według ID numeru telefonu, etykiety lub numeru telefonu. ID numeru telefonu musi być dokładnie zgodne; etykieta i numer telefonu są dopasowywane jako fragment tekstu bez rozróżniania wielkości liter.

labelstring or nullOpcjonalny<=100 characters

Filtruj według etykiety. Dopasowanie jest fragmentem tekstu bez rozróżniania wielkości liter.

phone_numberstring or nullOpcjonalny<=100 characters

Filtruj według numeru telefonu

providerenum or nullOpcjonalny

Filtruj według dostawcy telefonii

Dozwolone wartości:
supports_outboundboolean or nullOpcjonalny

Filtruj według tego, czy numer telefonu może wykonywać połączenia wychodzące

agent_idstring or nullOpcjonalny

Filtruj według ID przypisanego agenta

branch_idstring or nullOpcjonalny

Filtruj według ID przypisanej gałęzi

sort_byenum or nullOpcjonalny

Pole, według którego sortować wyniki

Dozwolone wartości:
sort_directionenumOpcjonalny

Kierunek sortowania wyników

Dozwolone wartości:
cursorstring or nullOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

phone_numberslist of objects
Numery telefonu na tej stronie
next_cursorstring or nullOpcjonalny

Przekaż tę wartość jako cursor, aby pobrać następną stronę. Null, gdy nie ma więcej wyników.

has_morebooleanOpcjonalnyDomyślnie false

Czy dostępne są kolejne wyniki

Błędy

422
Unprocessable Entity Error