Power Dialer API

Add and remove contacts from Power Dialer lists.

Fill and clear Power Dialer lists from your own code instead of clicking through Aloware Talk. Four POST endpoints cover the common jobs:

Add contacts to a list
Take one contact off every Power Dialer list
Empty a single Power Dialer list
Empty every Power Dialer list a user owns

Method: POST
Auth: your account API token, sent in the request body as api_token
Format: JSON in, JSON out

Add contacts to a list

Queue up to 1,000 contacts into one Power Dialer list in a single call. The add runs in the background, so a large batch can take a couple of minutes to show up.

Endpoint

POST /api/v1/webhook/powerdialer-add-contacts

Fields

api_token	Required. Your Aloware API token.
list_id	Required. The Power Dialer list to add to.
user_id	Required. The agent the contacts are added for.
contact_ids	Required. An array of contact IDs, at most 1,000.
position	Optional. top or bottom of the list. Default bottom.
prevent_duplicates	Optional. true skips contacts already in the list. Default true.
allow_international_phone_numbers	Optional. Default false, which skips most contacts with an international number.

List IDs come from the Power Dialer lists API. A list kept in sync with an integration such as HubSpot can't take contacts through the API.

cURL example

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/powerdialer-add-contacts' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "list_id": "50",
    "user_id": "1",
    "contact_ids": [44500, 44501, 44502],
    "position": "bottom",
    "prevent_duplicates": true,
    "allow_international_phone_numbers": false
}'

Responses

201: the contacts are queued for the list.

{
    "message": "Tasks are being added to the Power Dialer list. It will take a couple of minutes if it's a large list."
}

422: a field is invalid, the list is kept in sync with an integration, or none of the contacts were found.

This call takes the optional Idempotency-Key header, so a retry after a timeout adds the contacts only once. See Safe retries.

Remove one contact from all lists

Use this when a contact should stop being dialed anywhere. One call pulls them out of every Power Dialer list in your account, so you don't have to go list by list.

Endpoint

POST /api/v1/webhook/powerdialer-remove-contact-from-lists

Fields

Both are required:

api_token	Your Aloware account API token.
contact_id	The contact's ID.

Request example

Full URL:

https://app.aloware.io/api/v1/webhook/powerdialer-remove-contact-from-lists

Send a JSON body with your token and the contact's ID:

{
    // Authentication Token
    "api_token": "12345678", // Required
    "contact_id": "44500" // Required
}

Headers:

{
    "Accept": "application/json",
    "Content-Type": "application/json"
}

Responses

200: Aloware has started taking the contact off the lists. The removal runs in the background, so it can take a moment to finish.

{
    "message": "Power Dialer lists clearing process has been initiated."
}

404: the request failed, and the message says why (here, the contact ID wasn't found).

{
    "message": "The requested contact does not exist."
}

cURL example

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/powerdialer-remove-contact-from-lists' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "contact_id": "44500"
}'

Empty a Power Dialer list

Use this to wipe every contact from one list in a single call, rather than pressing the delete button in Aloware Talk.

For comparison, this is the manual way in the app:

Endpoint

POST /api/v1/webhook/powerdialer-clear-list

Fields

Both are required:

api_token	Your Aloware account API token.
list_id	The Power Dialer list ID.

Request example

Full URL:

https://app.aloware.io/api/v1/webhook/powerdialer-clear-list

JSON body with your token and the list's ID:

{
    // Authentication Token
    "api_token": "12345678", // Required
    "list_id": "50" // Required - Power Dialer list ID
}

Headers:

{
    "Accept": "application/json",
    "Content-Type": "application/json"
}

Responses

200: Aloware has started clearing the list.

{
    "message": "Power Dialer lists clearing process has been initiated."
}

cURL example

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/powerdialer-clear-list' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "list_id": "50"
}'

Empty all of a user's Power Dialer lists

Use this to clear every contact from the Power Dialer lists that belong to one user, all at once.

Here is where the user's ID appears:

Endpoint

POST /api/v1/webhook/powerdialer-clear-user-lists

Fields

Both are required:

api_token	Your Aloware account API token.
user_id	The ID of the user who owns the lists.

Request example

Full URL:

https://app.aloware.io/api/v1/webhook/powerdialer-clear-user-lists

JSON body with your token and the ID of the user who owns the lists:

{
// Authentication Token
"api_token": "[API_TOKEN]", // Required 
"user_id": "1" // Required - Power Dialer owner user ID 
}

Headers:

{
  "Accept": "application/json",
  "Content-Type": "application/json"
}

Responses

200: Aloware has started clearing that user's lists.

{ "message": "Power Dialer user lists clearing process has been initiated." }

cURL example

curl --location --request POST 'https://app.aloware.io/api/v1/webhook/powerdialer-clear-user-lists' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "api_token": "[API_TOKEN]",
    "user_id": "50"
}'

Postman

To try these calls in Postman, import the Power Dialer API collection and set its baseUrl variable to https://app.aloware.io.

Need another endpoint?

For other API functions or help with these, email support@aloware.com.

Need a hand?

Our support team can help you set this up.

Contact support