Allo

Vider les numeros de la file

Par defaut, cet endpoint vide des numeros de la file assignee au proprietaire de la cle API. Pour vider la file d'un coequipier, passez user id ou email en…

DELETE/v2/api/dialing-queues/current/numbers

Cibler la file d'un coequipier

Par defaut, cet endpoint vide des numeros de la file assignee au proprietaire de la cle API. Pour vider 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.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de requête

numberstring

Phone number to remove (any format — normalized to E.164). Removes every entry matching this number unless position is also supplied.

positioninteger

0-based position to remove. Combine with number to disambiguate when the same number appears more than once.

unassignedboolean

When true, removes every queue entry that has not been called yet. Cannot be combined with number or position.

user_idstring

ID of a teammate whose queue to clear. 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 whose queue to clear. Ignored when user_id is also supplied.

Réponses

200Numbers removed
dataobject

Result of clearing numbers from a Power Dialer queue.

1 champs
removedinteger

Number of queue entries that were removed.

400Filter missing or conflicting
errorobject
6 champs
typestring
codestring
messagestring
retryableboolean
request_idstring
retry_after_secondsinteger | null
401
404Queue or position not found
errorobject
6 champs
typestring
codestring
messagestring
retryableboolean
request_idstring
retry_after_secondsinteger | null
429