Zend_Service_DeveloperGardenIntroduction 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.
Configuration Example 'yourUsername',
'password' => 'yourPassword',
'environment' => Zend_Service_DeveloperGarden_SendSms::ENV_PRODUCTION,
);
$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).
Get account balance examplegetAccountBalance());
]]>Get quota information
You can fetch quota informations for a specific service module with the
provided methods.
Get quota information examplegetSmsQuotaInformation(
Zend_Service_DeveloperGarden_BaseUserService::ENV_PRODUCTION
);
echo 'Sms Quota: ';
echo 'Max Quota: ', $result->getMaxQuota(), ' ';
echo 'Max User Quota: ', $result->getMaxUserQuota(), ' ';
echo 'Quota Level: ', $result->getQuotaLevel(), ' ';
]]>
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.
Change quota information examplechangeSmsQuotaPool(
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()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 networkJust the next big city will be resolvedIPv6 is not supported yetLocate a given IPsetEnvironment(
Zend_Service_DeveloperGarden_IpLocation::ENV_MOCK
);
$ip = new Zend_Service_DeveloperGarden_IpLocation_IpAddress('127.0.0.1');
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.
Locate a RestaurantsetWhat('pizza')
->setWhere('jena');
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)
Sending an SMScreateSms(
'+49-172-123456; +49-177-789012',
'your test message',
'yourname'
);
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.
Request validation keywordsendValidationKeyword('+49-172-123456'));
]]>Validate a number with a keywordvalidate('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.
Call two numbersnewCall($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.
Call two numbers, ask for status, and cancelnewCall($aNumber, $bNumber, $expiration, $maxDuration);
$sessionId = $newCall->getSessionId();
$service->callStatus($sessionId, true); // extend the call
sleep(10); // sleep 10s and then tearDown
$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
Ad-Hoc conferencecreateConference('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());
]]>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.
WSDL cache options
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().
SecurityTokenServer cache option