initiateSession Request

Article
05/23/2014

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.

Provides a server with required configuration information after the caller is authenticated using a Logon request.

Syntax

<initiateSession rid="1">
   <localeId>123</localeId>
   <securityMode>private</securityMode>
   <userStateAvailability>3500</userStateAvailability>
   <options autoPublishMachineState="true"/>
   <categoryEventFilter>  </categoryEventFilter>
   <myCustomElement namespace="HTTP://WWW.myDomain/2006/XHTML">
      ...
   </myCustomElement>
</initiateSession>

The following sections describe attributes, parent elements, and child elements.

Attributes

Attribute	Data Type	Description
rid	string	Represents the client-assigned instance ID for this request. This is a required attribute.

Element Information

Parent Element

Element	Description
cwaRequests	Contains one or more methods that a Unified Communications AJAX API Client sends to a Communicator Web Access Server.

Child Elements

Element	Occurrence	Description
localeId	0 or more	Represents the locale identifier for language and region.
securityMode	0 or more	Indicates whether the client has logged on from a public or private computer. The possible values are public and private. This field is ignored if the Communicator Web Access Server is hosted by an internal server.
userStateAvailability	0 or more	Shows the initial status of the user. Acceptable values are Online (3500), Busy (6500), Do Not Disturb (9500), Be Right Back (12500), Away (15500), Offline (18500).
options	0 or more	Represents a set of Boolean flags to specify options that can be used to perform the initialization.
categoryEventFilter	0 or more	Lists categories used for presence subscription. When this is not specified, server-specified default settings are used. This setting can be set only once for each session.
signInData	0 or more	Encoded data including the logged-on users phone number contact information
any	0 or more	Represents a user-defined element. Any element from the namespace specified in the namespace attribute is acceptable. The namespace must not be the namespace of the Communicator Web Access schema.

Remarks

A client application can call this method to enable or disable a set of features in a session. For example, the client may want a session in which presence is supported, but incoming IM is ignored. Or a connection is for scheduling a conference call. The Communicator Web Access Server responds synchronously with a requestAccepted or requestRejected response to indicate whether it accepts or rejects the initiateSession request. However, a requestAccepted event does not mean that the initiateSession request is guaranteed to succeed as the request is an asynchronous operation. The client must poll the server through the data channel to determine if the operation has succeeded. If the initiateSession request fails, the Communicator Web Access Server returns the requestFailed event indicating the reasons of failure.

Examples

This is the initial request made after a successful logon request. The rid attribute value should always be 1. The user is logging on to a Communicator Web Access Server from a private computer. For information about initiate session options, see the options element.

<initiateSession rid="1">
   <securityMode>private</securityMode>
   <userStateAvailability>3500</userStateAvailability>
   <options autoPublishMachineState="true" autoSubscribePresenceForContacts ="false"/>
   <categoryEventFilter>  </categoryEventFilter>
   <debug user="..." password="..." domain="..." tcp="true"/>
</initiateSession>

Share via