Help & Support

Web Callbacks

A web callback is a way to initiate a telephone call from a web request, for example by clicking on a link or by sending a HTTP request with a program such as curl. SIPSorcery provides two slightly different approaches for intiating web callbacks.

  • The first approach is to create dedicated links using the SIPSorcery AJAX portal. In order to use the links it is necessary to first login.
  • The second approach is to submit a web request to the SIPSorcery call manager web service. The web service does not require authentication but a specific dial plan must be configured to process the request.

Web callbacks with pre-configured links

After logging onto the AJAX Portal click on the Web Callbacks menu option. The page allows new callbacks to be created as well as existing ones to be updated of deleted. Existing callbacks can be initiated by clicking on the "place call" link. When the link is clicked on the SIPSorcery application server will attempt to dial the first call leg and if it is successfully answered it will successfully dial the second call leg.

The dial strings used in the callbacks are the same foramt as the dial strings used in the sys.Dial command in a Ruby dial plan. This means they can include multiple call legs and additional call control options.

Web callbacks with the call manager web service

The Web Callback feature can be used to initiate a callback using a HTTP GET request. The steps involved are:

  • Create a new dialplan with a name of webcallback. This is the dialplan that will be activated when a Web Callback arrives for your username and can contain any processing you wish. However since there is no SIP call to bridge to using the Dial command will not work. An example of a minimal dialplan for a web callback is:
  • Web Callbacks need to be initiated using
    https://www.sipsorcery.com/callmanager.svc/webcallback?user=username&number=1234567

Extra parameters

At the moment the only discretionary parameter for a web callback is the number parameter. By putting extra information in that parameter it is possible to use it within the webcallback dialplan.

An example a making a web callback using extra information in the number parameter is shown in the example below.

https://www.sipsorcery.com/callmanager.svc/webcallback?user=username&number=1234567,abcdxyz

Output: