messaging
Applies to: Skype for Business 2015
Represents the instant messaging modality in a conversation.
For more on web links, see Web links.
Name | Description |
---|---|
rel | The resource that this link points to. In JSON, this is the outer container. |
href | The location of this resource on the server, and the target of an HTTP operation. |
The presence of messaging in a conversation indicates that the application can use the instant messaging modality.When present, the resource can be used to determine the status of the instant messaging channel,to start or stop instant messaging, as well as to send a single message or a typing notification.The messaging resource is updated whenever message formats are negotiated or the state and capabilities ofthe modality are changed.
Name | Description |
---|---|
negotiatedMessageFormats | A list of the message formats (MessageFormat), such as plain or HTML, that are negotiated for the messaging modality of a conversation. |
state | The state of the modality, such as Connecting, Connected, or Disconnected. |
This resource can have the following relationships.
Link | Description |
---|---|
self | The link to the current resource. |
addMessaging | Starts a messagingInvitation that adds the instant messaging modality to an existing conversation. |
conversation | Represents the local participants perspective on a multi-modal, multi-party communication. |
sendMessage | Sends an instant message to the participants in a conversation. |
setIsTyping | Sets the user's typing status in a conversation. |
stopMessaging | Stops the corresponding instant messaging modality that is currently connecting or connected. |
typingParticipants | Represents a view of the participants who are currently typing a message in a conversation. |
The user must have at least one of these scopes for operations on the resource to be allowed.
Scope | Permission | Description |
---|---|---|
Conversations.Initiate | Initiate conversations and join meetings | Allows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user |
Conversations.Receive | Receive conversation invites | Allows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user |
Resource | Priority | Sender | Reason |
---|---|---|---|
messaging | High | conversation | Indicates that the messaging resource has changed. The application can choose to fetch the updated information. |
Sample of returned event data. This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.
{
"_links" : {
"self" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=1"
},
"next" : {
"href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
}
},
"sender" : [
{
"rel" : "conversation",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
"events" : [
{
"link" : {
"rel" : "messaging",
"href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/messaging"
},
"type" : "updated"
}
]
}
]
}
Returns a representation of the instant messaging modality in a conversation
None
The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.
The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.
Error | Code | Subcode | Description |
---|---|---|---|
ServiceFailure | 500 | InvalidExchangeServerVersion | Invalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature. |
Conflict | 409 | AlreadyExists | The already exists error. |
Conflict | 409 | TooManyGroups | The too many groups error. |
Conflict | 409 | None | Un-supported Service/Resource/API error. |
Gone | 410 | CannotRedirect | Cannot redirect since there is no back up pool configured. |
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/messaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 813
{
"rel" : "messaging",
"negotiatedMessageFormats" : [
"Plain",
"Html"
],
"state" : "Connecting",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/messaging"
},
"addMessaging" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/messaging/addMessaging"
},
"conversation" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137"
},
"sendMessage" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/messaging/sendMessage"
},
"setIsTyping" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/messaging/setIsTyping"
},
"stopMessaging" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/messaging/stopMessaging"
},
"typingParticipants" : {
"href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/typingParticipants"
}
}
}
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/messaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 1065
<?xml version="1.0" encoding="utf-8"?>
<resource rel="messaging" href="/ucwa/v1/applications/192/communication/conversations/137/messaging" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<link rel="addMessaging" href="/ucwa/v1/applications/192/communication/conversations/137/messaging/addMessaging" />
<link rel="conversation" href="/ucwa/v1/applications/192/communication/conversations/137" />
<link rel="sendMessage" href="/ucwa/v1/applications/192/communication/conversations/137/messaging/sendMessage" />
<link rel="setIsTyping" href="/ucwa/v1/applications/192/communication/conversations/137/messaging/setIsTyping" />
<link rel="stopMessaging" href="/ucwa/v1/applications/192/communication/conversations/137/messaging/stopMessaging" />
<link rel="typingParticipants" href="/ucwa/v1/applications/192/communication/conversations/137/participants/typingParticipants" />
<property name="rel">messaging</property>
<propertyList name="negotiatedMessageFormats">
<item>Plain</item>
<item>Html</item>
</propertyList>
<property name="state">Connecting</property>
</resource>