Getting Started with Teleoh™ Developer

 Home / Teleoh™ Cloud XML Docs / Getting Started

Getting started with Teleoh™ Developer

Teleoh™ enables developers to build communication applications or expand their existing communications platform with any scripting language. There are two main parts to Teleoh™ Developer you'll need to understand before getting started, they are Teleoh™ XML and the Teleoh™ RESTful API.


What is Teleoh™ XML?

Teleoh™ XML is how you give instructions to Teleoh™ and tell it what you want it to do, in other words, Teleoh™ XML is your call flow. A call flow is a road map to how calls will be handled from the moment they enter the phone system to the end of the call. Call flows can be used to handle even the most complex call scenarios. In more simple terms, Teleoh™ XML is simply properly formatted XML that Teleoh™ can understand.

When inbound calls are received on your behalf Teleoh™ needs to know how you wish to handle the call (connect it to a phone number, play an mp3 file to the caller, put the caller in a conference room, etc). Inbound calls are described as calls entering the HEG or Teleoh™ network. Have a look at the diagram below for a better understanding of how inbound calls are handled by Teleoh™ and how Teleoh™ XML is used to direct the call flow.



Call Flow Diagram - Getting Started with Teleoh™

Ready to give it a try?

We've put together a few step by step guides to help you get started. If your new to Teleoh™ or voice API's we highly suggest following one of our quick start guides before continuing with this tutorial.


What is the Teleoh™ RESTful API?

The Teleoh™ API serves two basic purposes. First, it enables developers to manage core tools. With the Teleoh™ API you can do everything you can do from the Teleoh™ Developer portal programmatically, including Creating Applications, Managing your SIP Endpoints, Viewing Call History, and more.

Second, the API allows you to control calls in real-time while they are taking place. Some of the more popular call control functions are Originate - Initiates a new outbound call, Call Transfer, Listing Members in a Conference Room, Hanging up a Call, and many more.

Originate API - Getting Started with Teleoh™

Ready to give it a try?

Copy the code below into a PHP file on your web server
and then visit the file in your browser to make your first automated call.


<?
/*
Place a automated call with the Teleoh™ RESTful API Example Script.
You need a FREE Teleoh account: http://teleoh.com/account/ and your API credentials
*/

## Required
$API_USER_ID = ''; //Put your API User ID here
$API_KEY = ''; //Put your API Key here
$CallTo = ''; //The number to call with country code (Example: 14692145044)
$caller_id_number = ''; //The number you want to show on the caller ID

## Optional
$NewUrl = rawurlencode('http://teleoh.com/ExampleCode/api_test.xml'); //URL to send the call to after it is answerd, this URL should return Teleoh™ XML. No need to change for testing!
$NewUrlMethod = 'GET'; //The method used to change the NewUrl
$callbackUrl = rawurlencode(''); //Optional, not needed for initial testing.

//Create the URL
$api_url = 'http://voiceapi.cloud/API/xml/Call/Originate?';
$params = "API_USER_ID=$API_USER_ID&API_KEY=$API_KEY&CallTo=$CallTo&caller_id_number=$caller_id_number&callbackUrl=$callbackUrl&NewUrl=$NewUrl&NewUrlMethod=$NewUrlMethod";
$teleoh_url = ($api_url . $params);

//Call the URL using GET
$responce = file_get_contents($teleoh_url);

//Convert the results to SimpleXML so PHP can read it easily
$xml = simplexml_load_string($responce);

//Check for any errors, if there are any the script ends here.
if ($xml->error != "" || $responce == "") {
echo 'There was an error:' . $xml->error;
exit;
}

//Get the new call_uuid and other information from Teleoh™
$call_uuid = $xml->call->call_uuid;
echo "Call Originated to $CallTo. The new UUID is $call_uuid";