initiateSessionAccepted Response
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Represents the synchronous response to an initiateSession request through the command channel.
Syntax
<initiateSessionAccepted rid="25" sid="330" pollWaitTime="3000"/>
Attributes
Attribute |
Data Type |
Description |
|---|---|---|
rid |
string |
Request Id. This is a string value assigned by the Unified Communications client. This is a required attribute. |
sid |
integer |
Session Id. This is an integer value assigned by the Communicator Web Access Server. |
pollWaitTime |
integer |
Indicates the amount of time in milliseconds the Unified Communications AJAX API Client must wait before polling for events again. |
Element Information
Parent Element
Element |
Description |
|---|---|
Holds the synchronous response to an HTTP POST request carried over through a command channel. It is used to inform the client of the initial status of a request. |
Remarks
This synchronous response indicates the request to initiate a session was successful. The sid attribute of this element is generated by a Communicator Web Access Server. All further cwaRequests made to the Communicator Web Access Server must include this attribute value. The Communicator Web Access Server includes this sid with all returned synchronous and asynchronous events as well. In this way, the Unified Communications AJAX API Client can track which responses are mapped to which sessions.
Examples
This example shows that the Unified Communications AJAX API Client application has successfully created a session on a Communicator Web Access Server. The returned session ID of 330 is used in further requests. The Communicator Web Access Server has requested that the client wait 3000 milliseconds (3 seconds) before polling for asynchronous responses to further requests.
<initiateSessionAccepted rid="1" sid="330" pollWaitTime="3000"/>