Call Connection - Get Participants

Service:

Communication

API Version:

2023-10-15

Rufen Sie Teilnehmer aus einem Anruf ab.

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2023-10-15

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
callConnectionId	path	True	string	Die Anrufverbindungs-ID
endpoint	path	True	string url	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der aufgerufenen API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services Benutzerzugriffstoken.

Antworten

Name	Typ	Beschreibung
200 OK	GetParticipantsResponse	Gibt die Antwort "Teilnehmer abrufen" zurück.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services Benutzerzugriffstoken.

Type: apiKey
In: header

Beispiele

CallConnection_GetParticipants

Sample Request

HTTP

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants?api-version=2023-10-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"
}

Definitionen

Name	Beschreibung
CallParticipant	Ein Anrufteilnehmer.
GetParticipantsResponse	Die Antwortnutzlast zum Abrufen der Teilnehmer des Anrufs.

CallParticipant

Ein Anrufteilnehmer.

Name	Typ	Beschreibung
identifier	CommunicationIdentifierModel
isMuted	boolean	Teilnehmer stummgeschaltet

GetParticipantsResponse

Die Antwortnutzlast zum Abrufen der Teilnehmer des Anrufs.

Name	Typ	Beschreibung
nextLink	string	Weiter mit der Teilnehmerliste
value	CallParticipant[]	Liste der aktuellen Teilnehmer am Anruf.