Aloware provides a Power Dialer API that enables you to (1) remove A CONTACT from all power dialer lists, (2) remove ALL CONTACTS from a power dialer list, and (3) remove all contacts from Power Dialer user lists.
This documentation outlines the required fields, examples, and endpoints to utilize the Aloware Power Dialer APIs successfully.
Removing a Contact from All Power Dialer Lists
If you need to remove a contact from all the power dialer lists in your account, you can use this API. This tool lets you delete the contact from multiple power dialer lists at once, instead of removing them one by one.
Endpoint
POST /api/v1/webhook/powerdialer-remove-contact-from-lists
Query Parameters
The following query parameters are required to remove a contact from all power dialer lists:
api_token | Your Aloware account API token. |
contact_id | The contact's ID. |
Example POST URL
https://app.alodev.org/api/v1/webhook/powerdialer-remove-contact-from-lists
Example POST Body
The request body should be in JSON format and include the required fields to remove a contact from all power dialer lists. The following example demonstrates a JSON payload with standard fields:
Removing a contact from Power Dialer lists
{
// Authentication Token
"api_token": "12345678", // Required
"contact_id": "44500" // Required
}Example POST Header
{
"Accept": "application/json",
"Content-Type": "application/json"
}
Response and Error Handling
The API will return the following responses based on the success or failure of the contact creation or update:
HTTP 200 - Contact was removed successfully.
{
"message": "The contact has been removed from the Power Dialer lists."
}HTTP 404 - Failure with a detailed response.
{
"message": "The requested contact id does not exist.",
}cURL Example
curl--location--request POST 'https://app.alodev.org/api/v1/webhook/powerdialer-remove-contact-from-lists'\
--header 'Content-Type: application/json'\
--header 'Accept: application/json'\
--data - raw '{
"api_token": "12345678",
"contact_id": "44500"
}
'
Removing All Contacts from a Power Dialer List
If you need to remove all contacts from a power dialer list, you can do this without using the delete button manually in Aloware Talk.
Here's how to do it without using the API:
Endpoint
POST /api/v1/webhook/powerdialer-clear-list
Query Parameters
The following query parameters are required to remove a contact from a power dialer list:
api_token | Your Aloware account API token. |
list_id | The Power Dialer list ID. |
Example POST URL
https://app.alodev.org/api/v1/webhook/powerdialer-clear-list
Example POST Body
The code sample below represents some example JSON with standard fields to pass in the body of your request to delete all contacts from a power dialer list:
{
// Authentication Token
"api_token": "12345678", // Required
"list_id": "50" // Required - Power Dialer list ID
}Example POST Header
{
"Accept": "application/json",
"Content-Type": "application/json"
}Response and Error Handling
The API will return the following responses based on the success or failure of the contact creation or update:
HTTP 200 - Power Dialer list clearing process initiated successfully.
{
"message": "Power Dialer lists clearing process has been initiated."
}cURL Example
curl--location--request POST 'https://app.alodev.org/api/v1/webhook/powerdialer-clear-list'\
--header 'Content-Type: application/json'\
--header 'Accept: application/json'\
--data - raw '{
"api_token": "12345678",
"list_id": "50"
}
'
Removing All Contacts from a User's Power Dialer List
This feature lets you delete all contacts from a user's power dialer list at once, instead of removing them one by one.
User's ID:
Endpoint
POST /api/v1/webhook/powerdialer-clear-user-lists
Query Parameters
The following query parameters are required to remove all contacts from a power dialer user list:
api_token | Your Aloware account API token. |
user_id | The Power Dialer list ID. |
Example POST URL
https://app.alodev.org/api/v1/webhook/powerdialer-clear-user-lists
Example POST Body
The code sample below represents some example JSON with standard fields to pass in the body of your request to clear one or many Power Dialer lists:
{
// Authentication Token
"api_token": "4A316843", // Required
"user_id": "1" // Required - Power Dialer owner user ID
}Example POST Header
{
"Accept": "application/json",
"Content-Type": "application/json"
}Response and Error Handling
The API will return the following responses based on the success or failure of the contact creation or update:
HTTP 200 - Power Dialer list clearing process initiated successfully.
{ "message": "Power Dialer user lists clearing process has been initiated." }cURL Example
curl --location --request POST 'https://app.alodev.org/api/v1/webhook/powerdialer-clear-user-lists' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
"api_token": "4A316843",
"user_id": "50"
}
'
If you require additional API functions or need further assistance, please don't hesitate to contact our support team at [email protected].