sendMessage

Article
04/20/2022

Applies to: Skype for Business 2015

Sends an instant message to the participants in a 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

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

Azure Active Directory scopes for online applications

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

Operations

POST

Passes a plain text body to the server and starts a message operation in the event channel.

Query parameters

Name	Description	Required?
operationId	An application-supplied identifier to track the message resource created by the server.	Yes

Request body

Name	Description	Required?
operationId	An application-supplied identifier to track the message resource created by the server.String	Yes

Response body

Item	Description
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	The remote event channel is not reachable
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.

Examples

Only server-supplied query parameters, if any, are shown in the request sample.

JSON Request

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/messaging/sendMessage HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: text/plain
Content-Length: 12
HelloWorld!

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.

HTTP/1.1 201 Created
Location: /ucwa/v1/applications/192/communication/conversations/137/messaging/messages/165

XML Request

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/messaging/sendMessage HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: text/plain
Content-Length: 12

XML Response