OmniSense Webphone Example

Owned by Vishane Naicker
Last updated: Oct 13, 2024
3 min read

Overview

The OmniSense Webphone is an example implementation of a web-based SIP phone for integration into CRMs and other systems by developers.

DO NOT DEPLOY THE EXAMPLE INTO PRODUCTION

This is an example. Maintenance and actual implementation is up to the Integrator

Installation

The Webphone uses sip.js 0.15.11 version. Newer versions of sip.js are up to the integrator.

  1. Download the file.

  2. Unzip the file in the respective folder.

URL Parameters

The following URL parameters must be included with OmniSense-Webphone.html

Parameter

Datatype

Description

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.

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.

expire_date

DateTime

Required parameter. Specify the expiration date for how long the agent webphone session should last.

debug_console

Boolean

Optional parameter. This parameter will enable debug information to be displayed on the console logs.

debug_html

Boolean

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.

Register Webphone

  1. Open the browser window with the OmniSense-Webphone.html file and the necessary URL parameters. If successful, the following information will be displayed in the browser window. If the Webphone is not registered, no information will be shown. Check the console log to troubleshoot any issues.

image-20240527-141942.png

  1. Retrieve the value of the WebRTC Phone Extension from the browser page or console log and temporarily store it for the corresponding agent profile.

image-20240527-143148.png

User Login

  1. When using the Login API, log in the respective user with the previously stored phone extension.

  1. If the Login API request is successful, the browser page will prompt for microphone access. Grant the access, and the Webphone will establish a connection to the agent profile.

  1. At this point, you will now be able to use the Telephony APIs to conduct voice operations.

User Logout

  1. Use the Logout API to log out the agent and end the Webphone session.

Â