Versions Compared

Version Old Version 12 New Version Current
Changes made by

Vishane Naicker

Vishane Naicker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

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

Warning

DO NOT DEPLOY THE EXAMPLE INTO PRODUCTION

Note

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 not supported as yetup to the integrator.

  1. Download the <PLACE HOLDER FOR FILE ATTACHMENT>

    View file
    nameOmniSense-Webphone.zip
    file.

  2. Unzip the file in the respective folder.

URL Parameters

The following parameters will be provided by the Service Delivery Department will provide the following parameter information.

  1. auth_key

  2. server

  3. turn_port

  4. customer_id

  5. 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 expiration date for how long the agent webRTC webphone session should last.

debug_console

true | falseBoolean

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

debug_html

true | falseBoolean

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.

Note

If the browser page is refreshed after establishing a session, the Webphone will disconnect. You will have need to log the user out and restart repeat the steps below steps.

Register Webphone

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

...

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

...

User Login

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

...

  1. If the user login Login API request is a successsuccessful, the browser page will prompt for microphone access. Allow microphone 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 Voice Telephony APIs to conduct voice operations.

User Logout

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

...