ms:rtc:saas:addParticipant
- JSON
Invites a contact to participate into a multiparty ms:rtc:saas: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
When a conversation is in peer-to-peer mode, addParticipant will first escalate the conversation from two-party to conferencing, and then will invite the contact to the conversation. When a conversation is multiparty, addParticipant merely invites the contact to the conversation.
Properties
None
Links
None
Operations
Starts a ms:rtc:saas:participantInvitation in the event channel.
Request body
Click here to see the input values.
| Name | Description | Required? |
|---|---|---|
| modalities | The modalities to send on the participant invitation. | No |
| onBehalfOf |
Gets or sets the on behalf of display name.
We will send the display name in our conference invitation. The user receiving the incoming conference invitation will be able to view this display name in the incoming toast. The maximum length is 250 characters. | No |
| operationId |
An application-supplied identifier to track the participantInvitation created by the server.
The maximum length is 50 characters. | Yes |
| subject |
The conversation's subject.
The property has a maximum length of 250 characters. The maximum length is 250 characters. | No |
| to | The URI of the contact who is invited to this conversation. | Yes |
Response body
| Item | Description |
|---|---|
| ms:rtc:saas:participantInvitation | Represents an invitation to an existing ms:rtc:saas: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 |
|---|---|---|---|
| ServiceFailure | 500 | CallbackChannelError | |
| Conflict | 409 | AlreadyExists | |
| Conflict | 409 | TooManyGroups | |
| Conflict | 409 | None | |
| Gone | 410 | CannotRedirect |
Examples
Request
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.