communication Dashboard

communication Dashboard

The communication resource gives the user the ability to communicate with other users. This can be via telephone, starting or joining an online meeting, or peer-to-peer messaging. The user can also specify supported incoming modalities and the message format (plain or HTML) she would like to support while communicating with other users.

Resource Representation

The following table contains a representation of the communication resource.

Property bag
"rel" : "communication",
"phoneNumber" : "tel:+14255552222",
"supportedMessageFormats" : [
    "Plain",
    "Html"
],
"supportedModalities" : [
    "PhoneAudio",
    "Messaging"
],
Links
"self" : {
  "href" : "/ucwa/v1/applications/878/communication"
},
"conversations" : {
  "href" : "/ucwa/v1/applications/878/communication/conversations"
},
"joinOnlineMeeting" : {
  "href" : "/ucwa/v1/applications/878/communication/joinOnlineMeeting"
},
"startMessaging" : {
  "href" : "/ucwa/v1/applications/878/communication/startMessaging"
},
"startOnlineMeeting" : {
  "href" : "/ucwa/v1/applications/878/communication/startOnlineMeeting"
},
"startPhoneAudio" : {
  "href" : "/ucwa/v1/applications/878/communication/startPhoneAudio"
}

conversations

Represents the user's ongoing conversations.

conversation

The conversations resource represents a collection of conversation resources, each with information about a particular conversation. This information can be in the form of all the active modalities present in a conversation, conversation state at a given point of time (for example: Conferenced, Connected, Incoming, or In-Lobby), the number of participants in the conversation and so on. Users can get information about the local and remote participants participating in a conversation, and data about adding or deleting different modalities in the conversation.

participants

Participants are those who are taking part in a conversation. A participant resource gives the application author information about members of the conversation. This allows us to distinguish participants by source network; helps us to identify if users are anonymous participants; if they are local or remote; and to identify organizers and provide contact information that will allow the organizers to communicate with conversation participants outside the conversation.

Users can determine which active modalities the local and remote participants are involved in, and can perform various operations such as admitting participants into a conversation, denying entry to participants who are waiting in the lobby, demoting participants to attendees, promoting participants to leaders, and ejecting participants from a conversation.

conversationLogs

The conversationLogs resource serves as a kind of dashboard that represents the history of conversations the user has had as a collection of conversationLog resources.

A conversationLogs resource represents a collection of conversationLog resources.

Resource Representation

The following table contains a representation of the conversationLogs resource.

Property bag
"rel" : "conversationLogs"
Links
"self": {
 "href": "/ucwa/v1/applications/405/communication/conversationLogs"
},
"conversationLog": {
 "href": "/ucwa/v1/applications/405/communication/conversationLogs/conversationLog"
}

joinOnlineMeeting

The joinOnlineMeeting resource enables a user to join an online meeting.

startMessaging

The startMessaging resource starts a messagingInvitation that adds the messaging modality to a new conversation.

startOnlineMeeting

The startOnlineMeeting resource creates and joins an ad hoc multiparty conversation.

startPhoneAudio

The startPhoneAudio resource initiates a call-via-work by starting a phoneAudioInvitation that adds the phoneAudio modality to a new conversation.