ms:rtc:saas:addMessaging
- JSON
Starts a ms:rtc:saas:messagingInvitation that adds the instant messaging modality to an existing ms:rtc:saas:conversation.
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
The addMessaging resource can be used to add the ms:rtc:saas:messaging modality to an existing peer-to-peer ms:rtc:saas:conversation or multi-party ms:rtc:saas:onlineMeeting.
Properties
None
Links
None
Operations
Starts a ms:rtc:saas:messagingInvitation that adds the instant messaging modality to an existing ms:rtc:saas:conversation.
Request body
Click here to see the input values.
| Name | Description | Required? |
|---|---|---|
| operationId |
The ID that the application supplies to correlate its request with the corresponding operation started in the event channel.
The maximum length is 50 characters. | No |
| The message text to send along with the ms:rtc:saas:messagingInvitation. | No |
Response body
| Item | Description |
|---|---|
| ms:rtc:saas:messagingInvitation | Represents an invitation to a ms:rtc:saas:conversation for the ms:rtc:saas:messaging modality. |
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 | Description |
|---|---|---|---|
| ServiceFailure | 500 | CallbackChannelError | |
| 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.