voIPReceived Event

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.

Represents an invitation to join a VoIP conversation

Syntax

<voIPReceived>
   ...
</voIPReceived>

Attributes

None.

Element Information

Parent Element

Element	Description
conference	Groups conference-related events.

Child Elements

Element	Occurrence	Description
uri	1	The uri of the caller for the VoIP INVITE
displayName	1	The display name of the user initiating the VoIP invitation
from	1	The from header of the SIP INVITE. This includes the uri and all other parameters in case client needs them
redirectable	1	Indicate the call is redirect able or not.
canReplyWithIM	1	Indicates the originator of the call can participate in an IM conversation
priority	0 or 1	Indicates the priority an Office Communications Server assigned to the VoIP call
isConference Element	0 or 1	Indicates incoming VoIP call is a conference call
subject	0 or 1	The subject line as set by an originating Office Communications Server

Remarks

This event initiates a Voice over IP session. It indicates that another user has invited the logged on user to a VoIP session. For complete information and examples, see the voIPReceived element.

Examples

In this example, Hao Chen has received a VoIP invitation from Naoki at Contoso.com. The device that Naoki is initiating the VoIP from is able to accept an IM reply and can also participate in a voice conversation using telephone handsets.

The Unified Communications client application should read the logged on user's self-presence contact card category to load a list of all of the user's phone numbers into a list on a dialog to display. In addition, the dialog should present the logged on user with the choice of replying to the invitation with a new IM conversation.

<cwaEvents pollWaitTime="1000" ackId="390" sid="14487">
   <conference confId="1" eid="100">
      <voIPReceived>
          <displayName>Naoki Sato</DisplayName>
          <uri>SIP:naokiS@contoso.com</uri>
          <from>"naoki"&lt;naoki@contoso.com&gt;</from>
          <redirectable>True</redirectable>
          <canReplyWithIM>True</canReplyWithIM>
          <priority>urgent</priority>
          <isConference>False</isConference>
          <subject>Project Deadline Extended</subject>
      </voIPReceived>
   </conference>
</cwaEvents>