Naar navigatie springen
API-referentieTelefoonnummers

Pagina met telefoonnummers weergeven

Haal een pagina met telefoonnummers op

Headers

xi-api-keystringOptioneel

Queryparameters

page_sizeintegerOptioneel1-1000Standaard 100
Aantal telefoonnummers per pagina
searchstringOptioneel<=100 characters

Filter op telefoonnummer-ID, label of telefoonnummer. Een telefoonnummer-ID moet exact overeenkomen; overeenkomsten voor labels en telefoonnummers zijn hoofdletterongevoelige deelreeksen.

labelstringOptioneel<=100 characters
Filter op label. Overeenkomsten zijn hoofdletterongevoelige deelreeksen.
phone_numberstringOptioneel<=100 characters
Filter op telefoonnummer
providerenumOptioneel
Filter op telefonieprovider
Toegestane waarden:
supports_outboundbooleanOptioneel
Filter op of het telefoonnummer uitgaande gesprekken kan voeren
agent_idstringOptioneel

Filter op toegewezen agent-ID

branch_idstringOptioneel

Filter op toegewezen branch-ID

sort_byenumOptioneel
Het veld waarop de resultaten worden gesorteerd
Toegestane waarden:
sort_directionenumOptioneel
De richting waarin je de resultaten sorteert
Toegestane waarden:
cursorstringOptioneel
Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response
phone_numberslist of objects
De telefoonnummers op deze pagina
next_cursorstringOptioneel

Geef deze waarde door als cursor om de volgende pagina op te halen. Null als er geen resultaten meer zijn.

has_morebooleanOptioneelStandaard false
Of er meer resultaten beschikbaar zijn

Fouten

422
Phone Numbers List V2request Unprocessable Entity Error