Passer au contenu principal
GET
/
v2
/
api
/
dialing-queues
/
current
List current queue numbers
curl --request GET \
  --url https://api.withallo.com/v2/api/dialing-queues/current \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "number_to": "+12125550010",
      "position": 0,
      "created_at": "2026-04-30T10:00:00",
      "updated_at": "2026-04-30T10:00:00",
      "call_start_date": null,
      "call_id": null,
      "routing_result": null,
      "sync_status": "NOT_SYNCED"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total_count": 137,
    "total_pages": 7,
    "has_more": true
  },
  "queue": {
    "id": "pdl_2xGh7kLmNpQr",
    "name": "My Queue",
    "creator_id": "usr_abc123",
    "assignee_id": "usr_abc123",
    "voicemail_handling": "NO_SKIP",
    "do_not_disturb": "DISABLED",
    "created_at": "2026-04-30T10:00:00",
    "updated_at": "2026-04-30T10:00:00"
  }
}

​
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.

​
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.

Autorisations

​
Authorization
string
header
requis

Paramètres de requête

​
user_id
string

ID of a teammate to read the queue for. Resolve teammate ids via GET /v2/api/users. Wins over email when both are provided.

Exemple:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

​
email
string<email>

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

Exemple:

"[email protected]"

​
page
integer
défaut:1

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

Plage requise: x >= 1
Exemple:

1

​
size
integer
défaut:20

Number of numbers per page (max 100).

Plage requise: x <= 100
Exemple:

20

Réponse

A page of the current queue's numbers, ordered by position. Empty data array with zeroed pagination when the user has no queue.

​
data
object[]
​
queue
object

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

​
pagination
object