Overview
The TForge OmniSense Webphone is a web-based SIP phone designed for seamless integration into CRMs and other systems by developers.
Installation
The Webphone uses sip.js 0.15.11 version. Newer versions of sip.js are not supported as yet.
Download the <PLACE HOLDER FOR FILE ATTACHMENT> file.
Unzip the file in the respective folder.
URL Parameters
The following parameters will be provided by the Service Delivery Department.
auth_key
server
turn_port
customer_id
password
URL Parameters can be passed in any order.
The following URL parameters must be included with TForge-OmniSense-Webphone.html
Parameter | Datatype | Description |
|---|---|---|
auth_key | String | Required parameter. Specify the authorization key. |
server | String | Required parameter. Specify the server address. |
turn_port | Integer | Required parameter. Specify the TURN port address for connecting the user to the webRTC server. |
customer_id | Integer | Required parameter. Specify the customer ID. |
user_id | Integer | Required parameter. Specify the agent profile ID. |
username | String | Required parameter. Specify the agent profile username. |
password | String | Required parameter. Specify the password for connecting the user to the webRTC server. |
expire_date | DateTime | Required parameter. Specify the expiry date for how long the agent webRTC session should last. |
debug_console | true | false | Optional parameter. This parameter will enable debug information to be displayed on the console logs. |
debug_html | true | false | Optional parameter. This parameter will enable debug information to be displayed on the HTML page. |
Usage
The below instructions simulate launching the Webphone in a browser window.
If the browser page is refreshed after establishing a session, the Webphone will disconnect.
You will have to log the user out and restart the below steps.
Register Webphone
Launch the browser window with the TForge-OmniSense-Webphone.html file and the required URL parameters. If successfully launched, the below information will display in the browser window. If the phone is not registered, no information will be displayed. Use the console log to identify any issues.
From the browser page or console log, get the value of the Webrtc Phone Extension and store it for the respective agent profile.
User Login
When using the User Login API, login the respective user with the phone extension you previously saved.
If the user login API request is a success, the browser page will prompt for microphone access. Allow microphone access and the Webphone will establish a connection to the agent profile.
At this point, you will now be able to use the Voice APIs to conduct voice operations.
User Logout
Use the User Logout API to log the agent out and hang up the Webphone session.
