Pagination
Cet endpoint suit le contrat de liste standard : data est le tableau des numeros de la file courante (tries par position croissante), accompagne d'un bloc pagination de premier niveau.
page— numero de page (commence a 1, defaut1).size— nombre de numeros par page (defaut20, max100).- Lisez
pagination(total_count,total_pages,has_more) pour parcourir la liste complete.
Les metadonnees de la file (id, nom, voicemail_handling, do_not_disturb, createur/assigne) sont retournees sous la cle de premier niveau queue — sans les numeros, puisque ceux-ci sont pagines dans data. Le champ queue reste identique d'une page a l'autre.
Quand l'utilisateur n'a pas de file, la reponse est 200 avec un tableau data vide, un pagination a zero et aucune cle queue — pas une erreur 404.
Lire call_status
Chaque numero de data porte un champ call_status : un statut par ligne, derive de l'appel passe pour ce numero. Utilisez-le plutot que de combiner vous-meme routing_result, not_reached_destination_reason et detected_outbound_voicemail.
| Valeur | Signification |
|---|---|
QUEUED | Aucun appel n'a encore ete passe, ou l'appel est encore en cours. |
SKIPPED | Le numero a ete saute dans le Power Dialer et aucun appel n'a ete passe. Si un appel est passe plus tard pour ce numero, le statut suit cet appel. |
VOICEMAIL | L'appel est tombe sur une messagerie vocale. |
CONNECTED | L'appel a ete decroche au niveau du routage (routing_result vaut ANSWERED) aucune messagerie n'a ete detectee et aucun not_reached_destination_reason n'est renseigne. |
TRANSFERRED | L'appel a ete transfere. |
BUSY | Le destinataire etait occupe. |
WRONG_NUMBER | Le numero n'est pas en service. |
NO_ANSWER | L'appel s'est termine sans reponse : refuse, indisponible, delai de sonnerie depasse, erreur reseau, ou tout autre statut de routage final (echoue, bloque, ferme, gere par le call flow). |
CONNECTED signifie que l'appel a ete decroche au niveau du routage, pas qu'une conversation a eu lieu : il peut donc surestimer les vraies conversations.
Un numero dont l'appel est en cours affiche QUEUED. Compter les numeros QUEUED peut donc differer du nombre restant pendant un appel.
Cibler la file d'un coequipier
Par defaut, cet endpoint retourne la file assignee au proprietaire de la cle API. Pour inspecter la file d'un coequipier, passez user_id ou email en query parameter. Le coequipier doit appartenir a la meme equipe que le proprietaire de la cle API.
user_id— l'emporte quand les deux sont fournis. Resolvez les ids des coequipiers viaGET /v2/api/users.email— utilise uniquement quanduser_idest absent.
Si l'utilisateur resolu n'est pas dans votre equipe, la reponse est 404 ASSIGNEE_NOT_FOUND — la meme erreur est renvoyee que l'utilisateur n'existe pas ou ne soit pas un coequipier, afin que les consommateurs de l'API ne puissent pas enumerer les utilisateurs.