Zur Navigation springen
Erste SchrittePhone Numbers

Telefonnummernseite auflisten

Eine Seite mit Telefonnummern abrufen

Header

xi-api-keystringOptional

Abfrageparameter

page_sizeintegerOptional1-1000Standardwert ist 100
Anzahl der Telefonnummern pro Seite
searchstringOptional<=100 characters

Nach Telefonnummer-ID, Label oder Telefonnummer filtern. Eine Telefonnummer-ID muss exakt übereinstimmen; bei Label und Telefonnummer erfolgt die Übereinstimmung als Teilzeichenfolge ohne Berücksichtigung der Groß- und Kleinschreibung.

labelstringOptional<=100 characters

Nach Label filtern. Die Übereinstimmung erfolgt als Teilzeichenfolge ohne Berücksichtigung der Groß- und Kleinschreibung.

phone_numberstringOptional<=100 characters
Nach Telefonnummer filtern
providerenumOptional
Nach Telefonieanbieter filtern
Erlaubte Werte:
supports_outboundbooleanOptional

Danach filtern, ob die Telefonnummer ausgehende Anrufe tätigen kann

agent_idstringOptional

Nach zugewiesener Agent-ID filtern

branch_idstringOptional

Nach zugewiesener Zweig-ID filtern

sort_byenumOptional
Das Feld, nach dem die Ergebnisse sortiert werden
Erlaubte Werte:
sort_directionenumOptional
Die Richtung zum Sortieren der Ergebnisse
Erlaubte Werte:
cursorstringOptional

Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

Antwort

Erfolgreiche Antwort
phone_numberslist of objects
Die Telefonnummern auf dieser Seite
next_cursorstringOptional

Übergeben Sie diesen Wert als cursor, um die nächste Seite abzurufen. Null, wenn keine weiteren Ergebnisse vorhanden sind.

has_morebooleanOptionalStandardwert ist false

Ob weitere Ergebnisse verfügbar sind.

Fehler

422
Phone Numbers List V2request Unprocessable Entity Error