Skype for Business - addParticipant Resource

addParticipant

  • JSON
  • XML

Invites a contact to participate in a multiparty 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

When a conversation is in peer-to-peer mode, addParticipant will first escalate the conversation from two-party to conferencing, and will then invite the contact to the conversation. When a conversation is multiparty, addParticipant merely invites the contact to the conversation.

Properties

None

Links

None

Operations

  • POST

Starts a participantInvitation in the event channel.

Request body

Click here to see the input values.

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

The maximum length is 50 characters.

No
to The URI of the contact who is invited to this conversation. Yes

Response body

Item Description
participantInvitation Represents an invitation to an existing conversation for an additional 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
ServiceFailure500CallbackChannelError
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Request

Post https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/addParticipant HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Content-Length: 78
{
  "operationId" : "74cb7404e0a247d5a2d4eb0376a47dbf",
  "to" : "sip : john@contoso.com"
}
  

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/647

  

Request

Post https://fe1.contoso.com:443//v1/applications/970/communication/conversations/314/addParticipant HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Content-Length: 230
<?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>
</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/647