Update campaign

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

Changes dataToken

Changes one or more settings of a campaign. Send only the fields you want to change; get the allowed values from Get campaign settings.

Parameters

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

typestringrequired
Selects the operation. Always update_campaign for this endpoint.
tokenstringrequired
Your API token from Log in. See Authentication.
campaign_idintegerrequired
ID of the campaign.
Example 1024
amdstringoptional
Answering-machine detection: Y (on) or N (off).
One ofYN
msgstringoptional
Play the campaign message: Y or N.
One ofYN
customcidstringoptional
Use a custom caller ID list: Y or N.
One ofYN
overridestringoptional
Override existing settings: Y or N.
One ofYN
autodiallevelnumberoptional
Dial level: how many lines to dial per available agent (0 to 10).
Example 1.5
dial_methodstringoptional
How the campaign dials. Shown in the app as Broadcast, Predictive, Power (RATIO), Preview (MANUAL) and SMS Broadcast (SMSB).
One ofBROADCASTPREDICTIVERATIOMANUALSMSB
ext_queue_statusstringoptional
Send answered calls to an external queue: Y or N.
One ofYN
AgentLevelstringoptional
Agent level for predictive dialing.
scriptstringoptional
ID of the agent script to show (from Get campaign settings).
Example scr123
call_back_numberstringoptional
Number account holders can call back.
Example 5559876543
conf_extenstringoptional
Extension or queue to transfer answered calls to.
custom_cid_liststringoptional
ID of the caller ID list to rotate through.
campaign_cidstringoptional
Caller ID shown to account holders.
Example 5559876543
number_of_linesintegeroptional
Maximum number of simultaneous lines.
Example 10
autodiallevel2numberoptional
Secondary dial level used by the adaptive dial methods.
adaptive_dropped_percentagenumberoptional
Maximum dropped-call percentage for adaptive dialing (0 to 100).
Example 3
campaign_recordingstringoptional
Record calls: ALLCALLS (on) or NEVER (off).
One ofALLCALLSNEVER
local_call_timestringoptional
ID of the calling-hours schedule (from Get campaign settings).
Example ccsDefault
velocitynumberoptional
Dialing speed for broadcast campaigns.
dial_prefixstringoptional
Dial prefix: 8 (on) or 9 (off).
One of89

curl https://api.dcdial.com/api/ \
  -d type=update_campaign \
  -d token="$DCDIAL_TOKEN" \
  -d campaign_id=1024

<?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' => 'update_campaign',
        'token' => getenv('DCDIAL_TOKEN'),
        'campaign_id' => 1024,
    ]),
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

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

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

import os
import requests

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

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

Update campaign

Parameters

Try it