Skype for Business - startMessaging Resource

startMessaging

  • JSON
  • XML

Starts a messagingInvitation that adds the messaging modality to a new 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 startMessaging resource can be used to create a new peer-to-peer messaging conversation with a contact.

Properties

None

Links

None

Operations

  • POST

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

Query parameters

Click here to see the input values.

Name Description Required?
to The target of this invitation. No

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
to The contact that this invitation is to be sent to. Yes
importance The conversation's importance (Importance): Normal, Urgent, or Emergency.

An application can use this as a hint to inform the user.

No
subject The conversation's subject.

The property has a maximum length of 250 characters.

The maximum length is 250 characters.

No
threadId The conversation's thread ID.

An application can use this ID to continue an existing conversation.

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

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

Request

Post https://fe1.contoso.com:443//v1/applications/970/communication/startMessaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 257
{
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "to" : "sip : john@contoso.com",
  "importance" : "Urgent",
  "subject" : "SkypeforBusiness",
  "threadId" : "292e0aaef36c426a97757f43dda19d06",
  "_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/startMessaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 398
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
  <property name="to">sip:john@contoso.com</property>
  <property name="importance">Normal</property>
  <property name="subject">Skype for Business</property>
  <property name="threadId">292e0aaef36c426a97757f43dda19d06</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