Table of contents
me
to
TOC
Collapse the table of content
Expand the table of content

startMessaging2

John Austin|Last Updated: 10/25/2016
|
4 Contributors

Applies to: Skype for Business 2015

        Starts a [messagingInvitation](messagingInvitation_ref.md) that adds the [messaging](messaging_ref.md) modality to a new [conversation](conversation_ref.md). 

For more on web links, see Web links.

NameDescription
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 messagingconversation with a contact.

Properties

None

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.

ScopePermissionDescription
Conversations.InitiateInitiate conversations and join meetingsAllows the app to initiate instant messages, audio, video, and desktop sharing conversations; and join meetings on-behalf of the signed-in user
Conversations.ReceiveReceive conversation invitesAllows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user

Operations

POST

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

Query parameters

NameDescriptionRequired?
toThe target of this invitation.No

Request body

NameDescriptionRequired?
customContentCustom contentExternalResourceNo
importanceThe importance of the Conversation.(Importance)Normal, Urgent, or EmergencyNo
messageThe first message to send along with the instant messaging invitation.ExternalResourceNo
operationIdThe operation ID that an application can use to correlate this operation with the corresponding invitation started in the event channel.The maximum length is 50 characters. StringYes
subjectThe subject of the Conversation.The maximum length is 250 characters. StringNo
threadIdThe thread ID of the conversation.The maximum length is 250 characters. StringNo
toThe destination of this invitation. The input type is a SIP URI.StringNo

Response body

None

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.

ErrorCodeSubcodeDescription
Forbidden403NoneThe target URI does not match the target URI provisioned in anonymous token.
ServiceFailure500CallbackChannelErrorThe remote event channel is not reachable
Conflict409AlreadyExistsThe already exists error.
Conflict409TooManyGroupsThe too many groups error.
Conflict409NoneUn-supported Service/Resource/API error.
Gone410CannotRedirectCannot 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/startMessaging HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 331
{
  "importance" : "Normal",
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "subject" : "SkypeforBusiness",
  "threadId" : "292e0aaef36c426a97757f43dda19d06",
  "to" : "sip : john@contoso.com",
  "_links" : {
    "customContent" : {
      "href" : "data : application/sdp;base64,
      base64-encoded-sdp"
    },
    "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: /ucwa/v1/applications/192/communication/invitations/602

XML Request

Post https://fe1.contoso.com:443/ucwa/v1/applications/192/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="importance">Urgent</property>
  <property name="operationId">74cb7404e0a247d5a2d4eb0376a47dbf</property>
  <property name="subject">Skype for Business</property>
  <property name="threadId">292e0aaef36c426a97757f43dda19d06</property>
  <property name="to">sip:john@contoso.com</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: /ucwa/v1/applications/192/communication/invitations/602
© 2017 Microsoft