Click2Call API

Click2Call enables executing direct phone calls, with just the click of a button.
It’s super easy to implement and integrate, using our ready-to-use code.
This great and versatile API integration can really make a difference, wherever you assimilate it
  • Initiating phone-calls from any available representative or salesperson -automatically!(Great
    performance booster, fully personalize to any duration).

 

  • Trigger and initiate an automatic call-back to any ‘Contact us’ lead or customer, the moment
    they click the ‘Apply/Send’ button. Imagine their WOW, and your conversion rates.

 

  • Integrate click2call to your CRM, will improve your performance and make sure you fully-deliver your SLA (http://en.wikipedia.org/wiki/Service-level_agreement) as endorsed.

 

The Click-To-Call API works as follows:


The API for each call you initiate actives 2 "legs":

1. "Leg 1" is the first call the agent receives to his extension after initiating a call.
This is set by the "Phone" parameter where you input the ID of the agent's extension.

2. "Leg 2" is the call to the chosen destination (following an answer to the leg 1 call), this is set by configuring the client's phone number in the target parameter.

 

General Click2Call API description:

API URI

1
          
https://api.voicenter.com/forwardDialer/click2call.aspx
        

Capabilities of the API

 

This API allows you to initiate any of the following 3 types of calls:

1. Simple outgoing call.

2. Callback and click to IVR.

3. Terminate calls.

Acceptable request types

 

1. POST-JSON

2. GET

Possible Response formats

To control the format of the response please provide your desired format in the request:

 

1. XML (default)

2. POST-JSON

 

Request Example GET Format

1
          
https://api.voicenter.com/ForwardDialer/click2call.aspx?phone=XXXXXXXX&target=057XXXXXXX&code=XXXXXXXXXXX&action=call
        

Request Example POST-JSON Format

{
"code": "XXXXXXXXXXX",
"phone": "APIAPIAPI",
"action": "call",
"target": "0512345678"
}

Call Action Request Parameters

Parameter Description Appearance
PhoneFirst destination to dial.
Phone number or Voicenter extension.
Phone must be in E164 format, but without the plus sign.
If the phone is Israeli,format can be 0*********.
In case of dialing to an extension behind a SIP Trunk, please set Phone=SIPTRUNK.
In case of extension dependency on user login please set:
phone=logincode phonelogincode=[login code].
Mandatory
targetSecond destination to dial.
Phone number or Voicenter extension.
Phone should be in E164 format, but without the leading plus (+) sign. If the Target is Israeli, format can be 0********* too.
Mandatory
codeCaller identity token, attainable from our back office department.mandatory
actionCall (action-call).mandatory
recordRecord the call.
Acceptable values: true / false.
If not provided set to false.
Optional
phonecalleridCaller id of the phone.
Not supported by all providers.
Optional
phonecallernameCaller name of the phone.
Not supported by all providers.
Optional
targetcalleridCaller id of the target.
Not supported by all providers.
Optional
targetcallernameCaller name of the target.
Not supported by all providers.
Optional
phonemaxdialtimePhone maximum dialtime, in seconds.
If not provided set to 60 seconds.
Optional
targetmaxdialtimeTarget maximum dial time, in seconds.
If not provided set to 60 seconds.
Optional
maxdurationMaximum call duration in seconds.
If not provided set to 7200 seconds.
Optional
phoneautoanswerOnly for Voicenter extensions.
Expecting true or 1 for phone automatic answer.
If not specified set to false.
Optional
targetautoanswerOnly for Voicenter extensions.
Expecting for true or 1 for target automatic answer
If not specified set to false.
Optional
checkphonedevicestateBlock call if extension offline.Optional
checktargetdevicestateBlock call if extension offline.Optional
languageSpecify languageforsystem recordings/prompts/etc.
Acceptable format is [he/en/ru/ etc...].
optional
vm_idVoicemailcode.
Only for Voicenter extension.
Optional
formatControl the format of the response.
Possible formats : 1. XML
2. JSON The default is XML.
Optional
var_*Any custom parameter with “var_” prefix.
For example: var_customer=2342
This parameter used in:
1.Voicenter chrome notification extension
2.Voicenter desktop notification program
3.CDR to CRM API
The limit is 10 parameters.
https://api.voicenter.co.il/ForwardDialer/click2call. aspx?phone=XXXXXXXX&target=057XXXXXXX&code=XXXXXXXXXXX&action=call &var_accountID=12345678&var_agentID=1234567
Optional

Terminate Action

The Click-To-Call provides you with the option not just initialing calls but also allow the agent to end an active call.

 

Table Parameters

Parameter Description Appearance
PhoneVoicenter extension To hang up.Mandatory
codeCaller identity for you account, provided by our Backoffice department.Mandatory
actionterminate (action=terminate).Mandatory

Click-To-Call API Response

After you make an api request we provide with you with a response to signal if your request was successful or not.

The response will be in XML format (XML-RPC structure) or JSON.

 

The fields are as follows:

1. ERRORCODE (Integer) List:

Code Description
0OK
1Invalid request parameters
2Application error
3The representative's extension is offline
4Extension blocked for Click2Call calls

2. ERRORMESSAGE (String) - A short sentence describing the issue.

3. CALLID - String (32 chars), Unique code of the call, in case of failure is empty.

 

XML Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
          
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>ERRORCODE</name>
<value><string>1</string></value>
</member>
<member>
<name>ERRORMESSAGE</name>
<value><string>Phone is missing</string></value>
</member>
<member>
<name>CALLID</name>
<value><string></string></value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
        

JSON Response Example

{
"ERRORCODE": 0,
"ERRORMESSAGE": "OK",
"CALLID": "sdfsdfsdfsdfdsfsdfdsfsdfsdf0brp"
}