DCDial Documentation

DCDial API Introduction

Authentication Procedure

Our API uses JSON Web Tokens to provide authentication credentials to requests. Being token-based means that you make one login request passing it your authentication credentials (“username” and “password”) and it returns a secure authentication token for you to use with each request to the API.

Tokens, unlike session authentication, are valid until they expire or are cancelled. Tokens are valid for 12 hours from the time they are issued, so you should only need to request a token once per day; however it is recommended that you be able to handle a request failure due to authentication failure and request a new token.

An example of requesting a token for the authentication is in the API section under Get Authentication Token

Configurations

No specific configurations is needed to access DCDial API

Method URL
POST/GET https://api.dcdial.com/api/

Required Parameters on Login

API Endpoint for getting a new authentication token
https://api.qa.dcdial.com/api/token-auth
PHP
<?php
$postFelds = "type=login_user&key=$key&user=$user&pass=$pass";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "jbilling_uname": "[value]",
    "billing_token": "[value]",
    "success": [
      1/0
    ],
    "key": "[value]",
    "full_name": "[value]",
    "last_name": "[value]",
    "email": "[value]",
    "mobile_number": "[value]",
    "token": "[value]"
  }
}

 


User
Required

Pass
Required

This is a POST request type

Notice that, this API request is made as a POST request since you are “posting” your authentication credentials.
Type Params Values Params Type
POST user Username Mandatory
POST pass Password Mandatory
POST type login_user Mandatory

 

  • Billing_token is used to call our billing API
  • Token is used to access further API methods with same key “token

Campaign APIs

Play Campaign API

Use this API to activate the selected campaign. Outbound calling begins once the campaign list is activated. The campaign remains active until paused or stopped.
https://api.dcdial.com/api/
PHP
<?php
  $postFelds = "token=$token&type=play_campaign";
  $url = "https://api.dcdial.com/api/";	
  $ch = curl_init();		
  curl_setopt($ch, CURLOPT_URL, $url);		
  curl_setopt($ch,CURLOPT_POST,1);	
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);		
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch);				
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id Campaign ID Mandatory
POST type play_campaign Mandatory

 

Pause Campaign API

Use this API to pause a running campaign. This suspends outbound dialing for the campaign. If there are any calls in progress, the campaign will continue to run until the active calls are completed.
PHP
 <?php
  $postFelds = "token=$token&type=pause_campaign";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

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

 


Campaign Id
Required

Type Params Values Params Type
POST campaign_id [Campaign ID] Mandatory
POST type pause_campaign Mandatory

Stop Campaign API

Use this API to stop a paused or running campaign. This stops outbound dialing and deactivates a campaign list.
PHP
 <?php
  $postFelds = "token=$token&type=stop_campaign";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

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

 

 


Campaign Id
Required

Type Params Values Params Type
POST campaign_id [Campaign ID] Mandatory
POST type stop_campaign Mandatory

Get All Campaigns

Use this API to view a list of all campaigns in the system returned in sorted order, with the most recently added campaigns appearing first.
PHP
 <?php
  $postFelds = "token=$token&type=get_campaigns";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

{
"response": {
"key": "[value]",
"success": "[value]",
"error": "[value]",
"campaigns_list":
{"campaign_id":"[value]","campaign_name":"[value]","display_status":"[value]","active":"[value]"},
{"campaign_id":"[value]","campaign_name":"[value]","display_status":"[value]","active":"[value]"},
{"campaign_id":"[value]","campaign_name":"[value]","display_status":"[value]","active":"[value]"}
}
}

 


Campaign Id
Required

Type Params Values Params Type
POST campaign_id [Campaign ID] Mandatory
POST type get_campaigns Mandatory

Get Campaigns Settings

Use this API to retrieve the relevant information on a specified campaign, such as the campaign name, description, answering machine detection, dial settings, compliance settings, and dial mode-specific settings.
PHP
<?php
  $postFelds = "token=$token&type=get_campaign_settings";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"success":1,"error":"","dial_method":[{"current_value":[{"backendValue":"BROADCAST","frontendValue":"BROADCAST"}],"options":[{"backendValue":"BROADCAST","frontendValue":"BROADCAST"},{"backendValue":"PREDICTIVE","frontendValue":"PREDICTIVE"},{"backendValue":"RATIO","frontendValue":"POWER"},{"backendValue":"MANUAL","frontendValue":"PREVIEW"},{"backendValue":"SMSB","frontendValue":"SMS BROADCAST"}]}],"campaign_recording":[{"current_value":[{"backendValue":"NEVER","frontendValue":"OFF"}],"options":[{"backendValue":"NEVER","frontendValue":"OFF"},{"backendValue":"ALLCALLS","frontendValue":"ON"},{"backendValue":"ONDEMAND","frontendValue":"AS NEEDED"},{"backendValue":"ALLFORCE","frontendValue":"ALWAYS ON"}]}],"auto_dial_level":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"0","frontendValue":"0"},{"backendValue":"0.1","frontendValue":"0.1"},{"backendValue":"0.2","frontendValue":"0.2"},{"backendValue":"0.3","frontendValue":"0.3"},{"backendValue":"0.4","frontendValue":"0.4"},{"backendValue":"0.5","frontendValue":"0.5"},{"backendValue":"0.6","frontendValue":"0.6"},{"backendValue":"0.7","frontendValue":"0.7"},{"backendValue":"0.8","frontendValue":"0.8"},{"backendValue":"0.9","frontendValue":"0.9"},{"backendValue":"1.0","frontendValue":"1.0"},{"backendValue":"1.1","frontendValue":"1.1"},{"backendValue":"1.2","frontendValue":"1.2"},{"backendValue":"1.3","frontendValue":"1.3"},{"backendValue":"1.4","frontendValue":"1.4"},{"backendValue":"1.5","frontendValue":"1.5"},{"backendValue":"1.6","frontendValue":"1.6"},{"backendValue":"1.7","frontendValue":"1.7"},{"backendValue":"1.8","frontendValue":"1.8"},{"backendValue":"1.9","frontendValue":"1.9"},{"backendValue":"2.0","frontendValue":"2.0"},{"backendValue":"2.1","frontendValue":"2.1"},{"backendValue":"2.2","frontendValue":"2.2"},{"backendValue":"2.3","frontendValue":"2.3"},{"backendValue":"2.4","frontendValue":"2.4"},{"backendValue":"2.5","frontendValue":"2.5"},{"backendValue":"2.6","frontendValue":"2.6"},{"backendValue":"2.7","frontendValue":"2.7"},{"backendValue":"2.8","frontendValue":"2.8"},{"backendValue":"2.9","frontendValue":"2.9"},{"backendValue":"3.0","frontendValue":"3.0"},{"backendValue":"3.1","frontendValue":"3.1"},{"backendValue":"3.2","frontendValue":"3.2"},{"backendValue":"3.3","frontendValue":"3.3"},{"backendValue":"3.4","frontendValue":"3.4"},{"backendValue":"3.5","frontendValue":"3.5"},{"backendValue":"3.6","frontendValue":"3.6"},{"backendValue":"3.7","frontendValue":"3.7"},{"backendValue":"3.8","frontendValue":"3.8"},{"backendValue":"3.9","frontendValue":"3.9"},{"backendValue":"4.0","frontendValue":"4.0"},{"backendValue":"4.1","frontendValue":"4.1"},{"backendValue":"4.2","frontendValue":"4.2"},{"backendValue":"4.3","frontendValue":"4.3"},{"backendValue":"4.4","frontendValue":"4.4"},{"backendValue":"4.5","frontendValue":"4.5"},{"backendValue":"4.6","frontendValue":"4.6"},{"backendValue":"4.7","frontendValue":"4.7"},{"backendValue":"4.8","frontendValue":"4.8"},{"backendValue":"4.9","frontendValue":"4.9"},{"backendValue":"5.0","frontendValue":"5.0"},{"backendValue":"5.1","frontendValue":"5.1"},{"backendValue":"5.2","frontendValue":"5.2"},{"backendValue":"5.3","frontendValue":"5.3"},{"backendValue":"5.4","frontendValue":"5.4"},{"backendValue":"5.5","frontendValue":"5.5"},{"backendValue":"5.6","frontendValue":"5.6"},{"backendValue":"5.7","frontendValue":"5.7"},{"backendValue":"5.8","frontendValue":"5.8"},{"backendValue":"5.9","frontendValue":"5.9"},{"backendValue":"6.0","frontendValue":"6.0"},{"backendValue":"6.1","frontendValue":"6.1"},{"backendValue":"6.2","frontendValue":"6.2"},{"backendValue":"6.3","frontendValue":"6.3"},{"backendValue":"6.4","frontendValue":"6.4"},{"backendValue":"6.5","frontendValue":"6.5"},{"backendValue":"6.6","frontendValue":"6.6"},{"backendValue":"6.7","frontendValue":"6.7"},{"backendValue":"6.8","frontendValue":"6.8"},{"backendValue":"6.9","frontendValue":"6.9"},{"backendValue":"7.0","frontendValue":"7.0"},{"backendValue":"7.1","frontendValue":"7.1"},{"backendValue":"7.2","frontendValue":"7.2"},{"backendValue":"7.3","frontendValue":"7.3"},{"backendValue":"7.4","frontendValue":"7.4"},{"backendValue":"7.5","frontendValue":"7.5"},{"backendValue":"7.6","frontendValue":"7.6"},{"backendValue":"7.7","frontendValue":"7.7"},{"backendValue":"7.8","frontendValue":"7.8"},{"backendValue":"7.9","frontendValue":"7.9"},{"backendValue":"8.0","frontendValue":"8.0"},{"backendValue":"8.1","frontendValue":"8.1"},{"backendValue":"8.2","frontendValue":"8.2"},{"backendValue":"8.3","frontendValue":"8.3"},{"backendValue":"8.4","frontendValue":"8.4"},{"backendValue":"8.5","frontendValue":"8.5"},{"backendValue":"8.6","frontendValue":"8.6"},{"backendValue":"8.7","frontendValue":"8.7"},{"backendValue":"8.8","frontendValue":"8.8"},{"backendValue":"8.9","frontendValue":"8.9"},{"backendValue":"9.0","frontendValue":"9.0"},{"backendValue":"9.1","frontendValue":"9.1"},{"backendValue":"9.2","frontendValue":"9.2"},{"backendValue":"9.3","frontendValue":"9.3"},{"backendValue":"9.4","frontendValue":"9.4"},{"backendValue":"9.5","frontendValue":"9.5"},{"backendValue":"9.6","frontendValue":"9.6"},{"backendValue":"9.7","frontendValue":"9.7"},{"backendValue":"9.8","frontendValue":"9.8"},{"backendValue":"9.9","frontendValue":"9.9"},{"backendValue":"10.0","frontendValue":"10.0"},{"backendValue":"10.1","frontendValue":"10.1"},{"backendValue":"10.2","frontendValue":"10.2"},{"backendValue":"10.3","frontendValue":"10.3"},{"backendValue":"10.4","frontendValue":"10.4"},{"backendValue":"10.5","frontendValue":"10.5"},{"backendValue":"10.6","frontendValue":"10.6"},{"backendValue":"10.7","frontendValue":"10.7"},{"backendValue":"10.8","frontendValue":"10.8"},{"backendValue":"10.9","frontendValue":"10.9"},{"backendValue":"11.0","frontendValue":"11.0"},{"backendValue":"11.1","frontendValue":"11.1"},{"backendValue":"11.2","frontendValue":"11.2"},{"backendValue":"11.3","frontendValue":"11.3"},{"backendValue":"11.4","frontendValue":"11.4"},{"backendValue":"11.5","frontendValue":"11.5"},{"backendValue":"11.6","frontendValue":"11.6"},{"backendValue":"11.7","frontendValue":"11.7"},{"backendValue":"11.8","frontendValue":"11.8"},{"backendValue":"11.9","frontendValue":"11.9"},{"backendValue":"12.0","frontendValue":"12.0"},{"backendValue":"12.1","frontendValue":"12.1"},{"backendValue":"12.2","frontendValue":"12.2"},{"backendValue":"12.3","frontendValue":"12.3"},{"backendValue":"12.4","frontendValue":"12.4"},{"backendValue":"12.5","frontendValue":"12.5"},{"backendValue":"12.6","frontendValue":"12.6"},{"backendValue":"12.7","frontendValue":"12.7"},{"backendValue":"12.8","frontendValue":"12.8"},{"backendValue":"12.9","frontendValue":"12.9"},{"backendValue":"13.0","frontendValue":"13.0"},{"backendValue":"13.1","frontendValue":"13.1"},{"backendValue":"13.2","frontendValue":"13.2"},{"backendValue":"13.3","frontendValue":"13.3"},{"backendValue":"13.4","frontendValue":"13.4"},{"backendValue":"13.5","frontendValue":"13.5"},{"backendValue":"13.6","frontendValue":"13.6"},{"backendValue":"13.7","frontendValue":"13.7"},{"backendValue":"13.8","frontendValue":"13.8"},{"backendValue":"13.9","frontendValue":"13.9"},{"backendValue":"14.0","frontendValue":"14.0"},{"backendValue":"14.1","frontendValue":"14.1"},{"backendValue":"14.2","frontendValue":"14.2"},{"backendValue":"14.3","frontendValue":"14.3"},{"backendValue":"14.4","frontendValue":"14.4"},{"backendValue":"14.5","frontendValue":"14.5"},{"backendValue":"14.6","frontendValue":"14.6"},{"backendValue":"14.7","frontendValue":"14.7"},{"backendValue":"14.8","frontendValue":"14.8"},{"backendValue":"14.9","frontendValue":"14.9"},{"backendValue":"15.0","frontendValue":"15.0"},{"backendValue":"15.1","frontendValue":"15.1"},{"backendValue":"15.2","frontendValue":"15.2"},{"backendValue":"15.3","frontendValue":"15.3"},{"backendValue":"15.4","frontendValue":"15.4"},{"backendValue":"15.5","frontendValue":"15.5"},{"backendValue":"15.6","frontendValue":"15.6"},{"backendValue":"15.7","frontendValue":"15.7"},{"backendValue":"15.8","frontendValue":"15.8"},{"backendValue":"15.9","frontendValue":"15.9"},{"backendValue":"16.0","frontendValue":"16.0"},{"backendValue":"16.1","frontendValue":"16.1"},{"backendValue":"16.2","frontendValue":"16.2"},{"backendValue":"16.3","frontendValue":"16.3"},{"backendValue":"16.4","frontendValue":"16.4"},{"backendValue":"16.5","frontendValue":"16.5"},{"backendValue":"16.6","frontendValue":"16.6"},{"backendValue":"16.7","frontendValue":"16.7"},{"backendValue":"16.8","frontendValue":"16.8"},{"backendValue":"16.9","frontendValue":"16.9"},{"backendValue":"17.0","frontendValue":"17.0"},{"backendValue":"17.1","frontendValue":"17.1"},{"backendValue":"17.2","frontendValue":"17.2"},{"backendValue":"17.3","frontendValue":"17.3"},{"backendValue":"17.4","frontendValue":"17.4"},{"backendValue":"17.5","frontendValue":"17.5"},{"backendValue":"17.6","frontendValue":"17.6"},{"backendValue":"17.7","frontendValue":"17.7"},{"backendValue":"17.8","frontendValue":"17.8"},{"backendValue":"17.9","frontendValue":"17.9"},{"backendValue":"18.0","frontendValue":"18.0"},{"backendValue":"18.1","frontendValue":"18.1"},{"backendValue":"18.2","frontendValue":"18.2"},{"backendValue":"18.3","frontendValue":"18.3"},{"backendValue":"18.4","frontendValue":"18.4"},{"backendValue":"18.5","frontendValue":"18.5"},{"backendValue":"18.6","frontendValue":"18.6"},{"backendValue":"18.7","frontendValue":"18.7"},{"backendValue":"18.8","frontendValue":"18.8"},{"backendValue":"18.9","frontendValue":"18.9"},{"backendValue":"19.0","frontendValue":"19.0"},{"backendValue":"19.1","frontendValue":"19.1"},{"backendValue":"19.2","frontendValue":"19.2"},{"backendValue":"19.3","frontendValue":"19.3"},{"backendValue":"19.4","frontendValue":"19.4"},{"backendValue":"19.5","frontendValue":"19.5"},{"backendValue":"19.6","frontendValue":"19.6"},{"backendValue":"19.7","frontendValue":"19.7"},{"backendValue":"19.8","frontendValue":"19.8"},{"backendValue":"19.9","frontendValue":"19.9"},{"backendValue":"20.0","frontendValue":"20.0"},{"backendValue":"20.1","frontendValue":"20.1"},{"backendValue":"20.2","frontendValue":"20.2"},{"backendValue":"20.3","frontendValue":"20.3"},{"backendValue":"20.4","frontendValue":"20.4"},{"backendValue":"20.5","frontendValue":"20.5"},{"backendValue":"20.6","frontendValue":"20.6"},{"backendValue":"20.7","frontendValue":"20.7"},{"backendValue":"20.8","frontendValue":"20.8"},{"backendValue":"20.9","frontendValue":"20.9"},{"backendValue":"21.0","frontendValue":"21.0"},{"backendValue":"21.1","frontendValue":"21.1"},{"backendValue":"21.2","frontendValue":"21.2"},{"backendValue":"21.3","frontendValue":"21.3"},{"backendValue":"21.4","frontendValue":"21.4"},{"backendValue":"21.5","frontendValue":"21.5"},{"backendValue":"21.6","frontendValue":"21.6"},{"backendValue":"21.7","frontendValue":"21.7"},{"backendValue":"21.8","frontendValue":"21.8"},{"backendValue":"21.9","frontendValue":"21.9"},{"backendValue":"22.0","frontendValue":"22.0"},{"backendValue":"22.1","frontendValue":"22.1"},{"backendValue":"22.2","frontendValue":"22.2"},{"backendValue":"22.3","frontendValue":"22.3"},{"backendValue":"22.4","frontendValue":"22.4"},{"backendValue":"22.5","frontendValue":"22.5"},{"backendValue":"22.6","frontendValue":"22.6"},{"backendValue":"22.7","frontendValue":"22.7"},{"backendValue":"22.8","frontendValue":"22.8"},{"backendValue":"22.9","frontendValue":"22.9"},{"backendValue":"23.0","frontendValue":"23.0"},{"backendValue":"23.1","frontendValue":"23.1"},{"backendValue":"23.2","frontendValue":"23.2"},{"backendValue":"23.3","frontendValue":"23.3"},{"backendValue":"23.4","frontendValue":"23.4"},{"backendValue":"23.5","frontendValue":"23.5"},{"backendValue":"23.6","frontendValue":"23.6"},{"backendValue":"23.7","frontendValue":"23.7"},{"backendValue":"23.8","frontendValue":"23.8"},{"backendValue":"23.9","frontendValue":"23.9"},{"backendValue":"24.0","frontendValue":"24.0"},{"backendValue":"24.1","frontendValue":"24.1"},{"backendValue":"24.2","frontendValue":"24.2"},{"backendValue":"24.3","frontendValue":"24.3"},{"backendValue":"24.4","frontendValue":"24.4"},{"backendValue":"24.5","frontendValue":"24.5"},{"backendValue":"24.6","frontendValue":"24.6"},{"backendValue":"24.7","frontendValue":"24.7"},{"backendValue":"24.8","frontendValue":"24.8"},{"backendValue":"24.9","frontendValue":"24.9"},{"backendValue":"25.0","frontendValue":"25.0"},{"backendValue":"25.1","frontendValue":"25.1"},{"backendValue":"25.2","frontendValue":"25.2"},{"backendValue":"25.3","frontendValue":"25.3"},{"backendValue":"25.4","frontendValue":"25.4"},{"backendValue":"25.5","frontendValue":"25.5"},{"backendValue":"25.6","frontendValue":"25.6"},{"backendValue":"25.7","frontendValue":"25.7"},{"backendValue":"25.8","frontendValue":"25.8"},{"backendValue":"25.9","frontendValue":"25.9"}]}],"adaptive_dropped_percentage":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"0","frontendValue":"0"},{"backendValue":"100","frontendValue":"100"},{"backendValue":"99","frontendValue":"99"},{"backendValue":"98","frontendValue":"98"},{"backendValue":"97","frontendValue":"97"},{"backendValue":"96","frontendValue":"96"},{"backendValue":"95","frontendValue":"95"},{"backendValue":"94","frontendValue":"94"},{"backendValue":"93","frontendValue":"93"},{"backendValue":"92","frontendValue":"92"},{"backendValue":"91","frontendValue":"91"},{"backendValue":"90","frontendValue":"90"},{"backendValue":"89","frontendValue":"89"},{"backendValue":"88","frontendValue":"88"},{"backendValue":"87","frontendValue":"87"},{"backendValue":"86","frontendValue":"86"},{"backendValue":"85","frontendValue":"85"},{"backendValue":"84","frontendValue":"84"},{"backendValue":"83","frontendValue":"83"},{"backendValue":"82","frontendValue":"82"},{"backendValue":"81","frontendValue":"81"},{"backendValue":"80","frontendValue":"80"},{"backendValue":"79","frontendValue":"79"},{"backendValue":"78","frontendValue":"78"},{"backendValue":"77","frontendValue":"77"},{"backendValue":"76","frontendValue":"76"},{"backendValue":"75","frontendValue":"75"},{"backendValue":"74","frontendValue":"74"},{"backendValue":"73","frontendValue":"73"},{"backendValue":"72","frontendValue":"72"},{"backendValue":"71","frontendValue":"71"},{"backendValue":"70","frontendValue":"70"},{"backendValue":"69","frontendValue":"69"},{"backendValue":"68","frontendValue":"68"},{"backendValue":"67","frontendValue":"67"},{"backendValue":"66","frontendValue":"66"},{"backendValue":"65","frontendValue":"65"},{"backendValue":"64","frontendValue":"64"},{"backendValue":"63","frontendValue":"63"},{"backendValue":"62","frontendValue":"62"},{"backendValue":"61","frontendValue":"61"},{"backendValue":"60","frontendValue":"60"},{"backendValue":"59","frontendValue":"59"},{"backendValue":"58","frontendValue":"58"},{"backendValue":"57","frontendValue":"57"},{"backendValue":"56","frontendValue":"56"},{"backendValue":"55","frontendValue":"55"},{"backendValue":"54","frontendValue":"54"},{"backendValue":"53","frontendValue":"53"},{"backendValue":"52","frontendValue":"52"},{"backendValue":"51","frontendValue":"51"},{"backendValue":"50","frontendValue":"50"},{"backendValue":"49","frontendValue":"49"},{"backendValue":"48","frontendValue":"48"},{"backendValue":"47","frontendValue":"47"},{"backendValue":"46","frontendValue":"46"},{"backendValue":"45","frontendValue":"45"},{"backendValue":"44","frontendValue":"44"},{"backendValue":"43","frontendValue":"43"},{"backendValue":"42","frontendValue":"42"},{"backendValue":"41","frontendValue":"41"},{"backendValue":"40","frontendValue":"40"},{"backendValue":"39","frontendValue":"39"},{"backendValue":"38","frontendValue":"38"},{"backendValue":"37","frontendValue":"37"},{"backendValue":"36","frontendValue":"36"},{"backendValue":"35","frontendValue":"35"},{"backendValue":"34","frontendValue":"34"},{"backendValue":"33","frontendValue":"33"},{"backendValue":"32","frontendValue":"32"},{"backendValue":"31","frontendValue":"31"},{"backendValue":"30","frontendValue":"30"},{"backendValue":"29","frontendValue":"29"},{"backendValue":"28","frontendValue":"28"},{"backendValue":"27","frontendValue":"27"},{"backendValue":"26","frontendValue":"26"},{"backendValue":"25","frontendValue":"25"},{"backendValue":"24","frontendValue":"24"},{"backendValue":"23","frontendValue":"23"},{"backendValue":"22","frontendValue":"22"},{"backendValue":"21","frontendValue":"21"},{"backendValue":"20","frontendValue":"20"},{"backendValue":"19","frontendValue":"19"},{"backendValue":"18","frontendValue":"18"},{"backendValue":"17","frontendValue":"17"},{"backendValue":"16","frontendValue":"16"},{"backendValue":"15","frontendValue":"15"},{"backendValue":"14","frontendValue":"14"},{"backendValue":"13","frontendValue":"13"},{"backendValue":"12","frontendValue":"12"},{"backendValue":"11","frontendValue":"11"},{"backendValue":"10","frontendValue":"10"},{"backendValue":"9","frontendValue":"9"},{"backendValue":"8","frontendValue":"8"},{"backendValue":"7","frontendValue":"7"},{"backendValue":"6","frontendValue":"6"},{"backendValue":"5","frontendValue":"5"},{"backendValue":"4","frontendValue":"4"},{"backendValue":"3","frontendValue":"3"},{"backendValue":"2.9","frontendValue":"2.9"},{"backendValue":"2.8","frontendValue":"2.8"},{"backendValue":"2.7","frontendValue":"2.7"},{"backendValue":"2.6","frontendValue":"2.6"},{"backendValue":"2.5","frontendValue":"2.5"},{"backendValue":"2.4","frontendValue":"2.4"},{"backendValue":"2.3","frontendValue":"2.3"},{"backendValue":"2.2","frontendValue":"2.2"},{"backendValue":"2.1","frontendValue":"2.1"},{"backendValue":"2","frontendValue":"2"},{"backendValue":"1.9","frontendValue":"1.9"},{"backendValue":"1.8","frontendValue":"1.8"},{"backendValue":"1.7","frontendValue":"1.7"},{"backendValue":"1.6","frontendValue":"1.6"},{"backendValue":"1.5","frontendValue":"1.5"},{"backendValue":"1.4","frontendValue":"1.4"},{"backendValue":"1.3","frontendValue":"1.3"},{"backendValue":"1.2","frontendValue":"1.2"},{"backendValue":"1.1","frontendValue":"1.1"},{"backendValue":"1","frontendValue":"1"},{"backendValue":"0.9","frontendValue":"0.9"},{"backendValue":"0.8","frontendValue":"0.8"},{"backendValue":"0.7","frontendValue":"0.7"},{"backendValue":"0.6","frontendValue":"0.6"},{"backendValue":"0.5","frontendValue":"0.5"},{"backendValue":"0.4","frontendValue":"0.4"},{"backendValue":"0.3","frontendValue":"0.3"},{"backendValue":"0.2","frontendValue":"0.2"},{"backendValue":"0.1","frontendValue":"0.1"}]}],"local_call_time":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"ccsDefault10311","frontendValue":"Default Customer Schedule"}]}],"sms_templates":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"smstFPah7OteLjF7C10311","frontendValue":"Business Loan Offer"},{"backendValue":"smstWJBr6HGXyg0aC10311","frontendValue":"Customer Satisfaction Survey"},{"backendValue":"smstdccFpuromMipC10311","frontendValue":"Monthly Payment Reminder"}]}],"campaign_type":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[]}],"amd_send_to_vmx":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[]}],"cpd_amd_action":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[]}],"adaptive_intensity":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"0","frontendValue":"0"},{"backendValue":"40","frontendValue":"40 - More Intense"},{"backendValue":"39","frontendValue":"39 - More Intense"},{"backendValue":"38","frontendValue":"38 - More Intense"},{"backendValue":"37","frontendValue":"37 - More Intense"},{"backendValue":"36","frontendValue":"36 - More Intense"},{"backendValue":"35","frontendValue":"35 - More Intense"},{"backendValue":"34","frontendValue":"34 - More Intense"},{"backendValue":"33","frontendValue":"33 - More Intense"},{"backendValue":"32","frontendValue":"32 - More Intense"},{"backendValue":"31","frontendValue":"31 - More Intense"},{"backendValue":"30","frontendValue":"30 - More Intense"},{"backendValue":"29","frontendValue":"29 - More Intense"},{"backendValue":"28","frontendValue":"28 - More Intense"},{"backendValue":"27","frontendValue":"27 - More Intense"},{"backendValue":"26","frontendValue":"26 - More Intense"},{"backendValue":"25","frontendValue":"25 - More Intense"},{"backendValue":"24","frontendValue":"24 - More Intense"},{"backendValue":"23","frontendValue":"23 - More Intense"},{"backendValue":"22","frontendValue":"22 - More Intense"},{"backendValue":"21","frontendValue":"21 - More Intense"},{"backendValue":"20","frontendValue":"20 - More Intense"},{"backendValue":"19","frontendValue":"19 - More Intense"},{"backendValue":"18","frontendValue":"18 - More Intense"},{"backendValue":"17","frontendValue":"17 - More Intense"},{"backendValue":"16","frontendValue":"16 - More Intense"},{"backendValue":"15","frontendValue":"15 - More Intense"},{"backendValue":"14","frontendValue":"14 - More Intense"},{"backendValue":"13","frontendValue":"13 - More Intense"},{"backendValue":"12","frontendValue":"12 - More Intense"},{"backendValue":"11","frontendValue":"11 - More Intense"},{"backendValue":"10","frontendValue":"10 - More Intense"},{"backendValue":"9","frontendValue":"9 - More Intense"},{"backendValue":"8","frontendValue":"8 - More Intense"},{"backendValue":"7","frontendValue":"7 - More Intense"},{"backendValue":"6","frontendValue":"6 - More Intense"},{"backendValue":"5","frontendValue":"5 - More Intense"},{"backendValue":"4","frontendValue":"4 - More Intense"},{"backendValue":"3","frontendValue":"3 - More Intense"},{"backendValue":"2","frontendValue":"2 - More Intense"},{"backendValue":"1","frontendValue":"1 - More Intense"},{"backendValue":"0","frontendValue":"0 - Balanced"},{"backendValue":"-1","frontendValue":"-1 - Less Intense"},{"backendValue":"-2","frontendValue":"-2 - Less Intense"},{"backendValue":"-3","frontendValue":"-3 - Less Intense"},{"backendValue":"-4","frontendValue":"-4 - Less Intense"},{"backendValue":"-5","frontendValue":"-5 - Less Intense"},{"backendValue":"-6","frontendValue":"-6 - Less Intense"},{"backendValue":"-7","frontendValue":"-7 - Less Intense"},{"backendValue":"-8","frontendValue":"-8 - Less Intense"},{"backendValue":"-9","frontendValue":"-9 - Less Intense"},{"backendValue":"-10","frontendValue":"-10 - Less Intense"},{"backendValue":"-11","frontendValue":"-11 - Less Intense"},{"backendValue":"-12","frontendValue":"-12 - Less Intense"},{"backendValue":"-13","frontendValue":"-13 - Less Intense"},{"backendValue":"-14","frontendValue":"-14 - Less Intense"},{"backendValue":"-15","frontendValue":"-15 - Less Intense"},{"backendValue":"-16","frontendValue":"-16 - Less Intense"},{"backendValue":"-17","frontendValue":"-17 - Less Intense"},{"backendValue":"-18","frontendValue":"-18 - Less Intense"},{"backendValue":"-19","frontendValue":"-19 - Less Intense"},{"backendValue":"-20","frontendValue":"-20 - Less Intense"},{"backendValue":"-21","frontendValue":"-21 - Less Intense"},{"backendValue":"-22","frontendValue":"-22 - Less Intense"},{"backendValue":"-23","frontendValue":"-23 - Less Intense"},{"backendValue":"-24","frontendValue":"-24 - Less Intense"},{"backendValue":"-25","frontendValue":"-25 - Less Intense"},{"backendValue":"-26","frontendValue":"-26 - Less Intense"},{"backendValue":"-27","frontendValue":"-27 - Less Intense"},{"backendValue":"-28","frontendValue":"-28 - Less Intense"},{"backendValue":"-29","frontendValue":"-29 - Less Intense"},{"backendValue":"-30","frontendValue":"-30 - Less Intense"},{"backendValue":"-31","frontendValue":"-31 - Less Intense"},{"backendValue":"-32","frontendValue":"-32 - Less Intense"},{"backendValue":"-33","frontendValue":"-33 - Less Intense"},{"backendValue":"-34","frontendValue":"-34 - Less Intense"},{"backendValue":"-35","frontendValue":"-35 - Less Intense"},{"backendValue":"-36","frontendValue":"-36 - Less Intense"},{"backendValue":"-37","frontendValue":"-37 - Less Intense"},{"backendValue":"-38","frontendValue":"-38 - Less Intense"},{"backendValue":"-39","frontendValue":"-39 - Less Intense"},{"backendValue":"-40","frontendValue":"-40 - Less Intense"}]}],"amd_status":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"Y","frontendValue":"ON"},{"backendValue":"N","frontendValue":"OFF"}]}],"msg_status":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"Y","frontendValue":"ON"},{"backendValue":"N","frontendValue":"OFF"}]}],"adaptive_dl_diff_target":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"0","frontendValue":"0"},{"backendValue":"40","frontendValue":"40 - Calls Waiting for Agents"},{"backendValue":"39","frontendValue":"39 - Calls Waiting for Agents"},{"backendValue":"38","frontendValue":"38 - Calls Waiting for Agents"},{"backendValue":"37","frontendValue":"37 - Calls Waiting for Agents"},{"backendValue":"36","frontendValue":"36 - Calls Waiting for Agents"},{"backendValue":"35","frontendValue":"35 - Calls Waiting for Agents"},{"backendValue":"34","frontendValue":"34 - Calls Waiting for Agents"},{"backendValue":"33","frontendValue":"33 - Calls Waiting for Agents"},{"backendValue":"32","frontendValue":"32 - Calls Waiting for Agents"},{"backendValue":"31","frontendValue":"31 - Calls Waiting for Agents"},{"backendValue":"30","frontendValue":"30 - Calls Waiting for Agents"},{"backendValue":"29","frontendValue":"29 - Calls Waiting for Agents"},{"backendValue":"28","frontendValue":"28 - Calls Waiting for Agents"},{"backendValue":"27","frontendValue":"27 - Calls Waiting for Agents"},{"backendValue":"26","frontendValue":"26 - Calls Waiting for Agents"},{"backendValue":"25","frontendValue":"25 - Calls Waiting for Agents"},{"backendValue":"24","frontendValue":"24 - Calls Waiting for Agents"},{"backendValue":"23","frontendValue":"23 - Calls Waiting for Agents"},{"backendValue":"22","frontendValue":"22 - Calls Waiting for Agents"},{"backendValue":"21","frontendValue":"21 - Calls Waiting for Agents"},{"backendValue":"20","frontendValue":"20 - Calls Waiting for Agents"},{"backendValue":"19","frontendValue":"19 - Calls Waiting for Agents"},{"backendValue":"18","frontendValue":"18 - Calls Waiting for Agents"},{"backendValue":"17","frontendValue":"17 - Calls Waiting for Agents"},{"backendValue":"16","frontendValue":"16 - Calls Waiting for Agents"},{"backendValue":"15","frontendValue":"15 - Calls Waiting for Agents"},{"backendValue":"14","frontendValue":"14 - Calls Waiting for Agents"},{"backendValue":"13","frontendValue":"13 - Calls Waiting for Agents"},{"backendValue":"12","frontendValue":"12 - Calls Waiting for Agents"},{"backendValue":"11","frontendValue":"11 - Calls Waiting for Agents"},{"backendValue":"10","frontendValue":"10 - Calls Waiting for Agents"},{"backendValue":"9","frontendValue":"9 - Calls Waiting for Agents"},{"backendValue":"8","frontendValue":"8 - Calls Waiting for Agents"},{"backendValue":"7","frontendValue":"7 - Calls Waiting for Agents"},{"backendValue":"6","frontendValue":"6 - Calls Waiting for Agents"},{"backendValue":"5","frontendValue":"5 - Calls Waiting for Agents"},{"backendValue":"4","frontendValue":"4 - Calls Waiting for Agents"},{"backendValue":"3","frontendValue":"3 - Calls Waiting for Agents"},{"backendValue":"2","frontendValue":"2 - Calls Waiting for Agents"},{"backendValue":"1","frontendValue":"1 - Calls Waiting for Agents"},{"backendValue":"0","frontendValue":"0 - Balanced"},{"backendValue":"-1","frontendValue":"-1 - Agents Waiting for Calls"},{"backendValue":"-2","frontendValue":"-2 - Agents Waiting for Calls"},{"backendValue":"-3","frontendValue":"-3 - Agents Waiting for Calls"},{"backendValue":"-4","frontendValue":"-4 - Agents Waiting for Calls"},{"backendValue":"-5","frontendValue":"-5 - Agents Waiting for Calls"},{"backendValue":"-6","frontendValue":"-6 - Agents Waiting for Calls"},{"backendValue":"-7","frontendValue":"-7 - Agents Waiting for Calls"},{"backendValue":"-8","frontendValue":"-8 - Agents Waiting for Calls"},{"backendValue":"-9","frontendValue":"-9 - Agents Waiting for Calls"},{"backendValue":"-10","frontendValue":"-10 - Agents Waiting for Calls"},{"backendValue":"-11","frontendValue":"-11 - Agents Waiting for Calls"},{"backendValue":"-12","frontendValue":"-12 - Agents Waiting for Calls"},{"backendValue":"-13","frontendValue":"-13 - Agents Waiting for Calls"},{"backendValue":"-14","frontendValue":"-14 - Agents Waiting for Calls"},{"backendValue":"-15","frontendValue":"-15 - Agents Waiting for Calls"},{"backendValue":"-16","frontendValue":"-16 - Agents Waiting for Calls"},{"backendValue":"-17","frontendValue":"-17 - Agents Waiting for Calls"},{"backendValue":"-18","frontendValue":"-18 - Agents Waiting for Calls"},{"backendValue":"-19","frontendValue":"-19 - Agents Waiting for Calls"},{"backendValue":"-20","frontendValue":"-20 - Agents Waiting for Calls"},{"backendValue":"-21","frontendValue":"-21 - Agents Waiting for Calls"},{"backendValue":"-22","frontendValue":"-22 - Agents Waiting for Calls"},{"backendValue":"-23","frontendValue":"-23 - Agents Waiting for Calls"},{"backendValue":"-24","frontendValue":"-24 - Agents Waiting for Calls"},{"backendValue":"-25","frontendValue":"-25 - Agents Waiting for Calls"},{"backendValue":"-26","frontendValue":"-26 - Agents Waiting for Calls"},{"backendValue":"-27","frontendValue":"-27 - Agents Waiting for Calls"},{"backendValue":"-28","frontendValue":"-28 - Agents Waiting for Calls"},{"backendValue":"-29","frontendValue":"-29 - Agents Waiting for Calls"},{"backendValue":"-30","frontendValue":"-30 - Agents Waiting for Calls"},{"backendValue":"-31","frontendValue":"-31 - Agents Waiting for Calls"},{"backendValue":"-32","frontendValue":"-32 - Agents Waiting for Calls"},{"backendValue":"-33","frontendValue":"-33 - Agents Waiting for Calls"},{"backendValue":"-34","frontendValue":"-34 - Agents Waiting for Calls"},{"backendValue":"-35","frontendValue":"-35 - Agents Waiting for Calls"},{"backendValue":"-36","frontendValue":"-36 - Agents Waiting for Calls"},{"backendValue":"-37","frontendValue":"-37 - Agents Waiting for Calls"},{"backendValue":"-38","frontendValue":"-38 - Agents Waiting for Calls"},{"backendValue":"-39","frontendValue":"-39 - Agents Waiting for Calls"},{"backendValue":"-40","frontendValue":"-40 - Agents Waiting for Calls"}]}],"campaign_script":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"scro7FDjtAtyOQzC10311","frontendValue":"Default Script"}]}],"call_back_number":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"4044102710","frontendValue":"4044102710"},{"backendValue":"4049541080","frontendValue":"4049541080"}]}],"use_custom_cid":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"Y","frontendValue":"ON"},{"backendValue":"N","frontendValue":"OFF"}]}],"campaign_cid":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"4044102710","frontendValue":"4044102710"},{"backendValue":"4049541080","frontendValue":"4049541080"}]}],"regional_cidlist_id":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"}]}],"ext_queue_status":[{"current_value":[{"backendValue":"N","frontendValue":"N"}],"options":[{"backendValue":"Y","frontendValue":"ON"},{"backendValue":"N","frontendValue":"OFF"}]}],"queues":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"}]}],"ext_queues":[{"current_value":[{"backendValue":"","frontendValue":""}],"options":[{"backendValue":"","frontendValue":"None"},{"backendValue":"4044102710","frontendValue":"4044102710"},{"backendValue":"4049541080","frontendValue":"4049541080"}]}],"number_of_lines":[{"current_value":[{"backendValue":"0","frontendValue":"0"}],"options":[{"backendValue":"0","frontendValue":"0"},{"backendValue":"1","frontendValue":"1"},{"backendValue":"5","frontendValue":"5"},{"backendValue":"10","frontendValue":"10"},{"backendValue":"15","frontendValue":"15"},{"backendValue":"20","frontendValue":"20"},{"backendValue":"25","frontendValue":"25"},{"backendValue":"30","frontendValue":"30"},{"backendValue":"35","frontendValue":"35"},{"backendValue":"40","frontendValue":"40"},{"backendValue":"45","frontendValue":"45"},{"backendValue":"50","frontendValue":"50"}]}],"dial_prefix":[{"current_value":[{"backendValue":"9","frontendValue":"OFF"}],"options":[{"backendValue":"8","frontendValue":"ON"},{"backendValue":"9","frontendValue":"OFF"}]}]}}

Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST type get_campaign_settings Mandatory

Update Campaign

Use this API to update an existing campaign by setting the new values for the existing campaign settings. Any parameters not provided will be left unchanged.
PHP
  $postFelds = "token=$token&type=update_campaign";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

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

 


Campaign Id
Required

amd
Required

msg
Required

customcid
Required

override
Required

autodiallevel

dial_method
Required

ext_queue_status

agentLevel

script

call_back_number

conf_exten

system_exten

custom_cid_list

campaign_cid

number_of_lines

autodiallevel2

adaptative_dropped_percentage

campaign_recording

local_call_time

velocity

dial_prefix

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST amd [VALUE] Mandatory
POST msg [VALUE] Mandatory
POST customcid [VALUE] Mandatory
POST override [VALUE] Mandatory
POST autodiallevel [VALUE]
POST dial_method [VALUE] Mandatory
POST ext_queue_status [VALUE]
POST agentLevel [VALUE]
POST script [VALUE]
POST call_back_number [VALUE]
POST conf_exten [VALUE]
POST system_exten [VALUE]
POST custom_cid_list [VALUE]
POST campaign_cid [VALUE]
POST number_of_lines [VALUE]
POST autodiallevel2 [VALUE]
POST adaptative_dropped_percentage [VALUE]
POST campaign_recording [VALUE]
POST local_call_time [VALUE]
POST velocity [VALUE]
POST dial_prefix [VALUE]
POST type update_campaign Mandatory

Test Call

Use this API to initiate an outbound call to your number to test the call delivery. For voice campaigns, the test call allows you to hear a broadcast message before it goes to your customers and verify all the settings.
PHP
<?php
  $postFelds = "token=$token&type=dial_number";
  $url = "https://api.dcdial.com/api/"; 
  $ch = curl_init(); 
  curl_setopt($ch, CURLOPT_URL, $url); 
  curl_setopt($ch,CURLOPT_POST,1); 
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields); 
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch); 
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

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

 


Campaign Id
Required

Phone Number
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST phone_number [VALUE] Mandatory
POST caller_id [VALUE] Mandatory
POST type dial_number Mandatory

Get List

Use this API to retrieve the relevant information on a specified contact list. The list is an essential component of any outbound dialing system because it contains customer information and phone numbers dialed to reach contacts.
PHP
    <?php
    $postFelds = "token=$token&type=get_list";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   $result = curl_exec($ch);
curl_close($ch);
?>

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "error": "",
    "lists_list": [
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]",
        "total_leads": "0",
        "total_dialed": "0",
        "percentage_dialed": "0",
        "uploading_time": "0"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]",
        "total_leads": "0",
        "total_dialed": "0",
        "percentage_dialed": "0",
        "uploading_time": "0"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]",
        "total_leads": "0",
        "total_dialed": "0",
        "percentage_dialed": "0",
        "uploading_time": "0"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]",
        "total_leads": "0",
        "total_dialed": "0",
        "percentage_dialed": "0",
        "uploading_time": "0"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]",
        "total_leads": "0",
        "total_dialed": "0",
        "percentage_dialed": "0",
        "uploading_time": "0"
      }
    ]
  }
}

 


List Id
Required

Type Params Values Params Type
POST list_id [VALUE] Mandatory
POST type get_list Mandatory

List APIs

Get Lists

Use this API to view a list of all lists in the system returned in sorted order, with the most recently added lists appearing first.
PHP
<?php
$postFelds = "token=$token&type=get_lists";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "error": "",
    "lists_list": [
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]"
      },
      {
        "list_id": "[]",
        "list_name": "[]",
        "campaign_id": "[]",
        "campaign_name": "[]",
        "active": "[]",
        "list_description": "[]",
        "list_changedate": "[]",
        "list_lastcalldate": "[]",
        "status": "[]"
      }
    ]
  }
}

 


Campaign Id

Status

Filter

 

Type Params Values Params Type
POST campaign_id [VALUE] Optional
POST status [Y/N] Optional
POST filter [RA/RD] Optional
POST type get_lists Mandatory

Change List Status

Use this API to change the status of the list from active to inactive and vice versa.
PHP
<?php
$postFelds = "token=$token&type=change_status";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


List Id
Required

Status

 

Type Params Values Params Type
POST list_id [VALUE] Mandatory
POST status [‘Y’/’N’] Mandatory
POST type change_status Mandatory

Search Lead and Log

Use this API to generate leads and logs, filtering the search results by phone, account, name, and other lead details.
PHP
<?php
$postFelds = "token=$token&type=search_lead";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "footer": "0",
    "error": "",
    "all_log_search": [
      {
        "uniqueid": "1555005158.1906",
        "lead_id": "1230291(4044102710)",
        "list_id": "222210311",
        "call_date": "04/11/19 01:52 PM",
        "full_name": "John Smith",
        "status": "DROP",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102710",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555005132.1903",
        "lead_id": "1230290(4044102710)",
        "list_id": "222210311",
        "call_date": "04/11/19 01:52 PM",
        "full_name": "John Smith",
        "status": "INCALL",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102710",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555004926.1897",
        "lead_id": "1230288(4044102702)",
        "list_id": "222210311",
        "call_date": "04/11/19 01:49 PM",
        "full_name": "John Smith",
        "status": "A",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102702",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555002942.1890",
        "lead_id": "1230287(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 01:16 PM",
        "full_name": "John Smith",
        "status": "HUP",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555001291.1885",
        "lead_id": "1230286(4044102710)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:48 PM",
        "full_name": "John Smith",
        "status": "IVRSVY",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpcZ8j3dJTJIrdC10311",
        "flag": "0",
        "phone_number": "4044102710",
        "campaign_name": " Payment Broadcast ",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555001156.1882",
        "lead_id": "1230285(4044102710)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:46 PM",
        "full_name": "John Smith",
        "status": "PU",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpfzQ54cgm781IC10311",
        "flag": "0",
        "phone_number": "4044102710",
        "campaign_name": "0",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555000863434.0",
        "lead_id": "1230284(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:41 PM",
        "full_name": "John Smith",
        "status": "SMSSNT",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpuXpoW6jjCLiSC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Monthly Payment Reminder",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1555000322619.0",
        "lead_id": "1230283(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:32 PM",
        "full_name": "John Smith",
        "status": "SMSSNT",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpKSoxZ8UHX8YWC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "0",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554999842217.0",
        "lead_id": "1230282(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:24 PM",
        "full_name": "John Smith",
        "status": "SMSSNT",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpJI7Gi51RYZMdC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Business Loan Offer",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554999782941.0",
        "lead_id": "1230281(4044102701)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:23 PM",
        "full_name": "John Smith",
        "status": "SMSSNT",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpJI7Gi51RYZMdC10311",
        "flag": "0",
        "phone_number": "4044102701",
        "campaign_name": "Business Loan Offer",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554999722183.0",
        "lead_id": "1230280(4044102701)",
        "list_id": "222210311",
        "call_date": "04/11/19 12:22 PM",
        "full_name": "John Smith",
        "status": "SMSSNT",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpJI7Gi51RYZMdC10311",
        "flag": "0",
        "phone_number": "4044102701",
        "campaign_name": "Business Loan Offer",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554994530.1877",
        "lead_id": "1230279(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:55 AM",
        "full_name": "John Smith",
        "status": "DROP",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554994427.1874",
        "lead_id": "1230278(4044102702)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:54 AM",
        "full_name": "John Smith",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102702",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554993904.1871",
        "lead_id": "1230277(4044102702)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:45 AM",
        "full_name": "John Smith",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102702",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554993806.1868",
        "lead_id": "1230276(4044102702)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:43 AM",
        "full_name": "John Smith",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102702",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554993539.1865",
        "lead_id": "1230275(4044102702)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:39 AM",
        "full_name": "John Smith",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4044102702",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554993427.1862",
        "lead_id": "1230274(4049541080)",
        "list_id": "222210311",
        "call_date": "04/11/19 10:37 AM",
        "full_name": "John Smith",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "Yes",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554724272.001230080",
        "lead_id": "1230080(4049541080)",
        "list_id": "222210311",
        "call_date": "04/08/19 07:51 AM",
        "full_name": "0",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554724076.001230079",
        "lead_id": "1230079(4049541080)",
        "list_id": "222210311",
        "call_date": "04/08/19 07:47 AM",
        "full_name": "0",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      },
      {
        "uniqueid": "1554723583.001230078",
        "lead_id": "1230078(4049541080)",
        "list_id": "222210311",
        "call_date": "04/08/19 07:39 AM",
        "full_name": "0",
        "status": "N",
        "call_type": "OUTBOUND",
        "campaign_id": "cmpc4IZsWz1z77dC10311",
        "flag": "0",
        "phone_number": "4049541080",
        "campaign_name": "Payment Predictive",
        "list_name": "Default Outbound List"
      }
    ]
  }
}

 


Query

Search Date

From

To

Days

Call Type

User Name

Name

Flag

Status

 

Type Params Values Params Type
POST query [VALUE] Optional
POST search_date [VALUE] Optional
POST from [VALUE] Optional
POST to [VALUE] Optional
POST days [VALUE] Optional
POST call_type [VALUE] Optional
POST username [VALUE] Optional
POST name [VALUE] Optional
POST flag [VALUE] Optional
POST status [VALUE] Optional
POST Type search_lead Mandatory

Add Mass Leads

Use this API to bulk import leads to the system instead of manually entering them one by one.
PHP
<?php
$postFelds = "token=$token&type=add_leads";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "msg": "Thanks! Our Support team will contact you soon"
  }
}

 


Campaign Id
Required

List Id
Required

User
Required

Pass
Required

API Key
Required

Dial Now

Phone Number
Required

First Name

Last Name

Account Id

State

TimeZone

Phone Type
Required

 

Type Params Values Params Type
POST Type add_leads Mandatory
POST Campaign_id [VALUE] Mandatory
POST List_id [VALUE] Mandatory
POST user [VALUE] Mandatory
POST pass [VALUE] Mandatory
POST leads *ARRAY Mandatory
POST Api_key [VALUE] Mandatory
POST dial_now Y/N Optional def:N
POST Phone_number [VALUE] Mandatory
POST First_name [VALUE] Optional
POST Last_name [VALUE] Optional
POST Account_id [VALUE] Optional
POST State [VALUE] Optional
POST timezone [VALUE] Optional
POST Phone_type [VALUE] Mandatory

Get Campaigns Lists

Use this API to view a list of all lists associated with a specified campaign returned in sorted order, with the most recently added lists appearing first.
PHP
<?php
$postFelds = "token=$token&type=get_campaign_lists";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "key": "[value]",
    "success": "[value]",
    "error": "[value]",
    "campaign_lists": [
      {
        "list_id": "[value]",
        "list_name": "[value]",
        "list_description": "[value]",
        "lead_count": "[value]",
        "active": "[value]",
        "list_lastcalldate": "[value]",
        "campaign_id": "[value]",
        "campaign_name": "[value]"
      },
      {
        "list_id": "[value]",
        "list_name": "[value]",
        "list_description": "[value]",
        "lead_count": "[value]",
        "active": "[value]",
        "list_lastcalldate": "[value]",
        "campaign_id": "[value]",
        "campaign_name": "[value]"
      },
      {
        "list_id": "[value]",
        "list_name": "[value]",
        "list_description": "[value]",
        "lead_count": "[value]",
        "active": "[value]",
        "list_lastcalldate": "[value]",
        "campaign_id": "[value]",
        "campaign_name": "[value]"
      },
      {
        "list_id": "[value]",
        "list_name": "[value]",
        "list_description": "[value]",
        "lead_count": "[value]",
        "active": "[value]",
        "list_lastcalldate": "[value]",
        "campaign_id": "[value]",
        "campaign_name": "[value]"
      }
    ]
  }
}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Optional
POST type get_campaign_lists Mandatory

Upload File

Use this API to import records into the DCDial system from a CSV file or XSL spreadsheet.
PHP
$data['data'] = new CURLFile([FILE-PATH],'text/csv',[FILENAME]);
$data['type'] = 'upload_list';
$data['token'] = [TOKEN];
$options=[
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_POSTFIELDS => $data,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_HTTPHEADER => ['Content-Type: multipart/form-data']
    ];
	
$apiUrl = 'https://api.dcdial.com/api/';	
$ch = curl_init($apiUrl);
curl_setopt_array($ch, $options);
$result=curl_exec($ch);
curl_close($ch);

 

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": [],
    "error": [],
   "message":[]
}

 

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST format [VALUE] Mandatory
POST file_type [csv] Optional
POST token [VALUE] Mandatory
POST data [FILE] Mandatory

Get Results

Use this API to collect the outbound dialer call results. Receive the call results after entering a lead's phone number.
PHP
<?php
$postFelds = "token=$token&type=get_results";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "error": "",
    "results": [
      {
        "lead_id": "[VALUE]",
        "phone_number": "[VALUE]",
        "status": "N",
        "call_length": "[VALUE]",
        "account_id": "[VALUE]",
        "phone_type": "[VALUE]",
        "campaign_id": "[VALUE]",
        "called_count": "[VALUE]",
        "first_name": "[VALUE]",
        "last_name": "[VALUE]",
        "call_date": "[VALUE]KJ"
      }
    ]
  }
}

 

 

Type Params Values Params Type
POST phone_number [VALUE] Mandatory
POST limit [VALUE] Optional
POST token [VALUE] Mandatory
POST type get_results Mandatory
PHP
    <?php
    $postFelds = "token=$token&type=get_payment_link";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   $result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{"response":
     {"payment_link":"dclab.me/abc","account_id":"00000","success":"[1 or 0]"}
}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST account_id [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST amount [VALUE] Optional
POST editable [VALUE] Optional

Statistic APIs

Campaign Statistics

Use this API to retrieve the operational statistics on a specified campaign in real-time while running. Campaign statistics are updated in real-time, indicating the most recent performance of the campaign.
PHP
<?php
$postFelds = "token=$token&type=campaign_summary";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "key": "[value]",
    "pace_method": "[value]",
    "pace_tempo": "[value]",
    "intensity_throttle": "[value]",
    "agent_level": "[value]",
    "caller_id": "[value]",
    "campaign_script": "[value]",
    "recording": "[value]",
    "contact_schedule": "[value]",
    "total_leads": "[value]",
    "active_leads": "[value]",
    "remaining_leads": "[value]",
    "percentage_complete": "[value]",
    "answered_today": "[value]",
    "called_today": "[value]",
    "percentage_dropped": "[value]",
    "average_wrap_time": "[value]",
    "average_call_interval": "[value]",
    "average_talkoff_time": "[value]",
    "average_no_of_agents": "[value]",
    "active_calls": "[value]",
    "calls_ringings": "[value]",
    "calls_waiting": "[value]",
    "calls_in_ivr": "[value]",
    "total": "[value]",
    "ready": "[value]",
    "oncalls": "[value]",
    "wrappingup": "[value]",
    "paused": "[value]",
    "dead": "[value]",
    "active": "[value]",
    "display_status": "[value]",
    "scheduler_status": "[value]",
    "success": "1",
    "error": ""
  }
}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST type campaign_summary Mandatory

Get All Campaign Statistics

Use this API to retrieve the operational statistics on all the existing campaigns in real-time while the campaigns are running. Campaign statistics are updated in real-time, indicating the most recent performance of the campaigns.
PHP
<?php
$postFelds = "token=$token&type=get_all_stats";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
"response" : {
"success" : 1,
"error" : "",
"campaigns_list" : [{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "SMS",
"active" : "Y",
"display_status" : "PLAY",
"campaign_name" : "Customer Satisfaction Survey",
"campaign_id" : "cmpBrjO49OiQXhBC10311",
"campaign_type" : "7",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "BROADCAST",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Default Broadcast",
"campaign_id" : "cmpBroadcast10311",
"campaign_type" : "1",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "PREDICTIVE",
"active" : "Y",
"display_status" : "PLAY",
"campaign_name" : "Payment Predictive",
"campaign_id" : "cmpc4IZsWz1z77dC10311",
"campaign_type" : "5",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "25.00",
"pace_method" : "BROADCAST",
"active" : "Y",
"display_status" : "PLAY",
"campaign_name" : " Payment Broadcast ",
"campaign_id" : "cmpcZ8j3dJTJIrdC10311",
"campaign_type" : "1",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "SMS",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Business Loan Offer",
"campaign_id" : "cmpJI7Gi51RYZMdC10311",
"campaign_type" : "7",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "PREVIEW",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Default Preview",
"campaign_id" : "cmpManual10311",
"campaign_type" : "3",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "BROADCAST",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Payment Reminder Broadcast",
"campaign_id" : "cmppAaPmX6dAWiMC10311",
"campaign_type" : "1",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "PREDICTIVE",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Default Predictive",
"campaign_id" : "cmpPredictive10311",
"campaign_type" : "5",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "POWER",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Default Power",
"campaign_id" : "cmpRatio10311",
"campaign_type" : "4",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "SMS",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Default SMS",
"campaign_id" : "cmpSMS10311",
"campaign_type" : "7",
"scheduled_campaign" : "0"},{
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"percentage_complete" : "0.00",
"pace_method" : "SMS",
"active" : "N",
"display_status" : "STOP",
"campaign_name" : "Monthly Payment Reminder",
"campaign_id" : "cmpuXpoW6jjCLiSC10311",
"campaign_type" : "7",
"scheduled_campaign" : "0"}]}}

 

 


Campaign Id

Display Status

 

Type Params Values Params Type
POST campaign_id [VALUE] Optional
POST display_status [PLAY/STOP/PAUSE] Optional
POST type get_all_stats Mandatory

Get Graph Data

This API formulates the graph data in JSON. Data can be displayed then on any graph type.
PHP
    <?php
    $postFelds = "token=$token&type=get_graph_data";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "error": "",
    "graph_data": [
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      },
      {
        "dialed": "[value]",
        "delivered": "[value]",
        "drops": "[value]"
      }
    ]
  }
}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST Type get_graph_data Mandatory

Get Campaign Stats

Use this API to retrieve the relevant information on a specified campaign while the campaign is inactive. Campaign statistics indicate the overall performance of the campaign.
PHP
<?php
$postFelds = "token=$token&type=get_campaign_stats";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
"response" : {
"success" : 1,
"error" : "",
"campaigns_stats" : [{
"campaign_id" : "click",
"campaign_name" : "0",
"pace_method" : "0",
"pace_tempo" : "0",
"intensity_throttle" : "0",
"adaptive_dropped_percentage" : "NA",
"agent_level" : "0",
"caller_id" : "0",
"campaign_script" : "0",
"recording" : "0",
"scheduled_campaign" : "0",
"contact_schedule" : "0",
"total_leads" : "0",
"active_leads" : "0",
"remaining_leads" : "0",
"percentage_complete" : "0",
"answered_today" : "0",
"called_today" : "0",
"percentage_dropped" : "0",
"average_wrap_time" : "0",
"average_call_interval" : "0",
"average_talkoff_time" : "0",
"average_no_of_agents" : "0",
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"paused" : "0",
"dead" : "0",
"active" : "0",
"display_status" : "0",
"scheduler_status" : "0",
"connected_calls" : "0",
"total_calls" : "0",
"todays_minutes" : "0",
"todays_charge" : "0",
"mtd_minutes" : "0",
"mtd_charge" : "0",
"remaining_time" : "00:00:00",
"recycled" : "0",
"am_detection" : "NA",
"am_leave_message" : "NA",
"call_back_number" : "NA",
"transfer_queue" : "NA",
"human_answered_calls" : "0",
"answering_machine" : "0",
"transfers" : "0",
"sales" : "0"}],
"graph_data" : []}}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST Type get_campaign_stats Mandatory

Get All Graphs

Use this API to retrieve graph data that displays campaign statistics once you select a statistic (total time, total calls, percent calls, average time, or percent time) and an interval.
PHP
<?php
$postFelds = "token=$token&type=get_all_graphs";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": "",
    "outbound_graph": [
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      },
      {
        "dialed": "0",
        "delivered": "0",
        "drops": "0"
      }
    ],
    "agent_graph": [
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      },
      {
        "total": "0",
        "ready": "0",
        "oncalls": "0",
        "wrappingup": "0",
        "pausedcalls": "0",
        "deadcalls": "0"
      }
    ]
  }
}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST type get_all_graphs Mandatory

Get Dialer Usage

Use this API to retrieve dialer usage data. Data returned includes the current account balance and current usage.
PHP
<?php
$postFelds = "token=$token&type=get_usage";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "todays_minutes": "[value]",
    "todays_usage": "[value]",
    "mtd_minutes": "[value]",
    "mtd_usage": "[value]",
    "dynamic_balance": "[value]",
    "success": 1,
    "error": ""
  }
}

 


 

Type Params Values Params Type
POST type get_usage Mandatory

Get Dashboard Statistics

Use this API to retrieve the Dashboard statistics that summarize the overall campaign performance.
PHP
<?php
  $postFelds = "token=$token&type=get_dashboard_stats";
  $url = "https://api.dcdial.com/api/api.php";	
  $ch = curl_init();		
  curl_setopt($ch, CURLOPT_URL, $url);		
  curl_setopt($ch,CURLOPT_POST,1);	
  curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);		
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  $result = curl_exec($ch);				
  curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
"response" : {
"success" : 1,
"error" : "",
"dashboard_stats" : [{
"campaign_id" : "cmpc4IZsWz1z77dC10311",
"campaign_name" : "Payment Predictive",
"pace_method" : "PREDICTIVE",
"pace_tempo" : "1.0",
"intensity_throttle" : "0",
"adaptive_dropped_percentage" : "3%",
"agent_level" : "0",
"caller_id" : "4044102710",
"campaign_script" : "Default Script",
"recording" : "AS NEEDED",
"scheduled_campaign" : "0",
"contact_schedule" : "Default Customer Schedule",
"total_leads" : "4",
"active_leads" : "0",
"remaining_leads" : "4",
"percentage_complete" : "0.00",
"answered_today" : "1",
"called_today" : "1",
"percentage_dropped" : "0.00",
"average_wrap_time" : "111",
"average_call_interval" : "199",
"average_talkoff_time" : "0",
"average_no_of_agents" : "1",
"active_calls" : "0",
"calls_ringings" : "0",
"calls_waiting" : "0",
"calls_in_ivr" : "0",
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"paused" : "0",
"dead" : "0",
"active" : "0",
"display_status" : "PLAY",
"scheduler_status" : "0",
"connected_calls" : "0",
"total_calls" : "0",
"todays_minutes" : "0",
"todays_charge" : "0.00",
"mtd_minutes" : "0",
"mtd_charge" : "0.00",
"remaining_time" : "00:00:00",
"recycled" : "0",
"am_detection" : "NA",
"am_leave_message" : "EVERY CALL",
"call_back_number" : "4044102710",
"transfer_queue" : "NA",
"human_answered_calls" : "1",
"answering_machine" : "0",
"transfers" : "0",
"sales" : "0"}],
"calls_graph_data" : [{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "03:50:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "03:52:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "03:54:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "03:56:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "03:58:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:00:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:02:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:04:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:06:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:08:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:10:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:12:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:14:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:16:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:18:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:20:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:22:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:24:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:26:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:28:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:30:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:32:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:34:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:36:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:38:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:40:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:42:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:44:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:46:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:48:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:50:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:52:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:54:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:56:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "04:58:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:00:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:02:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:04:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:06:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:08:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:10:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:12:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:14:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:16:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:18:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:20:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:22:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:24:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:26:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:28:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:30:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:32:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:34:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:36:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:38:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:40:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:42:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:44:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:46:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:48:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:50:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:52:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:54:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:56:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "05:58:01"},{
"dialed" : "1",
"delivered" : "1",
"drops" : "0",
"datetime" : "06:00:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:02:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:04:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:06:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:08:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:10:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:12:02"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:14:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:16:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:18:01"},{
"dialed" : "0",
"delivered" : "0",
"drops" : "0",
"datetime" : "06:20:01"}],
"agent_graph_data" : [{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "03:50:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "03:52:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "03:54:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "03:56:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "03:58:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:00:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:02:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:04:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:06:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:08:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:10:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:12:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:14:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:16:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:18:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:20:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:22:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:24:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:26:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:28:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:30:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:32:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:34:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:36:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:38:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:40:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:42:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:44:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:46:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:48:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:50:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:52:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:54:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:56:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "04:58:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:00:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:02:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:04:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:06:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:08:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:10:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:12:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:14:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:16:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:18:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:20:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:22:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:24:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:26:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:28:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:30:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:32:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:34:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:36:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:38:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:40:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:42:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:44:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:46:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:48:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:50:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:52:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:54:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:56:01"},{
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "05:58:01"},{
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:00:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:02:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:04:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:06:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:08:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:10:01"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:12:02"},{
"total" : "0",
"ready" : "0",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:14:01"},{
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:16:01"},{
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:18:01"},{
"total" : "1",
"ready" : "1",
"oncalls" : "0",
"wrappingup" : "0",
"pausedcalls" : "0",
"deadcalls" : "0",
"datetime" : "06:20:01"}],
"lead_status_graph" : [{
"active_leads" : 0,
"remaining_leads" : 4}],
"call_status_graph" : [{
"active_calls" : 0,
"calls_ringings" : 0,
"calls_waiting" : 0,
"calls_in_ivr" : 0}]}}

 


Campaign Id
Required

 

Type Params Values Params Type
POST campaign_id [VALUE] Mandatory
POST type get_dashboard_stats Mandatory

Get All IVRs

Use this API to view a list of all IVRs in the system returned in sorted order, with the most recently added IVRs appearing first.
PHP
<?php
$postFelds = "token=$token&type=list_ivrs";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"success":1,"error":"","list_ivrs":[{"ivr_id":"grpAGENTDIRECT10311","ivr_name":"General Queue ","group_name":"General Queue ","next_agent_call":"longest_wait_time"},{"ivr_id":"quetpcKpwLyUr8eC10311","ivr_name":"Payment IVR Queue","group_name":"Payment IVR Queue","next_agent_call":"longest_wait_time"}]}}

 


 

Type Params Values Params Type
POST Type list_ivrs Mandatory

Add IVR

Use this API to create a new interactive voice response (IVR) and automate the call distribution by allowing customers to access information and find contacts via a prerecorded or TTS messages menu. Callers and call recipients can respond to prompts using the keypad.
PHP
<?php
$postFelds = "token=$token&type=add_ivr";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


IVR ID
Required

IVR Name
Required

 

Type Params Values Params Type
POST ivr_id [VALUE] Mandatory
POST ivr_name [VALUE] Mandatory
POST Type add_ivr Mandatory

Delete IVR

Use this API to permanently delete an IVR from the DCDial system.
PHP
<?php
$postFelds = "token=$token&type=delete_ivr";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request

 

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

 


IVR ID
Required

 

Type Params Values Params Type
POST ivr_id [VALUE] Mandatory
POST Type delete_ivr Mandatory

Get All Queues

Use this API to view a list of all queues in the system returned in sorted order, with the most recently added queues appearing first.
PHP
<?php
$postFelds = "token=$token&type=get_queues";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"success":1},{"error":""},{"queues_list":{"group_id":"grpAGENTDIRECT10311","group_name":"General Queue ","queue_priority":"99","active":"Y","call_time_id":"ccsDefault10","group_color":"Blue"},{"group_id":"quetpcKpwLyUr8eC10311","group_name":"Payment IVR Queue","queue_priority":"99","active":"Y","call_time_id":"ccsDefault10311","group_color":"Blue"}}

 


 

Type Params Values Params Type
POST Type get_queues Mandatory

Add Queue

Use this API to create a new call queue to enhance the customer's experience and better manage the inbound or outbound call volume.
PHP
<?php
$postFelds = "token=$token&type=add_queue";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


Group ID
Required

Group Name
Required

 

Type Params Values Params Type
POST group_id [VALUE] Mandatory
POST group_name [VALUE] Mandatory
POST Type add_queue Mandatory

Delete Queue

Use this API to permanently delete a queue from the DCDial system.
PHP
<?php
$postFelds = "token=$token&type=delete_queue";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


Group ID
Required

 

Type Params Values Params Type
POST group_id [VALUE] Mandatory
POST Type delete_queue Mandatory

User APIs

Change Password

Use this API to change a user's existing password.
PHP
<?php
$postFelds = "token=$token&type=change_password";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


Old Password
Required

New Password
Required

 

Type Params Values Params Type
POST oldpass [VALUE] Mandatory
POST newpass [VALUE] Mandatory
POST type change_password Mandatory

Get Profile

Use this API to view the user profile information, including contact information, email settings, and permissions.
PHP
<?php
$postFelds = "token=$token&type=get_profile";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "full_name": "[value]",
    "email": "[value]",
    "mobile_number": "[value]"
  }
}

 


 

Type Params Values Params Type
POST Type get_profile Mandatory

Update Profile

Use this API to update an existing user profile by setting the new values for the user's contact information, email settings, or permissions. Any parameters not provided will be left unchanged.
PHP
<?php
$postFelds = "token=$token&type=update_profile";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


Full Name
Required

Email
Required

Mobile Number
Required

 

Type Params Values Params Type
POST full_name [VALUE] Mandatory
POST Email [VALUE] Mandatory
POST mobile_number [VALUE] Mandatory
POST Type update_profile Mandatory

Check Permission

Use this API to retrieve a list of allowed and forbidden permissions for a specified user. Agent users may be granted only the agent interface permissions. All other users may be granted general permissions, admin portal permissions, and reports permissions.
PHP
<?php
$postFelds = "token=$token&type=check_permission";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": "1",
    "permission": ""
  }
}

 


Permission Type
Required

Module
Required

 

Type Params Values Params Type
POST perm_type [VALUE] Mandatory
POST module [VALUE] Mandatory
POST Type check_permission Mandatory

Notification APIs

Use this API to apply changes to the notification settings associated with an account.

Set Notifications

Use this API to apply changes to the notification settings associated with an account.
PHP
<?php
$postFelds = "token=$token&type=set_notifications";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "error": ""
  }
}

 


Campaign Started
Required

Campaign Stopped
Required

Campaign Paused
Required

campaign NoActiveLeads
Required

Campaign Completed
Required

List Add
Required

List ScrubReport
Required

Scheduler CapaignStarted
Required

Balance Below
Required

Alert Frequency
Required

Alert Method
Required

 

Type Params Values Params Type
POST Type set_notifications Mandatory
POST Campaign_started [0/1] Mandatory
POST Campaign_stopped [0/1] Mandatory
POST Campaign_paused [0/1] Mandatory
POST campaign_noActiveLeads [0/1] Mandatory
POST campaign_completed [0/1] Mandatory
POST list_add [0/1] Mandatory
POST list_scrubReport [0/1] Mandatory
POST scheduler_capaignStarted [0/1] Mandatory
POST balance_below 100/200/300/500/1000/2000/3000 Mandatory
POST alert_frequency 0/15/30/45/60 Mandatory
POST alert_method [VALUE] Mandatory

Get Notifications

PHP
<?php
$postFelds = "token=$token&type=get_notifications";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": [
    {
      "desc": "[value]",
      "date": "[value] ",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    },
    {
      "desc": "[value]",
      "date": "[value]",
      "item_id": "[value] "
    }
  ]
}

 


 

Type Params Values Params Type
POST Type get_notifications Mandatory

Clear Notifications

Use this API to mark the received notifications as read. Once you mark a notification as read, it will not pop up again but will still be available in the notification center.
PHP
<?php
$postFelds = "token=$token&type=clear_notifications";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
  • 200 OK
{
  "response": {
    "success": "1",
    "error": ""
  }
}

 


 

Type Params Values Params Type
POST type clear_notifications Mandatory

Get Notification Settings

Use this API to return the current DCDial settings for sending system notifications. Built-in system notifications alert users of important information.
PHP
<?php
$postFelds = "token=$token&type=get_notifications_settings";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "alert_frequency": "[value]",
    "campaign_completed": "[value]",
    "campaign_noActiveLeads": "[value]",
    "campaign_started": "[value]",
    "list_add": "[value]",
    "campaign_paused": "[value]",
    "scheduler_capaignStarted": "[value]",
    "list_scrubReport": "[value]",
    "campaign_stopped": "[value]",
    "success": "1",
    "error": ""
  }
}

 


 

Type Params Values Params Type
POST Type get_notifications_settings Mandatory

Client APIs

Create Payment Agreement

Use this API to generate a payment agreement and send an agreement link from the internal payment portal to a customer via email and/or SMS. The payment plan becomes active and starts processing payments once the customer agrees to the terms of agreement by digitally signing it.
PHP
    <?php
    $postFelds = "token=$token&type=create_payment_plan";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
   $result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{"response":
     {"agreement_link":"dclab.me/abc",agreement_id":12345,"account_id":"1234567","lead_id":"1234567","success":1,"message":"Payment plan created successfully"}}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST account_id [VALUE] Mandatory
POST billing_start_date [VALUE] Mandatory
POST total_payments [VALUE] Mandatory
POST amount [VALUE] Mandatory
POST payment_schedule [daily|weekly|biweekly|monthly|bimonthly|
quarterly|annually|biannually]
Mandatory
POST communication_method [sms|email|both] Mandatory
POST phone_number [VALUE] Mandatory
POST email [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST type create_payment_plan Mandatory

Get Agreement Doc

Use this API to retrieve the details of a payment agreement payment agreement previously created. The payment agreement document contains customer information, payment information, terms and conditions, and authorization. Supply the unique agreement ID, and DCDial will return the corresponding agreement information.
PHP
    <?php
    $postFelds = "token=$token&type=get_agreement_doc";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{"response":
     {"agreement_content":"[base64 encoded content]","message":"[response info]","ip_address":"[IP Address value]","success":"[1|0]"}
}
Type Params Values Params Type
POST token [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST agreement_id [VALUE] Mandatory
POST type get_agreement_doc Mandatory

Cancel Agreement

Use this API to immediately cancel a payment agreement and its associated payment schedule using the Agreement ID. The customer will receive an email notification informing them about a canceled agreement.
PHP
    <?php
    $postFelds = "token=$token&type=cancel_payment_plan";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
   ?>

 

  • 200 OK
  • 400 Bad Request
{"response":
     {"agreement_id":"12345","message":"","success":"[1|0]"}
}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST agreement_id [VALUE] Mandatory
POST type cancel_payment_plan Mandatory

Add Manual Payment

Use this API to manually capture the transaction processed outside of the DCDial system, and settle the payment amount to the customer's account.
PHP
    <?php
    $postFields = "token=$token&type=add_payment";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"success":"1|0","PaymentID","XXXXX","error":"[IF ANY]"}}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST account_id [VALUE] Mandatory
POST payment_date [VALUE] Mandatory
POST payment_method [WT|CASH|CHECK|CC|ACH|PP] Mandatory
POST amount [VALUE] Mandatory
POST payment_note [VALUE] Optional
POST company_id [VALUE] Mandatory
POST type add_payment Mandatory

Void Payment

Use this API to retrieve and void individual charges identified by a transaction Order ID and change a transaction status to 'Voided'. The 'refunded' reason allows you to refund a previously created charge but not yet refunded. The amount will be refunded to the original payment method used to make a payment.
PHP
    <?php
    $postFields = "token=$token&type=remove_payment";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"success":1|0,"error":""}}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST account_id [VALUE] Mandatory
POST reason [refunded|NFS|charged back|other] Mandatory
POST payment_id [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST type remove_payment Mandatory

Process Payment

Use this API to process one-time and recurring credit card and ACH payments using the Account ID. A valid payment processor must be added to DCDial before processing payment.
PHP
    <?php
    $postFields = "type=charge_customer";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"approved":1|0,"transaction_id":"XXXXXXXXXXX","message":"[information]","invoice_id":XXXXXX}}

 

Type Params Values Params Type
POST type charge_customer Mandatory
POST account_id [VALUE] Mandatory
POST amount [VALUE] Mandatory
POST payment_method [CC|ACH] Mandatory
POST phone_number [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST agent [VALUE] Mandatory
POST description [VALUE] Optional
POST currency_code [USD|GBP] Default USD
POST cc_number [VALUE] Mandatory for CC
POST cc_expiry_date [VALUE] Mandatory for CC
POST cc_cvv [VALUE] Mandatory for CC
POST card_holder_name [VALUE] Mandatory for CC
POST routing_number [VALUE] Mandatory for ACH
POST bank_account_number [VALUE] Mandatory for ACH
POST bank_name [VALUE] Mandatory for ACH
POST account_holder_name [VALUE] Mandatory for ACH
POST first_name [VALUE] Mandatory
POST last_name [VALUE] Mandatory
POST address [VALUE] Optional
POST city [VALUE] Optional
POST zipcode [VALUE] Optional
POST isrecurring [Y|N] Default N
POST start_date [VALUE] Mandatory for recurring
POST total_payments [VALUE] Mandatory for recurring
POST billing_address1 [VALUE] Optional
POST billing_address2 [VALUE] Optional
POST billing_city [VALUE] Optional
POST billing_zipcode [VALUE] Optional
POST billing_state [VALUE] Optional
POST billing_country [VALUE] Optional
POST email_address [VALUE] Optional

Agreement Details

Use this API to retrieve the details of a payment agreement created previously. The payment agreement document contains customer information and payment schedule information.
PHP
    <?php
    $postFields = "type=agreement_details";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
    ?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"first_name":"AAAAA","last_name":"AAAA","email":"[email protected]","phone_number":"NNN...","account_id":"ABC123","start_date":"YYYY-MM-DD","payment_frequency":"daily|weekly....","amount":"FF","total_payments":"NNN","remaining_payments":"NNN","next_billing_date":"YYYY-MM-DD","exclude_holidays":"N|Y","agreement_id":"NNN","initial_balance":"DN","remaining_balance":"DN","agent":"[email protected]","payment_method":"CC|ACH|PP","cc_4digit":"NNNN","last_payment_status":"Completed","schedule_id":"NNN","voided_other_payments":NNN,"voided_chargedback_payments":NNN,"voided_nsf_payments":NNN,"voided_refunded_payments":NNN,"successful_payments":"NNN","failed_payments":"NNN,N",agreement_status":"Completed|Active|OPENED|Pending|Cancelled"}}

 

Type Params Values Params Type
POST type agreement_details Mandatory
POST account_id [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST agreement_id [VALUE] Optional

Send Text Message

Use this API to send an individual text message to a specified phone number. You can add text and dynamic fields for the message content or use a preset SMS template.
PHP
 <?php
    $postFelds = "token=$token&type=send_text_message";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
 ?>

 

  • 200 OK
  • 400 Bad Request
{"response":
     {"success":"[0|1]","message":"00000"}
}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST phone_number [VALUE] Mandatory
POST caller_id [VALUE] Mandatory
POST use_template [Y|N] Mandatory
POST sms_text [VALUE] Mandatory
POST type send_text_message Mandatory

Retrieve sent messages

Use this API to view a list of all SMS sent to customers filtered by the date range.
PHP

 

 <?php
    $postFelds = "token=$token&type=retrieve_text_message";
    $url = "https://api.dcdial.com/api/";
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch,CURLOPT_POST,1);
    curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);
    curl_close($ch);
 ?>

 

  • 200 OK
  • 400 Bad Request
{"response":{"company_id":"NNNNN","start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD","request_time_utc":"YYYY-MM-DD HH:MM:SS",{[messages]}}

 

Type Params Values Params Type
POST token [VALUE] Mandatory
POST company_id [VALUE] Mandatory
POST start_date [VALUE] Mandatory
POST end_date [VALUE] Mandatory
POST orderby [ASC/DESC]  Optional (Default: ASC)
POST offset INT VALUE  Optional (Default: 0)
POST limit INT VALUE  Optional (Default:50)
POST type retrieve_sent_messages  Mandatory

Transaction

A callback to send information about a transaction through a designated URL.

The following fields are posted back to the web-hook registered in your account settings. Data is sent in json or xml format based on your web-hook preferences.

Field Data Type
transaction_id String
amount Decimal
first_name String
last_name String
phone_number Number
card_last_4_digits Number
invoice Number
is_subscription [Y|N]
customerid Number
gateway_error String
MerchantName String
AccountID String
StartDate DateTime
PaymentFrequency String
PaymentAmount Decimal
TotalPayments Number
RemainingPayments Number
currunt_billing_count Number
exclude_holidays [Y|N]
AgreementID Number
PaymentEndDate Date
CurrentRecurringPaymentCount String
apiKey String
AuthId String

SMS

The following fields are posted back to the web-hook registered in your account settings. Data is sent in json or xml format based on your web-hook preferences.

Field Data Type
caller_id String
phone_number Number
message_time DateTime
company_id Number
customer_reply Text

Get Content

PHP
<?php
$postFelds = "token=$token&type=get_content";
$url = "https://api.dcdial.com/api/";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch,CURLOPT_POST,1);
curl_setopt($ch,CURLOPT_POSTFIELDS,$postFields);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);
curl_close($ch);
?>

 

  • 200 OK
  • 400 Bad Request
{
  "response": {
    "success": 1,
    "help_text": "[value]",
    "aboutus_text": "[value]",
    "privacy_policy_text": "[value]",
    "tos_text": "[value]",
    "faq_text": "[value]",
    "support_text": "[value]",
    "phone_number": "[value]",
    "email_address": "[value]"
  }
}

 


 

Type Params Values Params Type
POST Type get_content Mandatory

Glossary

Glossary

Status Codes

All status codes are standard HTTP status codes. The below ones are used in this API.

2XX – Success of some kind
4XX – Error occurred in client’s part

 

 

Status Code Description
200 OK
201 Created
202 Accepted (Request accepted, and queued for execution)
400 Bad request
401 Authentication failure
403 Forbidden
404 Resource not found
405 Method Not Allowed
409 Conflict
412 Precondition Failed
413 Request Entity Too Large
500 Internal Server Error
501 Not Implemented
503 Service Unavailable

Conventions

  • Client – Client application.
  • Status – HTTP status code of response.
  • All the possible responses are listed under ‘Responses’ for each method. Only one of them is issued per request server.
  • All response are in JSON format.
  • All request parameters are mandatory unless explicitly marked as [optional]
  • The type of values accepted for a request parameter are shown the the values column like this