Websocket Api Parameters - Cisco 8800 Series Manual

WebSocket API Parameters

Procedure
Step 1
Select Voice > Phone.
Step 2 Go to the WebSocket API section.
Step 3
Set the Control Server URL and the Allowed APIs fields as described in the
on page 226
Step 4
Click Submit All Changes.
WebSocket API Parameters
The following table defines the function and usage of each parameter in the WebSocket API section in the
Voice > Phone tab of the phone web page. It also defines the syntax of the string that is added in the phone
configuration file with XML (cfg.xml) code to configure a parameter.
Parameter Name
Control Server URL
Cisco IP Phone 8800 Series Multiplatform Phone Administration Guide for Release 11.3(1) and Later
226
table.
Cisco IP Phone Configuration
WebSocket API Parameters,
Description and Default Value
The URL of a WebSocket server to which the phone
attempts to stay connected.
• In the phone configuration file with XML
(cfg.xml) enter a string in this format.
<Control_Server_URL ua="na"/>
• In the phone web page enter the URL of a
WebSocket server.
For example:
<Control_Server_URL>wss://my-server.com
/ws-server-path</Control_Server_URL>
The URL should be in one of the following formats:
• For a nonsecure HTTP connection:
ws://your-server-name/path
• For a secure HTTPS connection:
wss://your-server-name/some-path
We recommend a secure connection.
Default: Empty.