Click 2 Call. All rights reserved to Voicenter Revision

Transcription

1 Click Call

2 . Click Call Click Call 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 click call to your CRM, will improve your performance and make sure you fullydeliver your SLA ( as endorsed... General Click to Call API description: API URL: Example: aspx?phone=07xxxxxxx&target=0xxxxxxx&code=xxxxxxxxxxx&action=call This API allows you to initiate any of the following types of calls:. Simple call. Dial & play record. Conference call Acceptable request types:. POST. GET Possible Response formats: To control the format of the response please provide your desired format in the request:. XML (default). JSON

3 .. Call parameters target First destination to dial. number or Starkey/ Voicenter extension. should be in E6 format, but without the leading plus (+) sign. If the phone is Israeli, format can be 0********* too. In case of dialing to an extension behind a SIP Trunk, please set =SIPTRUNK. In case of extension dependency on user login please et phone=logincode phonelogincode=[login code] Second destination to dial. number or Starkey/ Voicenter extension. should be in E6 format, but without the leading plus (+) sign. If the Target is Israeli, format can be 0********* too. code Caller identity action Call (action=call) record phonecallerid phonecallername targetcallerid targetcallername phonemaxdialtime targetmaxdialtime maxduration phoneautoanswer targetautoanswer checkphonedevicestate Record the call Acceptable values: true / false If not provided set to false. Caller id of the phone Caller name of the phone Caller id of the target Caller name of the target phone maximum dial time, in seconds. If not provided set to 60 seconds. target maximum dial time, in seconds. If not provided set to 60 seconds. Maximum call duration in seconds. If not provided set to 700 seconds. Only for Starkey / Voicenter extensions Expecting for true or for phone automatic answer Only for Starkey / Voicenter extensions Expecting for true or for target automatic answer Block call if extension offline checktargetdevicestate Block call if extension offline language vm_id format var_* Specify language for system recordings/prompts/etc.. Acceptable format is [he/en/ru/ etc ] Voic code. Only n case phone is Starkey /Voicenter extension Control the format of the response Possible formats : XML JSON The default is XML Any custom parameter with var_ prefix. For example: var_customer= This parameter used in: Voicenter chrome notification extension Voicenter desktop notification program CDR to CRM API The limit is 0 parameters.

4 .. Message (Dial & Play voice message) First destination to dial number or Starkey / Voicenter extension format can be 0****** as well as 97***** code Caller identity action Message (action=message) pre_rec Name of the record without extension First record to play Dtmf Numeric sequence Will be played number by number loop_rec After number record ( without extension ) post_rec Last record to be played (without extension) Record Record the call. Acceptable variables true / false targetcallerid targetcallername phonemaxdialtime Caller id of the target Caller name of the target In seconds maximum dial time If not provided set to 0 maxduration In seconds, Maximum call duration If not provided set to 0. phoneautoanswer Only for Starkey / Voicenter extensions Expecting for true or for phone automatic answer.. Callference call First destination to dial number or Starkey / Voicenter extension format can be 0****** as well as 97***** code Caller identity action Callference (action=callference) bbbcode Callference entry code targetcallerid targetcallername phonemaxdialtime maxduration phoneautoanswer Caller id of the target Caller name of the target In seconds maximum dial time If not provided set to 0. In seconds Maximum call duration If not provided set to 0. Only for Starkey / Voicenter extensions. Expecting for true or for phone automatic answer

5 .. Terminate Voicenter extension To hangup code Caller identity action terminate (action=terminate).6. Response Response is XML (XML-RPC structure) or JSON Fields:. ERRORCODE (Integer) List Code 0 OK Description Invalid request parameters Application error Extension representative offline Extension blocked for ClickCall calls. ERRORMESSAGE (String) A short sentence describing the. CALLID String ( chars) Unique code of the call In case of failure is empty XML response Example: <methodresponse> <params> <param> <value> <struct> <member> <name>errorcode</name> <value><string></string></value> </member> <member> <name>errormessage</name> <value><string> is missing</string></value> </member> <member> <name>callid</name> <value><string></string></value> </member> </struct> </value> </param> </params> </methodresponse>

6 JSON response Example: { } "ERRORCODE":0, "ERRORMESSAGE":"OK", "CALLID":"sdfsdfsdfsdfdsfsdfdsfsdfsdf0brp".7. PHP Sample ( with XML response ) $params="code=$code&phone=$voicenter_code_phone&phonecallerid= &target=$target &targetcallerid=$target&record=true"; $ch = curl_init(" curl_setopt($ch, CURLOPT_POST,); curl_setopt($ch, CURLOPT_POSTFIELDS,$params); curl_setopt($ch, CURLOPT_RETURNTRANSFER,); $response = curl_exec($ch); $callid = return_callid_from_string($response ); function return_callid_from_string($str) { $xml_str = simplexml_load_string($str); foreach($xml_str->params->param->value->struct->member as $a){ if($a->name == "CALLID") { return $a->value->string; } } } 6