Allo

Mettre a jour la file courante

Par defaut, cet endpoint met a jour la config de la file assignee au proprietaire de la cle API. Pour mettre a jour la file d'un coequipier, envoyez user id…

PATCH/v2/api/dialing-queues/current

Cibler la file d'un coequipier

Par defaut, cet endpoint met a jour la config de la file assignee au proprietaire de la cle API. Pour mettre a jour la file d'un coequipier, envoyez user_id ou email dans le corps JSON. 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.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

namestring | null

New queue name (1–255 characters)

voicemail_handlingenum<string>

How the Power Dialer reacts when the call hits voicemail.

SKIPNO_SKIP

do_not_disturbenum<string>

Silence inbound calls while running the queue.

ENABLEDDISABLED

user_idstring | null

Optional. ID of a teammate whose queue config should be updated. The teammate must belong to the same team as the API key owner. Wins over email when both are provided.

emailstring<email> | null

Optional. Email of a teammate whose queue config should be updated. Ignored when user_id is also supplied.

Réponses

200Updated queue
dataobject

A user's Power Dialer queue with its configuration and numbers.

9 champs
idstring

Unique queue identifier (KSUID with pdl prefix)

namestring | null

Display name of the queue

creator_idstring

User ID of the queue creator — the user (or API key owner) that created the queue.

assignee_idstring | null

User ID of the user expected to run the queue. GET /current returns the queue where this matches the authenticated user (or the user resolved from user_id / email). Defaults to the creator when none was specified at creation time.

voicemail_handlingenum<string>

How the Power Dialer reacts when the call lands in voicemail. SKIP advances to the next number; NO_SKIP keeps the user on the call.

SKIPNO_SKIP

do_not_disturbenum<string>

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

ENABLEDDISABLED

numbersobject[]
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

created_atstring<date-time>
updated_atstring<date-time>
400
401
404Assignee not found
errorobject
6 champs
typestring
codestring
messagestring
retryableboolean
request_idstring
retry_after_secondsinteger | null
429