Skype for Business - addMessaging Resource

addMessaging

  • JSON
  • XML

Starts a messagingInvitation that adds the instant messaging modality to an existing conversation.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe 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 messaging modality to an existing peer-to-peer conversation or multi-party onlineMeeting.

Properties

None

Links

None

Operations

  • POST

Starts a messagingInvitation that adds the instant messaging modality to an existing 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
message The message text to send along with the messagingInvitation. No

Response body

Item Description
messagingInvitation Represents an invitation to a conversation for the 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
ServiceFailure500CallbackChannelError
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Post https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/messaging/addMessaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 130
{
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "_links" : {
    "message" : {
      "href" : "data : text/plain;base64,
      somebase64encodedmessage"
    }
  }
}
  

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: //v1/applications/970/communication/invitations/212

  

Request

Post https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/messaging/addMessaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 179
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
</input>
  

XML 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: //v1/applications/970/communication/invitations/212