Call Connection - Get Participants

Reference

Service:: Communication

API Version:: 2024-09-15

Get participants from a call. Recording and transcription bots are omitted from this list.

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2024-09-15

URI Parameters

Name	In	Required	Type	Description
callConnectionId	path	True	string	The call connection Id
endpoint	path	True	string url	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An Azure Communication Services user access token.

Responses

Name	Type	Description
200 OK	GetParticipantsResponse	Returns the get participants response.
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_GetParticipants

Sample request

HTTP

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants?api-version=2024-09-15

Sample response

Status code:: 200

{
  "value": [
    {
      "identifier": {
        "kind": "communicationUser",
        "communicationUser": {
          "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
        }
      },
      "isMuted": true
    }
  ],
  "nextLink": "string"
}

Definitions

Name	Description
CallParticipant	A call participant.
GetParticipantsResponse	The response payload for getting participants of the call.

CallParticipant

A call participant.

Name	Type	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	Is participant muted
isOnHold	boolean	Is participant on hold.

GetParticipantsResponse

The response payload for getting participants of the call.

Name	Type	Description
nextLink	string	Continue of the list of participants
value	CallParticipant[]	List of the current participants in the call.

Share via