Click-2-call

From PokeTALK developers

Jump to: navigation, search

Contents

[edit] Description

The Click-2-Call API allows you to trigger calls from any application by sending a few POST parameters to http://www.poketalk.com/index.php/api/click2call


[edit] Getting started

- Make sure you have a positive balance in your PokeTALK account to be able to place calls.

- Register for an API-Key with PokeTALK. You will need to supply the IP address which call requests will be triggered from (for help with this email developers@poketalk.com)


[edit] Parameters

Required Name Type Description
required to string full e164 phone number in international format (i.e 1212xxxxxxx)
required from string full e164 phone number in international format (i.e 1212xxxxxxx)
required api_key string Your API-Key as supplied to you by PokeTALK
not required custom string Custom string which you can query to find this specific record. (max 255 chars)

[edit] Response

 
Parameter Type Description
00 int OK
10 int ERROR. Empty 'api_key' parameter.
20 int ERROR. Empty 'from' parameter.
30 int ERROR. Empty 'to' parameter.
40 int ERROR. Unknown API user.
50 int ERROR. Can`t get service provider.
60 int ERROR. 'from' or 'to' number in blacklist.
70 int ERROR. Can`t get gateway list.
90 int ERROR. Can`t calculate timeout.
100 int ERROR. Unknown API IP address.

[edit] Good Practice

- In many countries the leading zero needs to be removed from the number before adding the country prefix, for example, 972054xxxxxxx would be incorrect, whilst 97254xxxxxx would be correct

- For your security, it is good practice to send the call request using "from" or "to" numbers which are pre-stored in your database, and NOT via client-side forms which can be manipulated.


from users of your application it is important that requests sent to PokeTALK containing the "from"