{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Get Building Block IDs","type":"basic","slug":"building-block-ids","excerpt":"Get a list of available building block IDs","body":"[block:api-header]\n{\n \"title\": \"Use the Get Building Block IDs API to get a list of available building block IDs\"\n}\n[/block]\nUse the Get Building Block IDs API to get a list of available building block IDs from within a DialogTech account\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Base URL for Get Building Block IDs\",\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: **general.buildingblockids**\",\n \"0-3\": \"n/a\",\n \"0-4\": \"Only accepts **general.buildingblockids** to get a list of available building block IDs\",\n \"0-5\": \"Defines the API Call as \\\"Get Building Block IDs\\\" 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 Get Building Block IDs API.\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?php\\n /*\\n Get Building Block IDs EX:\\n This example will pull all available\\n building block IDs from within a \\n 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 = \\\"general.buildingblockids\\\";\\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 // 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 (app+)>\\n<!ELEMENT app (building_block+)>\\n<!ELEMENT building_block (#PCDATA)> ]>\\n<response>\\n\\t<result>success</result>\\n\\t<result_description>List follows</result_description>\\n\\t<data>\\n\\t\\t<app type=\\\"vr\\\">\\n\\t\\t\\t<building_block id=\\\"43352463\\\">Primary VR</building_block>\\n\\t\\t\\t<building_block id=\\\"69383127\\\">Support VR</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"findme\\\">\\n\\t\\t\\t<building_block id=\\\"626510\\\">Dedicated NewBiz Team</building_block>\\n\\t\\t\\t<building_block id=\\\"697940\\\">Support Team</building_block>\\n\\t\\t\\t<building_block id=\\\"721353\\\">Finance</building_block>\\n\\t\\t\\t<building_block id=\\\"977755\\\">Support Escalation</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"vmail\\\">\\n\\t\\t\\t<building_block id=\\\"320029\\\">Support Voicemail</building_block>\\n\\t\\t\\t<building_block id=\\\"474829\\\">Sales Calls VM</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"survo\\\">\\n\\t\\t\\t<building_block id=\\\"2529188\\\">CustSat Survey 1</building_block>\\n\\t\\t\\t<building_block id=\\\"3486023\\\">CustSat Survey 2</building_block>\\n\\t\\t\\t<building_block id=\\\"3860988\\\">SalesQualify 1</building_block>\\n\\t\\t\\t<building_block id=\\\"4148669\\\">SalesQualify 2</building_block>\\n\\t\\t\\t<building_block id=\\\"7060491\\\">Support PagerDuty</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"ivr\\\">\\n\\t\\t\\t<building_block id=\\\"4470422\\\">Outbound - Step1</building_block>\\n\\t\\t\\t<building_block id=\\\"5992843\\\">Outbound - Step2</building_block>\\n\\t\\t\\t<building_block id=\\\"7051345\\\">Outbound - Success</building_block>\\n\\t\\t\\t<building_block id=\\\"8345396\\\">Outbound - Failure</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"clickto\\\">\\n\\t\\t\\t<building_block id=\\\"978496\\\">Website Clickto</building_block>\\n\\t\\t\\t<building_block id=\\\"989628\\\">Outbound Support Clickto</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"group\\\">\\n\\t\\t\\t<building_block id=\\\"187124\\\">SCRUM Group</building_block>\\n\\t\\t</app>\\n\\t\\t<app type=\\\"locator\\\">\\n\\t\\t\\t<building_block id=\\\"11137\\\">Illinois Locator</building_block>\\n\\t\\t\\t<building_block id=\\\"13143\\\">Ohio Locator</building_block>\\n\\t\\t</app>\\n\\t</data>\\n</response>\",\n \"language\": \"xml\",\n \"name\": \"xml\"\n }\n ]\n}\n[/block]","updates":[],"order":27,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"590b7531030acd0f00f06ab7","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Administration APIs","slug":"administration-apis","order":1,"from_sync":false,"reference":false,"_id":"590829c7ade4172d006a87b8","createdAt":"2017-05-02T06:40:07.955Z","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c"},"parentDoc":null,"user":"58cadf93d223510f005d27db","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1","5f6cf225ba56a40011bff62d","5f970e8b7617eb041ae758bb","602adb88243fbc0056918566","602adbb91828a600535980c4"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":23},"__v":0,"createdAt":"2017-05-04T18:38:41.783Z","githubsync":"","project":"558d9c32beb7c719007f6319"}
Get Building Block IDs
Get a list of available building block IDs
Use the Get Building Block IDs API to get a list of available building block IDs from within a DialogTech account
Base URL for Get Building Block IDs
Parameter
Required
Accepts
Max Length
Notes
Usage
action
Yes
String: general.buildingblockids
n/a
Only accepts general.buildingblockids to get a list of available building block IDs
Defines the API Call as "Get Building Block IDs" 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
These code examples are meant to show a basic method of accessing DialogTech's Get Building Block IDs API.
<?php
/*
Get Building Block IDs EX:
This example will pull all available
building block IDs from within a
DialogTech account
*/
// Create cURL resource
$ch = curl_init();
$baseuri = "https://secure.dialogtech.com/ibp_api.php?";
// API Specific Static Parameters
$action = "general.buildingblockids";
// 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
<response>
<result>success</result>
<result_description>List follows</result_description>
<data>
<app type="vr">
<building_block id="43352463">Primary VR</building_block>
<building_block id="69383127">Support VR</building_block>
</app>
<app type="findme">
<building_block id="626510">Dedicated NewBiz Team</building_block>
<building_block id="697940">Support Team</building_block>
<building_block id="721353">Finance</building_block>
<building_block id="977755">Support Escalation</building_block>
</app>
<app type="vmail">
<building_block id="320029">Support Voicemail</building_block>
<building_block id="474829">Sales Calls VM</building_block>
</app>
<app type="survo">
<building_block id="2529188">CustSat Survey 1</building_block>
<building_block id="3486023">CustSat Survey 2</building_block>
<building_block id="3860988">SalesQualify 1</building_block>
<building_block id="4148669">SalesQualify 2</building_block>
<building_block id="7060491">Support PagerDuty</building_block>
</app>
<app type="ivr">
<building_block id="4470422">Outbound - Step1</building_block>
<building_block id="5992843">Outbound - Step2</building_block>
<building_block id="7051345">Outbound - Success</building_block>
<building_block id="8345396">Outbound - Failure</building_block>
</app>
<app type="clickto">
<building_block id="978496">Website Clickto</building_block>
<building_block id="989628">Outbound Support Clickto</building_block>
</app>
<app type="group">
<building_block id="187124">SCRUM Group</building_block>
</app>
<app type="locator">
<building_block id="11137">Illinois Locator</building_block>
<building_block id="13143">Ohio Locator</building_block>
</app>
</data>
</response>