Setting Up Web Callback Web Service for iOS

Groudwire is hardcoded with web callback service for some SIP providers. For providers not covered or if you want to override the hardcoded setup, set it up at Settings > Accounts > a desired account > Advanced Settings > Web Services > Web Callback.

Note

For the Cloud Softphone project owners, include the callback web service URL in the Provisioning options when building your softphone application on the Cloud Softphone portal. Follow the same formatting for the URL described on this page.

The web callback service allows users to initiate a callback through a custom web service.

To open the Web Services screen:
- Android devices - Select > Settings > Accounts > the desired SIP account > Advanced Settings > Web Services.
- iOS devices - Open the Keypad tab, select > SIP Accounts or Accounts > the desired SIP account > Advanced Settings > Web Services.
Go to the Custom Web Callback section and then enable this service.
Enter the URL to your web service using either the GET or POST method to send parameters to your web service:
- To use the GET method, enter the parameters in the query string.
- To use the POST method, enter your parameters in the POST data field.
Select or Done.

Parameters Considerations

Tips

Refer to doc.acrobits.net/api/client/web_callback.html for more information.

Here are some requirements for the URL of your web service:

Use dynamic parameters.
For example, %targetNumber% in the URL query string or POST data is replaced by the destination phone number.
Use account-specific parameters.
For example, %account[username]% is replaced by the actual username, and %account[password]% the actual password.

Important

The password can only be passed when using a secure protocol, such as when the URL begins with https://. Or else, asterisks (*) are used as a placeholder, which is not working. As an alternative to insecure protocols, pass the SHA-1 hash of your password using the syntax %sha1(%account[password]%)%.

Specify the preconfigured callback number to be referenced by %account[callbackNumber]%.

Initiating a Web Callback

After configuring the callback web service for a SIP account, to initiate a web callback:

Touch and hold the following key in one of the following tabs:
- The Call button on the Keypad tab
- A quick dial on the Quickdial tab
- An entry on the History tab.
Select the Web Callback option.
The app calls the web service, and eventually, initiates a callback.

Setting up Callback Web Service for GSM Account

The application also provides a callback web service for a GSM account.

To open the Web Services screen:
- Android devices - Select > Settings > Accounts > the desired GSM account > Web Callback.
- iOS devices - Open the Keypad tab, select > Accounts > the desired GSM account > Web Callback.
Enable Web Callback.
Enter the URL to your web service. Hardcode the username and password for the GSM account into the URL or POST data.
Use either the GET or POST method to send parameters to your web service:
- To use the GET method, enter the parameters in the query string.
- To use the POST method, enter your parameters in the POST data field.
Select or Done.

Initiating GSM Account Web Callback

Note

Ensure your GSM account is in the enabled section on the Accounts screen.
If you do not see a GSM call button on the Keypad tab, perform the following step:

- Android devices - Select > Settings > Preferences > Controls > Enable Show GSM button.
- iOS devices - Open the Keypad tab, select > Preferences > Controls > Enable Show GSM button.

After configuring the callback web service for a GSM account, to initiate a web callback:

Touch and hold the GSM button button on the Keypad tab.
A menu option displays.
Select Web Callback.