{"_id":"5908c149ed5f240f0041e2c1","githubsync":"","category":{"_id":"590829c7ade4172d006a87b8","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:40:07.955Z","from_sync":false,"order":1,"slug":"administration-apis","title":"Administration APIs"},"project":"558d9c32beb7c719007f6319","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"58cadf93d223510f005d27db","parentDoc":null,"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-02T17:26:33.901Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":24,"body":"[block:api-header]\n{\n  \"title\": \"Use the Add-Ons List API to list add-ons\"\n}\n[/block]\nThe Add-Ons List API is used to list the available and in-use add-ons within a DialogTech account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Add-Ons List\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **addons.list**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **addons.list** to list add-ons\",\n    \"0-5\": \"Defines the API Call as \\\"Add-Ons List\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\"\n  },\n  \"cols\": 6,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's Add-Ons List API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n  /*\\n    Add-Ons List\\n    This example will list the various\\n    add-ons associated with a DialogTech account\\n  */\\n\\n  // Create cURL resource\\n  $ch = curl_init(); \\n  $baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n  // API Specific Static Parameters\\n  $action = \\\"addons.list\\\";\\n\\n  // Required User Parameters To Request the API\\n  $access_key = \\\"foo\\\";\\n  $secret_access_key = \\\"bar\\\";\\n  \\n  // Construct the full URL\\n  $full_url = $baseuri . \\\"&action=\\\" . $action .\\n    \\\"&access_key=\\\" . $access_key .\\n    \\\"&secret_access_key=\\\" . $secret_access_key;\\n\\n\\n  // Set the URL\\n  curl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n  // Sets the $output variable to the result of the curl\\n  $output = curl_exec($ch);\\n\\n  // Close curl resource to free up system resources\\n  curl_close($ch);\\n\\n  // Echo the XML response to the page\\n  echo $output;\\n?>\",\n      \"language\": \"text\",\n      \"name\": \"PHP Example\"\n    },\n    {\n      \"code\": \"curl -X \\\"\\\"\",\n      \"language\": \"text\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n<!ELEMENT response (result,result_description,data)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n<!ELEMENT data (addon+)>\\n<!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)>]>\\n<response>\\n\\t<result>success</result>\\n\\t<result_description>\\n</result_description>\\n\\t<data>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Smart Click-to-Calls</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>1000</max_qty_purchase>\\n\\t\\t\\t<item_id>1</item_id>\\n\\t\\t\\t<included_qty>25</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>25</total_qty>\\n\\t\\t\\t<in_use>2</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Voice Mailboxes</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>50</max_qty_purchase>\\n\\t\\t\\t<item_id>2</item_id>\\n\\t\\t\\t<included_qty>10</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>10</total_qty>\\n\\t\\t\\t<in_use>2</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Tollfree Numbers</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>200</max_qty_purchase>\\n\\t\\t\\t<item_id>3</item_id>\\n\\t\\t\\t<included_qty>3</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>198</total_qty>\\n\\t\\t\\t<in_use>36</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Smart Voice Broadcast Ports</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>30</max_qty_purchase>\\n\\t\\t\\t<item_id>4</item_id>\\n\\t\\t\\t<included_qty>9</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>9</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Basic Voice Broadcast Ports</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>50</max_qty_purchase>\\n\\t\\t\\t<item_id>5</item_id>\\n\\t\\t\\t<included_qty>25</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>75</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Local Number</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>500</max_qty_purchase>\\n\\t\\t\\t<item_id>6</item_id>\\n\\t\\t\\t<included_qty>3</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>194</total_qty>\\n\\t\\t\\t<in_use>79</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Simultaneous Find Me Ports</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>12</max_qty_purchase>\\n\\t\\t\\t<item_id>8</item_id>\\n\\t\\t\\t<included_qty>3</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>10</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Queue Slot</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>50</max_qty_purchase>\\n\\t\\t\\t<item_id>9</item_id>\\n\\t\\t\\t<included_qty>5</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>33</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Queues</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>25</max_qty_purchase>\\n\\t\\t\\t<item_id>10</item_id>\\n\\t\\t\\t<included_qty>5</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>8</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Campaign Guest Logins</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>25</max_qty_purchase>\\n\\t\\t\\t<item_id>14</item_id>\\n\\t\\t\\t<included_qty>1</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>1</total_qty>\\n\\t\\t\\t<in_use>1</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>Canadian Local Number</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>100</max_qty_purchase>\\n\\t\\t\\t<item_id>17</item_id>\\n\\t\\t\\t<included_qty>0</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>0</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t\\t<addon>\\n\\t\\t\\t<special_flag>0</special_flag>\\n\\t\\t\\t<limit_item_name>True 800 Numbers</limit_item_name>\\n\\t\\t\\t<promo_footnote>\\n</promo_footnote>\\n\\t\\t\\t<purchase_price>0.00</purchase_price>\\n\\t\\t\\t<max_qty_purchase>100</max_qty_purchase>\\n\\t\\t\\t<item_id>18</item_id>\\n\\t\\t\\t<included_qty>0</included_qty>\\n\\t\\t\\t<start_date>0000-00-00 00:00:00</start_date>\\n\\t\\t\\t<end_date>0000-00-00 00:00:00</end_date>\\n\\t\\t\\t<non_recurring_charge>0.00</non_recurring_charge>\\n\\t\\t\\t<total_qty>0</total_qty>\\n\\t\\t\\t<in_use>0</in_use>\\n\\t\\t</addon>\\n\\t</data>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]\n*Rates shown in example response are subject to change*","excerpt":"","slug":"add-ons-list","type":"basic","title":"Add-Ons List"}