participant resource type
Namespace: microsoft.graph
Represents a participant in a call.
Methods
| Method | Return Type | Description |
|---|---|---|
| List participant | participant | Retrieve a list of participant objects in the call. |
| Get participant | participant | Read properties of the participant object. |
| Delete participant | None | Delete a participant in a call. |
| Invite | inviteParticipantsOperation | Invite a participant to the call. |
| Mute participant | muteParticipantOperation | Mute a participant in a call. |
| Start hold music | startHoldMusicOperation | Place a participant on hold while playing music on the background. |
| Stop hold music | stopHoldMusicOperation | Reincorporate a participant previously put on hold to the call. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | The participant ID. |
| info | participantInfo | Information about the participant. |
| isInLobby | Boolean | true if the participant is in lobby. |
| isMuted | Boolean | true if the participant is muted (client or server muted). |
| mediaStreams | mediaStream collection | The list of media streams. |
| metadata | String | A blob of data provided by the participant in the roster. |
| recordingInfo | recordingInfo | Information about whether the participant has recording capability. |
| removedState | removedState | Indicates the reason why the participant was removed from the roster. |
| restrictedExperience | onlineMeetingRestricted | Indicates the reason or reasons media content from this participant is restricted. |
| rosterSequenceNumber | Int64 | Indicates the roster sequence number in which the participant was last updated. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"id": "String (identifier)",
"info": {"@odata.type": "#microsoft.graph.participantInfo"},
"isInLobby": "Boolean",
"isMuted": "Boolean",
"mediaStreams": [ { "@odata.type": "#microsoft.graph.mediaStream" } ],
"metadata": "String",
"recordingInfo": { "@odata.type": "#microsoft.graph.recordingInfo" },
"removedState": { "@odata.type": "#microsoft.graph.removedState" },
"restrictedExperience": { "@odata.type": "#microsoft.graph.onlineMeetingRestricted" },
"rosterSequenceNumber": "Int64"
}