Set notification settings

Notifications

POSThttps://api.dcdial.com/api/type=set_notifications

Changes dataToken

Chooses which in-app alerts the user receives and how they are delivered.

Parameters

Send as application/x-www-form-urlencoded.

• typestringrequired

  Selects the operation. Always set_notifications for this endpoint.

• tokenstringrequired

  Your API token from Log in. See Authentication.

• enable_notificationstringoptional

  Y to turn notifications on for this user, N to turn them off.

  One ofYN
• campaign_startedintegeroptional

  1 to be alerted when a campaign starts.

  One of01
• campaign_stoppedintegeroptional

  1 to be alerted when a campaign stops.

  One of01
• campaign_pausedintegeroptional

  1 to be alerted when a campaign pauses.

  One of01
• campaign_noActiveLeadsintegeroptional

  1 to be alerted when a campaign runs out of accounts to call.

  One of01
• campaign_completedintegeroptional

  1 to be alerted when a campaign completes.

  One of01
• list_addintegeroptional

  1 to be alerted when a list is added.

  One of01
• list_scrubReportintegeroptional

  1 to be alerted when a list scrub report is ready.

  One of01
• scheduler_capaignStartedintegeroptional

  1 to be alerted when a scheduled campaign starts. (The field name is spelled this way.)

  One of01
• balance_belowintegeroptional

  Alert when the dialer balance drops below this amount.

  One of50100200300500100020003000
• alert_frequencyintegeroptional

  Minutes between repeated alerts (0 = once).

  One of015304560
• alert_methodstringoptional

  How to deliver alerts.

  One ofpopupemailsms

Notes

The settings you send replace all previous ones. Send 1 for each alert you want to keep.

cURL

curl https://api.dcdial.com/api/ \
  -d type=set_notifications \
  -d token="$DCDIAL_TOKEN" \
  -d enable_notification=Y \
  -d campaign_started=0 \
  -d campaign_stopped=0

PHP

<?php
$ch = curl_init('https://api.dcdial.com/api/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => http_build_query([
        'type' => 'set_notifications',
        'token' => getenv('DCDIAL_TOKEN'),
        'enable_notification' => 'Y',
        'campaign_started' => 0,
        'campaign_stopped' => 0,
    ]),
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (($result['response']['success'] ?? 0) != 1) {
    throw new RuntimeException($result['response']['error'] ?? 'Request failed');
}

Node.js

const res = await fetch('https://api.dcdial.com/api/', {
  method: 'POST',
  body: new URLSearchParams({
    type: "set_notifications",
    token: process.env.DCDIAL_TOKEN,
    enable_notification: "Y",
    campaign_started: "0",
    campaign_stopped: "0",
  }),
});
const { response } = await res.json();
if (response.success != 1) throw new Error(response.error);

Python

import os
import requests

r = requests.post(
    "https://api.dcdial.com/api/",
    data={
        "type": "set_notifications",
        "token": os.environ["DCDIAL_TOKEN"],
        "enable_notification": "Y",
        "campaign_started": 0,
        "campaign_stopped": 0,
    },
    timeout=30,
)
response = r.json()["response"]
if str(response.get("success")) != "1":
    raise RuntimeError(response.get("error"))

Response · 200 OK

{
  "response": {
    "success": 1,
    "error": ""
  }
}

Try it

Environment

QAProduction

token required

Send request⌘ ↵