Passer au contenu principal
DELETE
/
v2
/
api
/
dialing-queues
/
current
/
numbers
Clear queue numbers
curl --request DELETE \
  --url https://api.withallo.com/v2/api/dialing-queues/current/numbers \
  --header 'Authorization: <api-key>'
{
  "data": {
    "removed": 4
  }
}

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

Use this file to discover all available pages before exploring further.

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_pid ou email en query parameter. Le coequipier doit appartenir a la meme equipe que le proprietaire de la cle API.
  • user_pid — l’emporte quand les deux sont fournis. Resolvez les pids des coequipiers via GET /v2/api/users.
  • email — utilise uniquement quand user_pid est absent.
Si l’utilisateur resolu n’est pas dans votre equipe, la reponse est 404 ASSIGNEE_NOT_FOUND.

Autorisations

Authorization
string
header
requis

Paramètres de requête

number
string

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

Exemple:

"+12125550010"

position
integer

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

Plage requise: x >= 0
Exemple:

3

unassigned
boolean

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

Exemple:

true

user_pid
string

Pid of a teammate whose queue to clear. Resolve teammate pids via GET /v2/api/users. Wins over email when both are provided.

Exemple:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

email
string<email>

Email of a teammate whose queue to clear. Ignored when user_pid is also supplied.

Réponse

Numbers removed

data
object

Result of clearing numbers from a Power Dialer queue.