Get a list of available building block IDs
Use the Get Building Block IDs API to 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 List
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 |
Using this API
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response [
<!ELEMENT response (result,result_description,data)>
<!ELEMENT result (#PCDATA)>
<!ELEMENT result_description (#PCDATA)>
<!ELEMENT data (app+)>
<!ELEMENT app (building_block+)>
<!ELEMENT building_block (#PCDATA)> ]>
<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>