Vai alla navigazione
ElevenAgentsNumeri di telefono

Elenca pagina dei numeri di telefono

Recupera una pagina di numeri di telefono

Header

xi-api-keystringOpzionale

Parametri di query

page_sizeintegerOpzionale1-1000Predefinito a 100
Numero di numeri di telefono per pagina
searchstring or nullOpzionale<=100 characters

Filtra in base all'ID del numero di telefono, all'etichetta o al numero di telefono. L'ID del numero di telefono deve corrispondere esattamente; la corrispondenza di etichetta e numero di telefono è una sottostringa senza distinzione tra maiuscole e minuscole.

labelstring or nullOpzionale<=100 characters

Filtra in base all'etichetta. La corrispondenza è una sottostringa senza distinzione tra maiuscole e minuscole.

phone_numberstring or nullOpzionale<=100 characters
Filtra in base al numero di telefono
providerenum or nullOpzionale
Filtra in base al provider di telefonia
Valori consentiti:
supports_outboundboolean or nullOpzionale

Filtra in base alla possibilità del numero di telefono di effettuare chiamate in uscita

agent_idstring or nullOpzionale
Filtra in base all'ID dell'agente assegnato
branch_idstring or nullOpzionale
Filtra in base all'ID del branch assegnato
sort_byenum or nullOpzionale
Il campo in base al quale ordinare i risultati
Valori consentiti:
sort_directionenumOpzionale
La direzione per ordinare i risultati
Valori consentiti:
cursorstring or nullOpzionale
Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

Risposta

Risposta riuscita
phone_numberslist of objects
I numeri di telefono in questa pagina
next_cursorstring or nullOpzionale

Passa questo valore come cursor per recuperare la pagina successiva. Null quando non ci sono altri risultati.

has_morebooleanOpzionalePredefinito a false
Indica se sono disponibili altri risultati

Errori

422
Unprocessable Entity Error