Use the Add-Ons List API to list add-ons
The Add-Ons List API is used to list the available and in-use add-ons within a DialogTech account.
Base URL for Add-Ons List
Parameter List
Parameter | Required | Accepts | Max Length | Notes | Usage |
---|---|---|---|---|---|
action | Yes | String: addons.list | n/a | Only accepts addons.list to list add-ons | Defines the API Call as "Add-Ons List" type |
access_key | Yes | String | n/a | Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
secret_access_key | Yes | String | n/a | Secret Access Key from the Key Manager within a DialogTech account | Credentials used for access to the API for a particular DialogTech account |
Using this API
These code examples are meant to show a basic method of accessing DialogTech's Add-Ons List API.
<?php
/*
Add-Ons List
This example will list the various
add-ons associated with a DialogTech account
*/
// Create cURL resource
$ch = curl_init();
$baseuri = "https://secure.dialogtech.com/ibp_api.php?";
// API Specific Static Parameters
$action = "addons.list";
// Required User Parameters To Request the API
$access_key = "foo";
$secret_access_key = "bar";
// Construct the full URL
$full_url = $baseuri . "&action=" . $action .
"&access_key=" . $access_key .
"&secret_access_key=" . $secret_access_key;
// Set the URL
curl_setopt($ch, CURLOPT_URL, $full_url);
// Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// Sets the $output variable to the result of the curl
$output = curl_exec($ch);
// Close curl resource to free up system resources
curl_close($ch);
// Echo the XML response to the page
echo $output;
?>
curl -X ""
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response [
<!ELEMENT response (result,result_description,data)>
<!ELEMENT result (#PCDATA)>
<!ELEMENT result_description (#PCDATA)>
<!ELEMENT data (addon+)>
<!ELEMENT addon (special_flag,limit_item_name,promo_footnote,purchase_price,max_qty_purchase,item_id,included_qty,start_date,end_date,non_recurring_charge,total_qty,in_use)>]>
<response>
<result>success</result>
<result_description>
</result_description>
<data>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Smart Click-to-Calls</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>1000</max_qty_purchase>
<item_id>1</item_id>
<included_qty>25</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>25</total_qty>
<in_use>2</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Voice Mailboxes</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>50</max_qty_purchase>
<item_id>2</item_id>
<included_qty>10</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>10</total_qty>
<in_use>2</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Tollfree Numbers</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>200</max_qty_purchase>
<item_id>3</item_id>
<included_qty>3</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>198</total_qty>
<in_use>36</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Smart Voice Broadcast Ports</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>30</max_qty_purchase>
<item_id>4</item_id>
<included_qty>9</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>9</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Basic Voice Broadcast Ports</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>50</max_qty_purchase>
<item_id>5</item_id>
<included_qty>25</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>75</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Local Number</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>500</max_qty_purchase>
<item_id>6</item_id>
<included_qty>3</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>194</total_qty>
<in_use>79</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Simultaneous Find Me Ports</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>12</max_qty_purchase>
<item_id>8</item_id>
<included_qty>3</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>10</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Queue Slot</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>50</max_qty_purchase>
<item_id>9</item_id>
<included_qty>5</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>33</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Queues</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>25</max_qty_purchase>
<item_id>10</item_id>
<included_qty>5</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>8</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Campaign Guest Logins</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>25</max_qty_purchase>
<item_id>14</item_id>
<included_qty>1</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>1</total_qty>
<in_use>1</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>Canadian Local Number</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>100</max_qty_purchase>
<item_id>17</item_id>
<included_qty>0</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>0</total_qty>
<in_use>0</in_use>
</addon>
<addon>
<special_flag>0</special_flag>
<limit_item_name>True 800 Numbers</limit_item_name>
<promo_footnote>
</promo_footnote>
<purchase_price>0.00</purchase_price>
<max_qty_purchase>100</max_qty_purchase>
<item_id>18</item_id>
<included_qty>0</included_qty>
<start_date>0000-00-00 00:00:00</start_date>
<end_date>0000-00-00 00:00:00</end_date>
<non_recurring_charge>0.00</non_recurring_charge>
<total_qty>0</total_qty>
<in_use>0</in_use>
</addon>
</data>
</response>
Rates shown in example response are subject to change