ms:rtc:saas:startAudio
- JSON
Represents an operation to start AudioVideo. This token indicates the user has ability to start only audio.
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. |
Properties
None
Links
None
Operations
Starts a AudioInvitation and creates a new conversation with a contact.
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 |
| callbackUrl |
Sets the callbackUri of the conversation.
The maximum length is 1024 characters. | No |
| 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 to continue a pre-existing conversation. | No |
| joinAudioMuted | Sets the audio mute status upon joining the online meeting. | No |
Response body
| Item | Description |
|---|---|
| ms:rtc:saas:audioVideoInvitation | Represents an Audio/Video invitation. |
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.