Lister la page des numéros de téléphone

Récupère une page de numéros de téléphone

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

page_sizeintegerOptionnel1-1000Par défaut 100

Nombre de numéros de téléphone par page

searchstring or nullOptionnel<=100 characters

Filtrer par ID de numéro de téléphone, libellé ou numéro de téléphone. L’ID de numéro de téléphone doit correspondre exactement ; la correspondance du libellé et du numéro de téléphone porte sur une sous-chaîne, sans distinction entre majuscules et minuscules.

labelstring or nullOptionnel<=100 characters

Filtrer par libellé. La correspondance porte sur une sous-chaîne, sans distinction entre majuscules et minuscules.

phone_numberstring or nullOptionnel<=100 characters

Filtrer par numéro de téléphone

providerenum or nullOptionnel

Filtrer par fournisseur de téléphonie

Valeurs autorisées:
supports_outboundboolean or nullOptionnel

Filtrer selon que le numéro de téléphone peut émettre des appels sortants

agent_idstring or nullOptionnel

Filtrer par ID d’agent attribué

branch_idstring or nullOptionnel

Filtrer par ID de branche attribuée

sort_byenum or nullOptionnel

Le champ selon lequel trier les résultats

Valeurs autorisées:
sort_directionenumOptionnel

L’ordre de tri des résultats

Valeurs autorisées:
cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

phone_numberslist of objects

Les numéros de téléphone sur cette page

next_cursorstring or nullOptionnel

Transmettez cette valeur comme cursor pour récupérer la page suivante. Null lorsqu’il n’y a plus de résultats.

has_morebooleanOptionnelPar défaut false

Indique si d’autres résultats sont disponibles

Erreurs

422
Unprocessable Entity Error