Passer au contenu principal
PATCH
/
v2
/
api
/
dialing-queues
/
current
curl --request PATCH \
  --url https://api.withallo.com/v2/api/dialing-queues/current \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Cold Calls"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "creator_id": "<string>",
    "assignee_id": "<string>",
    "voicemail_handling": "SKIP",
    "do_not_disturb": "ENABLED",
    "numbers": [
      {
        "number_to": "<string>",
        "position": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "call_start_date": "2023-11-07T05:31:56Z",
        "call_id": "<string>",
        "routing_result": "FAILED",
        "sync_status": "NOT_SYNCED",
        "detected_outbound_voicemail": true,
        "not_reached_destination_reason": "BUSY",
        "voicemail_left": true
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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 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_pid ou email dans le corps JSON. 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

Corps

application/json

Creates or updates the queue config. All fields are optional — only the fields you supply are touched. Pass user_pid or email to act on a teammate's queue instead.

name
string | null

New queue name (1–255 characters)

Required string length: 1 - 255
voicemail_handling
enum<string> | null

How the Power Dialer reacts when the call hits voicemail.

Options disponibles:
SKIP,
NO_SKIP
do_not_disturb
enum<string> | null

Silence inbound calls while running the queue.

Options disponibles:
ENABLED,
DISABLED
user_pid
string | null

Optional. Pid 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.

Exemple:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

email
string<email> | null

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

Réponse

Updated queue

data
object

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