Click-to-call API

GET (Making a call using click-to-dial from command line)

 

  1. Links without 'press 1' prompt: If, you want to be connected to the destination without having to listen the message 'press 1 to continue' and pressing the digit '1'. You can use 'connect=true' parameter as shown below to achieve this.

    http://pbx/remote_call.htm?user=123@domain.com&dest=123456789&auth=123@domain.com:extension's_web_password&connect=true

EQUIVALENT API FOR THE ABOVE EXAMPLE:

/pbx/remote_call.htm?user=ext@domain.com&dest=outbound_number&auth=ext@domain.com:ext_web_pass&connect=true

Parameters

Field Type Description
pbx String FQDN name or IP of the PBX.
domain_name String Name of the existing domain.
ext Integer Extension number.
outbound number Integer Destination / Outbound number to be called.

Success (200 OK)

Example:

Request:

 curl -v admin:password GET -D - "http://192.168.1.113/remote_call.htm?user=446@192.168.1.113&dest=18572233272&auth=446@192.168.1.113:zxc&connect=true" 

* Rebuilt URL to: admin:/
* Could not resolve host: admin
* Closing connection 0
curl: (6) Could not resolve host: admin
* Rebuilt URL to: GET/
* Could not resolve host: GET
* Closing connection 1
curl: (6) Could not resolve host: GET
*   Trying 192.168.1.113...
* Connected to 192.168.1.113 (192.168.1.113) port 80 (#2)
> GET /remote_call.htm?user=446@192.168.1.113&dest=18572772251&auth=446@192.168.1.113:zxc&connect=true HTTP/1.1
> Host: 192.168.1.113
> User-Agent: curl/7.47.0
> Accept: */*
> 
< HTTP/1.1 200 Ok
HTTP/1.1 200 Ok
< Date: Wed, 01-May-2019 18:47:10 GMT
Date: Wed, 01-May-2019 18:47:10 GMT
< Content-Type: text/html
Content-Type: text/html
< Cache-Control: no-cache
Cache-Control: no-cache
< Cache-Control: no-store
Cache-Control: no-store
< Server: PBX/63.0 (Debian64)
Server: PBX/63.0 (Debian64)
< Content-Length: 1920
Content-Length: 1920

< 
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD Xhtml 1.0 Transitional//EN" "http://www.w3.org/tr/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
 <title>Remote Call Initiation</title>
 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 <link href="style.css" type="text/css" rel="stylesheet" />
</head>
<body>
<table width="100%" border="0" align="center" cellpadding="0" cellspacing="0">
 <tr>
  <td></td>
  <td background="img/gradient1.gif"></td>
  <td background="img/login_head.gif" height="25">&nbsp;</td>
  <td background="img/gradient2.gif"></td>
  <td></td>
 </tr>
 <tr>
  <td>&nbsp;</td>
  <td width="5" background="img/gradient1.gif">&nbsp;</td>
  <td width="400" bgcolor="#FFFFFF">
   <table width="100%" border="0" align="center" cellpadding="0" cellspacing="0">
    <tr><td><table>
     <tr class="headerText" height="40">
      <td valign="middle">Remote Call Initiation</td>
     </tr>
     <tr class="cText">
      <td valign="middle">Your phone should display the number that you have entered. Just pick up the handset to start the call now.<br><br>       Please see the manual of you phone to customize this behavior. Depending on your security policy, you phone may start the call immediately or wait until you acknowledge the call invocation.</td>
     </tr>
    </table>
    </td></tr>
   </table>
  </td> 
  <td width="5" background="img/gradient2.gif">&nbsp;</td>
  <td>&nbsp;</td>
 </tr>
 <tr>
   <td></td>
   <td background="img/gradient5.gif"></td>
   <td height="5" background="img/gradient3.gif"></td>
   <td background="img/gradient4.gif"></td>
   <td></td>
 </tr>
 <tr>
  <td></td><td></td><td height="30" width="400" colspan="2" valign="top" class="footText" align="center">. All rights reserved. See the license agreement for more information.</td><td></td><td></td>
 </tr>
</table>
</body>
</html>

You would immediately observe the extension making an outbound call to the destination number provided in the API.