Versions Compared

Version Old Version 4 New Version 5
Changes made by

Vishane Naicker

Vishane Naicker

Saved on

Key

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

...

The Webphone uses sip.js 0.15.11 version. Newer versions of sip.js are not supported as yet.

  1. Download the

    View file
    nameTForge-OmniSense-Webphone.zip
    file.

  2. Unzip the file in the respective folder.

Instructions

...

  1. .

URL Parameters

The authorisation key and server address following parameters will be provided by the Service Delivery Department.

  1. auth_key

  2. server

  3. turn_port

  4. customer_id

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 provided authorization key.

server

String

Required parameter. Specify the provided server address.

turn_port

Integer

Required parameter. Specify the provided TURN port address for connecting the user to the webRTC server.

customer_id

Integer

Required parameter. Specify the provided 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 provided password for connecting the user to the webRTC server.

expire_date

DateTime

Required parameter. Specify the expiry datetime 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.

Instructions and Usage

The below instructions simulate launching the Webphone in a browser window.

  1. 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.

...

  1. Use the user login API to user log the agent in

Endpoint

Note

The API will operate outside of office hours only.

...