Zend_Service_DeveloperGarden

Introduction to DeveloperGarden

Developer Garden is the name of Deutsche Telekom’s developer community. Developer Garden offers you access to core services of Deutsche Telekom, such as voice connections (Voice Call) or sending text messages (Send SMS) via open interfaces (Open APIs). You can access the Developer Garden services directly via SOAP or REST.

The family of Zend_Service_DeveloperGarden components provides a clean and simple interface to the » Developer Garden APIs 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 Deutsche 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 participants.

  • 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.

Sign Up for an Account

Before you can start using the DeveloperGarden API, you first have to » sign up for an account.

The Environment

With the DeveloperGarden API you have the possibility to choose between 3 different development environments.

  • production: In Production environment there are no usage limitations. You have to pay for calls, sms and other services with costs.

  • sandbox: In the Sandbox mode you can use the same features (with limitations) as in the production without to paying for them. This environment is suitable for testing your prototype.

  • mock: The Mock environment allows you to build your application and have results but you do not initiate any action on the API side. This environment is intended for testing during development.

For every environment and service, there are some special features (options) available for testing. Please look » here for details.

Your configuration

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 #1 Configuration Example

  1. require_once 'Zend/Service/DeveloperGarden/SendSms.php';
  2. $config = array(
  3.     'username'    => 'yourUsername',
  4.     'password'    => 'yourPassword',
  5.     'environment' => Zend_Service_DeveloperGarden_SendSms::ENV_PRODUCTION,
  6. );
  7. $service = new Zend_Service_DeveloperGarden_SendSms($config);

BaseUserService

The class can be used to set and get quota values for the services and to fetch account details.

The getAccountBalance() method fetches an array of account id's with the current balance status (credits).

Example #2 Get account balance example

  1. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  2. print_r($service->getAccountBalance());

Get quota information

You can fetch quota informations for a specific service module with the provided methods.

Example #3 Get quota information example

  1. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  2. $result = $service->getSmsQuotaInformation(
  3.     Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
  4. );
  5. echo 'Sms Quota:<br />';
  6. echo 'Max Quota: ', $result->getMaxQuota(), '<br />';
  7. echo 'Max User Quota: ', $result->getMaxUserQuota(), '<br />';
  8. echo 'Quota Level: ', $result->getQuotaLevel(), '<br />';

You get a result object that contains all the information 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()

Change quota information

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 #4 Change quota information example

  1. $service = new Zend_Service_DeveloperGarden_BaseUserService($config);
  2. $result = $service->changeSmsQuotaPool(
  3.     1000,
  4.     Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
  5. );
  6. if (!$result->hasError()) {
  7.     echo 'updated Quota Pool';
  8. }

Here a list of all changeQuotaPool methods:

  • changeConferenceCallQuotaPool()

  • changeIPLocationQuotaPool()

  • changeLocalSearchQuotaPool()

  • changeSmsQuotaPool()

  • changeVoiceCallQuotaPool()

IP Location

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 #5 Locate a given IP

  1. $service = new Zend_Service_DeveloperGarden_IpLocation($config);
  2. $service->setEnvironment(
  3.     Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
  4. );
  5. $ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
  6. print_r($service->locateIp($ip));

Local Search

The Local Search service provides the location based search machine » suchen.de via web service interface. For more details, refer to » the documentation.

Example #6 Locate a Restaurant

  1. $service = new Zend_Service_DeveloperGarden_LocalSearch($config);
  2. $search  = new Zend_Service_DeveloperGarden_LocalSearch_SearchParameters();
  3. /**
  4. * @see http://www.developergarden.com/static/docu/en/ch04s02s06s04.html
  5. */
  6. $search->setWhat('pizza')
  7.        ->setWhere('jena');
  8. print_r($service->localSearch($search));

Send SMS

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 from the DeveloperGarden. The maximum length of the message 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 a 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 be 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 #7 Sending an SMS

  1. $service = new Zend_Service_DeveloperGarden_SendSms($config);
  2. $sms = $service->createSms(
  3.     '+49-172-123456; +49-177-789012',
  4.     'your test message',
  5.     'yourname'
  6. );
  7. print_r($service->send($sms));

SMS Validation

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 #8 Request validation keyword

  1. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  2. print_r($service->sendValidationKeyword('+49-172-123456'));

Example #9 Validate a number with a keyword

  1. $service = new Zend_Service_DeveloperGarden_SmsValidation($config);
  2. print_r($service->validate('TheKeyWord', '+49-172-123456'));

To invalidate a validated number, call the method inValidate().

Voice Call

The Voice Call service can be used to set 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 #10 Call two numbers

  1. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  2. $aNumber = '+49-30-000001';
  3. $bNumber = '+49-30-000002';
  4. $expiration  = 30// seconds
  5. $maxDuration = 300; // 5 mins
  6. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  7. 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 #11 Call two numbers, ask for status, and cancel

  1. $service = new Zend_Service_DeveloperGarden_VoiceCall($config);
  2. $aNumber = '+49-30-000001';
  3. $bNumber = '+49-30-000002';
  4. $expiration  = 30; // seconds
  5. $maxDuration = 300; // 5 mins
  6.  
  7. $newCall = $service->newCall($aNumber, $bNumber, $expiration, $maxDuration);
  8.  
  9. $sessionId = $newCall->getSessionId();
  10.  
  11. $service->callStatus($sessionId, true); // extend the call
  12.  
  13. sleep(10); // sleep 10s and then tearDown
  14.  
  15. $service->tearDownCall($sessionId);

ConferenceCall

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 #12 Ad-Hoc conference

  1. $client = new Zend_Service_DeveloperGarden_ConferenceCall($config);
  2.  
  3. $conferenceDetails =
  4.     new Zend_Service_DeveloperGarden_ConferenceCall_ConferenceDetail(
  5.         'Zend-Conference',                    // name for the conference
  6.         'this is my private zend conference', // description
  7.         60                                    // duration in seconds
  8.     );
  9.  
  10. $conference = $client->createConference('MyName', $conferenceDetails);
  11.  
  12. $part1 = new Zend_Service_DeveloperGarden_ConferenceCall_ParticipantDetail(
  13.     'Jon',
  14.     'Doe',
  15.     '+49-123-4321',
  16.     'your.name@example.com',
  17.     true
  18. );
  19.  
  20. $client->newParticipant($conference->getConferenceId(), $part1);
  21. // add a second, third ... participant
  22.  
  23. $client->commitConference($conference->getConferenceId());

Performance and Caching

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 #13 WSDL cache options

  1. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setWsdlCache(
  2.     [PHP CONSTANT]
  3. );

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 also want to cache the result for calls to the SecuritTokenServer you can setup a Zend_Cache instance and pass it to the setCache().

Example #14 SecurityTokenServer cache option

  1. $cache = Zend_Cache::factory('Core', ...);
  2. Zend_Service_DeveloperGarden_SecurityTokenServer_Cache::setCache($cache);
blog comments powered by Disqus