DeveloperGarden is the name for the "Open Development services" of the German Telekom. The "Open Development services" are a set of SOAP API Services.
The family of Zend_Service_DeveloperGarden components provides a
clean and simple interface to the DeveloperGarden API and additionally
offers functionality to improve handling and performance.
BaseUserService: Class to manage API quota and user accounting details.
IpLocation: Locale the given IP and returns geo coordinates. Works only with IPs allocated in the network of the german telekom.
LocalSearch: Allows you to search with options nearby or around a given geo coordinate or city.
SendSms: Send a Sms or Flash Sms to a given number.
SmsValidation: You can validate a number to use it with SendSms for also supply a back channel.
VoiceCall: Initiates a call between two numbers.
ConferenceCall: You can configure a whole conference room with participants for an adhoc conference or you can also schedule your conference.
The backend SOAP API is documented here.
Before you can start using the DeveloperGarden API, you must first sign up for an account.
With the DeveloperGarden API you have the possibility to choose 3 different environments to work on.
production: In Production environement you have to pay for calls, sms and other payable services.
sandbox: In the Sandbox mode you can use the same features with some limitations like in the production just without to pay for them. Normally during development you can test your application.
mock: The Mock environment allows you to build your application and have results but you don not initiate any action on the API side.
For every environment and service are some special features (options) available for testing. Please look here for details.
You can pass to all classes an array of configuration values. Possible values are:
username: Your DeveloperGarden API username.
password: Your DeveloperGarden API password.
environment: The environment that you selected.
Example 60.93. Configuration Example
require_once 'Zend/Service/DeveloperGarden/SendSms.php';
$config = array(
'username' => 'yourUsername',
'password' => 'yourPassword',
'environment' => Zend_Service_DeveloperGarden_SendSms::ENV_PRODUCTION,
);
$service = new Zend_Service_DeveloperGarden_SendSms($config);
The class can be used to set and get quota values for the services and to fetch account details.
The getAccountBalance() method is there to fetch an array
of account id's with the current balance status (credits).
Example 60.94. Get account balance example
$service = new Zend_Service_DeveloperGarden_BaseUserService($config); print_r($service->getAccountBalance());
You can fetch quota informations for a specific service module with the provided methods.
Example 60.95. Get quota information example
$service = new Zend_Service_DeveloperGarden_BaseUserService($config);
$result = $service->getSmsQuotaInformation(
Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
);
echo 'Sms Quota:<br />';
echo 'Max Quota: ', $result->getMaxQuota(), '<br />';
echo 'Max User Quota: ', $result->getMaxUserQuota(), '<br />';
echo 'Quota Level: ', $result->getQuotaLevel(), '<br />';
You get a Result object that contains all information that
you need, optional you can pass to the QuotaInformation
method the environment constant to fetch the quota for the specific environment.
Here a list of all getQuotaInformation methods:
getConfernceCallQuotaInformation()
getIPLocationQuotaInformation()
getLocalSearchQuotaInformation()
getSmsQuotaInformation()
getVoiceCallQuotaInformation()
To change the current quota use one of the changeQuotaPool
methods. First parameter is the new pool value and the second one is the
environment.
Example 60.96. Change quota information example
$service = new Zend_Service_DeveloperGarden_BaseUserService($config);
$result = $service->changeSmsQuotaPool(
1000,
Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
);
if (!$result->hasError()) {
echo 'updated Quota Pool';
}
Here a list of all changeQuotaPool methods:
changeConferenceCallQuotaPool()
changeIPLocationQuotaPool()
changeLocalSearchQuotaPool()
changeSmsQuotaPool()
changeVoiceCallQuotaPool()
This service allows you to retrieve location information for a given IP address.
There are some limitations:
The IP address must be in the T-Home network
Just the next big city will be resolved
IPv6 is not supported yet
Example 60.97. Locate a given IP
$service = new Zend_Service_DeveloperGarden_IpLocation($config);
$service->setEnvironment(
Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
);
$ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
print_r($service->locateIp($ip));
The Local Search service provides the local search machine suchen.de via a the web service interface. For more details, refer to the documentation.
Example 60.98. Locate a Restaurant
$service = new Zend_Service_DeveloperGarden_LocalSearch($config);
$search = new Zend_Service_DeveloperGarden_LocalSearch_SearchParameters();
/**
* @see http://www.developergarden.com/static/docu/en/ch04s02s06s04.html
*/
$search->setWhat('pizza')
->setWhere('jena');
print_r($service->localSearch($search));
The Send SMS service is used to send normal and Flash SMS to any number.
The following restrictions apply to the use of the SMS service:
An SMS or Flash SMS in the production environment must not be longer than 765 characters and must not be sent to more than 10 recipients.
An SMS or Flash SMS in the sandbox environment is shortened and enhanced by a note in the DeveloperGarden. The maximum length of the message sent is 160 characters.
In the sandbox environment, a maximum of 10 SMS can be sent per day.
The following characters are counted twice:
| ^ € { } [ ] ~ \ LF (line break)
If an SMS or Flash SMS is longer than 160 characters, one message is charged for each 153 characters (quota and credit).
Delivery cannot be guaranteed for SMS or Flash SMS to landline numbers.
The sender can exist of a maximum of 11 characters. Permitted characters are letters and numbers.
The specification of a phone number as the sender is only permitted if the phone number has been validated. (See: SMS Validation)
Example 60.99. Sending an SMS
$service = new Zend_Service_DeveloperGarden_SendSms($config);
$sms = $service->createSms(
'+49-172-123456; +49-177-789012',
'your test message',
'yourname'
);
print_r($service->send($sms));The SMS Validation service allows the validation of physical phone number to be used as the sender of an SMS.
First, call setValidationKeyword() to receive an SMS
with a keyword.
After you get your keyword, you have to use the validate() to
validate your number with the keyword against the service.
With the method getValidatedNumbers(), you will get a list
of all already validated numbers and the status of each.
Example 60.100. Request validation keyword
$service = new Zend_Service_DeveloperGarden_SmsValidation($config);
print_r($service->sendValidationKeyword('+49-172-123456'));
Example 60.101. Validate a number with a keyword
$service = new Zend_Service_DeveloperGarden_SmsValidation($config);
print_r($service->validate('TheKeyWord', '+49-172-123456'));
To invalidate a validated number, call the method inValidate().
The Voice Call service is used for setting up a voice connection between two telephone connections. For specific details please read the API Documentation.
Normally the Service works as followed:
Call the first participant.
If the connection is successful, call the second participant.
If second participant connects succesfully, both participants are connected.
The call is open until one of the participants hangs up or the expire mechanism intercepts.
Example 60.102. Call two numbers
$service = new Zend_Service_DeveloperGarden_VoiceCall($config); $aNumber = '+49-30-000001'; $bNumber = '+49-30-000002'; $expiration = 30; // seconds $maxDuration = 300; // 5 mins $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration); echo $newCall->getSessionId();
If the call is initiated, you can ask the result object for the session ID and
use this session ID for an additional call to the callStatus
or tearDownCall() methods. The second parameter on the
callStatus() method call extends the expiration for this call.
Example 60.103. Call two numbers, ask for status, and cancel
$service = new Zend_Service_DeveloperGarden_VoiceCall($config); $aNumber = '+49-30-000001'; $bNumber = '+49-30-000002'; $expiration = 30; // seconds $maxDuration = 300; // 5 mins $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration); $sessionId = $newCall->getSessionId(); $service->callStatus($sessionId, true); // extend the call sleep(10); // sleep 10s and then tearDown $service->tearDownCall($sessionId);
Conference Call allows you to setup and start a phone conference.
The following features are available:
Conferences with an immediate start
Conferences with a defined start date
Recurring conference series
Adding, removing, and muting of participants from a conference
Templates for conferences
Here is a list of currently implemented API methods:
createConference() creates a new conference
updateConference() updates an existing conference
commitConference() saves the conference, and, if no date
is configured, immediately starts the conference
removeConference() removes a conference
getConferenceList() returns a list of all configured
conferences
getConferenceStatus() displays information for an
existing conference
getParticipantStatus() displays status information
about a conference participant
newParticipant() creates a new participant
addParticipant() adds a participant to a conference
updateParticipant() updates a participant,
usually to mute or redial the participant
removeParticipant() removes a participant from a
conference
getRunningConference() requests the running instance of
a planned conference
createConferenceTemplate() creates a new conference
template
getConferenceTemplate() requests an existing conference
template
updateConferenceTemplate() updates existing conference
template details
removeConferenceTemplate() removes a conference template
getConferenceTemplateList() requests all conference
templates of an owner
addConferenceTemplateParticipant() adds a conference
participant to conference template
getConferenceTemplateParticipant() displays details of
a participant of a conference template
updateConferenceTemplateParticipant() updates
participant details within a conference template
removeConferenceTemplateParticipant() removes
a participant from a conference template
Example 60.104. Ad-Hoc conference
$client = new Zend_Service_DeveloperGarden_ConferenceCall($config);
$conferenceDetails = new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail(
'Zend-Conference', // name for the conference
'this is my private zend conference', // description
60 // duration in seconds
);
$conference = $client->createConference('MyName', $conferenceDetails);
$part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail(
'Jon',
'Doe',
'+49-123-4321',
'your.name@example.com',
true
);
$client->newParticipant($conference->getConferenceId(), $part1);
// add a second, third ... participant
$client->commitConference($conference->getConferenceId());
You can setup various caching options to improve the performance for resolving WSDL and authentication tokens.
First of all, you can setup the internal SoapClient (PHP) caching values.
Example 60.105. WSDL cache options
Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setWsdlCache([PHP CONSTANT]);
The [PHP CONSTANT] can be one of the following values:
WSDL_CACHE_DISC: enabled disc caching
WSDL_CACHE_MEMORY: enabled memory caching
WSDL_CACHE_BOTH: enabled disc and memory caching
WSDL_CACHE_NONE: disabled both caching
If you want also to cache the result for calls to the SecuritTokenServer
you can setup a Zend_Cache instance and pass it to the
setCache().
Example 60.106. SecurityTokenServer cache option
$cache = Zend_Cache::factory('Core', ...);
Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);