title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
List participants |
Retrieve a list of participant objects in the call. |
rahulva-msft |
medium |
cloud-communications |
apiPageType |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Retrieve a list of participant objects in the call.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
Note: Permissions are checked when the call is created; no additional permission check is made when calling this API. Calls.AccessMedia.All is only necessary for calls that use app-hosted media.
GET /app/calls/{id}/participants
GET /communications/calls/{id}/participants
Notes:
- The
/app
path is deprecated. Going forward, use the/communications
path.- This request does not support peer-to-peer calls.
This method supports the OData query parameters to help customize the response.
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Don't supply a request body for this method.
If successful, this method returns a 200 OK
response code and collection of participant objects in the response body.
GET https://graph.microsoft.com/beta/communications/calls/7531d31f-d10d-44de-802f-c569dbca451c/participants
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
HTTP/1.1 200 OK
Content-Type: application/json
{
"value":[
{
"@odata.type":"#microsoft.graph.participant",
"info":{
"@odata.type":"#microsoft.graph.participantInfo",
"identity":{
"@odata.type":"#microsoft.graph.identitySet",
"application":{
"@odata.type":"#microsoft.graph.identity",
"id":"f2fa86af-3c51-4bc2-8fc0-475452d9764f",
"displayName":null
},
"user":null,
"device":null,
"phone":null
},
"id":"eec3812a-fdc3-4fb4-825c-a06c9f35414e"
},
"mediaStreams":[
{
"@odata.type":"#microsoft.graph.mediaStream",
"mediaType":"audio",
"sourceId":"3",
"direction":"sendReceive",
"serverMuted":false,
"label":null
}
],
"isMuted":false,
"isInLobby":false,
"id":"a7ebfb2d-871e-419c-87af-27290b22e8db",
"metadata":null,
"recordingInfo":null,
"preferredDisplayName":null
},
{
"@odata.type":"#microsoft.graph.participant",
"info":{
"@odata.type":"#microsoft.graph.participantInfo",
"identity":{
"@odata.type":"#microsoft.graph.identitySet",
"application":{
"@odata.type":"#microsoft.graph.identity",
"displayName":"Test Participant",
"id":"ef43e42b-4c05-4594-9756-1edb3ccbc989",
"tenantId":"72f988bf-86f1-41af-91ab-2d7cd011db47"
},
"user":null,
"device":null,
"phone":null
},
"id":"278405a3-f568-4b3e-b684-009193463064"
},
"mediaStreams":[
{
"@odata.type":"#microsoft.graph.mediaStream",
"mediaType":"audio",
"sourceId":"1",
"direction":"sendReceive",
"serverMuted":false,
"label":null
}
],
"isMuted":false,
"isInLobby":false,
"id":"1e126418-44a0-4a94-a6f8-0efe1ad71acb",
"metadata":null,
"recordingInfo":null,
"preferredDisplayName":null
}
],
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#communications/calls('7531d31f-d10d-44de-802f-c569dbca451c')/participants"
}