Allo

Lister les numeros de la file courante

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…

GET/v2/api/dialing-queues/current

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, defaut 1).
  • size — nombre de numeros par page (defaut 20, max 100).
  • 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.

ValeurSignification
QUEUEDAucun appel n'a encore ete passe, ou l'appel est encore en cours.
SKIPPEDLe 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.
VOICEMAILL'appel est tombe sur une messagerie vocale.
CONNECTEDL'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.
TRANSFERREDL'appel a ete transfere.
BUSYLe destinataire etait occupe.
WRONG_NUMBERLe numero n'est pas en service.
NO_ANSWERL'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 via GET /v2/api/users.
  • email — utilise uniquement quand user_id est 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.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de requête

user_idstring

ID of a teammate to read the queue for. Resolve teammate ids via [GET /v2/api/users](/en/v2/api-reference/users/list-users). Wins over email when both are provided.

emailstring<email>

Email of a teammate to read the queue for. Ignored when user_id is also supplied.

pageinteger

1-indexed page number for the queue's numbers.

sizeinteger

Number of numbers per page (max 100).

Réponses

200A page of the current queue's numbers, ordered by position. Empty data array with zeroed pagination when the user has no queue.
dataobject[]
12 champs
number_tostring

E.164 destination phone number

positioninteger

Order within the queue (0-based)

created_atstring<date-time>
updated_atstring<date-time>
call_start_datestring<date-time> | null

When the user started calling this entry. null if the entry is still unassigned.

call_idstring | null

ID of the call placed for this entry (cll-*). null until a call is placed.

routing_resultenum<string>

Final routing outcome of the call placed for this entry.

FAILEDRECEIVEDBLOCKEDANSWEREDTRANSFERRED_BLANDTRANSFERRED_ELEVEN_LABSTRANSFERRED_EXTERNALFAILED_EXTERNALVOICEMAILCLOSED

sync_statusenum<string>

State of contact creation/sync for this entry.

NOT_SYNCEDPROCESSINGSYNCED

detected_outbound_voicemailboolean | null

Whether the call was detected as having reached a voicemail box.

not_reached_destination_reasonenum<string>

Why the call did not reach the contact (only set when applicable).

BUSYCALLEE_TEMPORARILY_UNAVAILABLERING_TIMEOUTNOT_IN_SERVICEDECLINEDNETWORK_ERROR

voicemail_leftboolean | null

Whether the user left a voicemail on this entry.

call_statusenum<string>

Status of this entry, derived from the call placed for it. QUEUED: no call yet, or the call is still in progress. SKIPPED: skipped in the Power Dialer with no call placed (if a call is placed for it later, the status follows that call). VOICEMAIL: the call reached a voicemail box. CONNECTED: the call was answered at route level (routing_result is ANSWERED), no voicemail was detected and no not_reached_destination_reason is set; this can over-report a real conversation. TRANSFERRED: the call was transferred. BUSY: the destination was busy. WRONG_NUMBER: the destination is not in service. NO_ANSWER: the call ended without an answer, including the other not_reached_destination_reason values and any other final route status (failed, blocked, closed, handled by call flow).

QUEUEDSKIPPEDVOICEMAILCONNECTEDTRANSFERREDNO_ANSWERBUSYWRONG_NUMBER

queueobject

Power Dialer queue metadata, without its numbers. Returned under the queue key of GET /current; the numbers themselves are the paginated data.

8 champs
idstring

Unique queue identifier (KSUID with pdl prefix)

namestring | null

Display name of the queue

creator_idstring

User ID of the queue creator.

assignee_idstring | null

User ID of the user expected to run the queue.

voicemail_handlingenum<string>

How the Power Dialer reacts when the call lands in voicemail.

SKIPNO_SKIP

do_not_disturbenum<string>

When ENABLED, incoming calls are silenced while the queue is being run.

ENABLEDDISABLED

created_atstring<date-time>
updated_atstring<date-time>
paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
401
404Assignee not found
errorobject
6 champs
typestring
codestring
messagestring
retryableboolean
request_idstring
retry_after_secondsinteger | null
429