ms:rtc:saas:sendMessage
- JSON
Sends an instant message to the conversation participants.
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
Applications can use sendMessage to compose an outgoing instant message. This link is available only when the messaging modality is connected.
Properties
None
Links
None
Operations
Passes a plain text body to the server and starts a ms:rtc:saas:message operation in the event channel.
Query parameters
Click here to see the input values.
| Name | Description | Required? |
|---|---|---|
| operationId | An application-supplied identifier to track the message resource created by the server. | Yes |
Request body
Click here to see the input values.
| Name | Description | Required? |
|---|---|---|
| operationId | An application-supplied identifier to track the message resource created by the server. | Yes |
Response body
| Item | Description |
|---|---|
| ms:rtc:saas:message | Represents an instant message sent or received by the local participant. |
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
Only server-supplied query parameters, if any, are shown in the request sample.
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.