ms:rtc:saas:message

JSON

Represents an instant message sent or received by the local participant.

Web link

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.

Resource description

Message is started in the event channel for both incoming and outgoing scenarios. For outgoing instant messages, Message allows one to track its delivery status via the event channel. When the message is part of a peer-to-peer conversation, the delivery status merely indicates whether the message was delivered or not to the remote participant. In the multi-party case, the delivery status indicates which of the remote participants failed to receive the message. For incoming instant messages, Message captures information such as the remote particpant who sent the message, the time stamp, and the body of the message. If an incoming instant message is received by UCWA but is not fetched by the application via the event channel in a timely fashion (within 30 seconds), the message will time out and the app will not be able to receive it. Additionally, the sender of the message will be notified that the message wasn't received.

Properties

Name	Description
direction	The Direction of this message, either incoming or outgoing.
htmlMessage	If populated, indicates an HTML message body.
operationId	A application-supplied identifier to correlate an outgoing message started in the event channel using ms:rtc:saas:sendMessage.
status	The delivery Status of this message.
plainMessage	If populated, indicates a plain text message body.
timeStamp	The message's time stamp.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:failedDeliveryParticipant	Represents a ms:rtc:saas:participant that failed to receive an instant message sent by the user.
ms:rtc:saas:messaging	Represents the instant messaging modality in a ms:rtc:saas:conversation.
ms:rtc:saas:participant	Represents a remote participant in a ms:rtc:saas:conversation.

Events

started
completed

Resource	Priority	Sender	Reason
ms:rtc:saas:message	High	ms:rtc:saas:conversation	Delivered when a message is started for an incoming instant message.

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=37"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=37"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:message",
            "href" : "communication/conversations/948/messaging/messages/822"
          },
          "type" : "started"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:message	High	ms:rtc:saas:conversation	Delivered when the message is completed for an incoming instant message.

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=11"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=21"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:message",
            "href" : "communication/conversations/948/messaging/messages/822"
          },
          "type" : "completed"
        }
      ]
    }
  ]
}

Asynchronous reason codes

The completed event is sent on the event channel when the operation is finished. A status value of "success" indicates that the operation completed successfully.A status value of "failure" indicates that the operation failed. In case of failure, the error code and subcode are sent on the event channel.The following table shows the errors that are possible for this resource.

It is recommended that applications handle the error codes shown here. Applications can optionally display subcodes and messages in their user interface.

Conflict

Subcode	Reason
AlreadyExists
None	The request was too large.
None
TooManyGroups

EntityTooLarge

Subcode	Reason
None	The request was too large.

Gone

Subcode	Reason
CannotRedirect

Informational

Subcode	Reason
Ended	The online meeting has ended.

RemoteFailure

Subcode	Reason
NotAllowed	The message body was not understood by the remote participant.
Timeout	The operation has timed out on the callee's end.

ServiceFailure

Subcode	Reason
CallbackChannelError
InvalidExchangeServerVersion
None	The message delivery failed due to Internal Server Error.

Operations

Operation description coming soon...

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

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
ServiceFailure	500	InvalidExchangeServerVersion
Conflict	409	AlreadyExists
Conflict	409	TooManyGroups
Conflict	409	None
Gone	410	CannotRedirect

Examples

Request

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.