Call Connection - Get Participants

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Rufen Sie Teilnehmer aus einem Anruf ab. Aufzeichnungs- und Transkriptions-Bots werden aus dieser Liste weggelassen.

GET {endpoint}/calling/callConnections/{callConnectionId}/participants?api-version=2024-09-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 API, die aufgerufen werden soll.

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.

Typ: apiKey
In: header

Beispiele

CallConnection_GetParticipants

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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 von Teilnehmern des Anrufs.

CallParticipant

Ein Anrufteilnehmer.

Name	Typ	Beschreibung
identifier	CommunicationIdentifierModel
isMuted	boolean	Ist Teilnehmer stumm geschaltet
isOnHold	boolean	Ist der Teilnehmer in der Warteschleife.

GetParticipantsResponse

Die Antwortnutzlast zum Abrufen von Teilnehmern des Anrufs.

Name	Typ	Beschreibung
nextLink	string	Fortsetzen der Teilnehmerliste
value	CallParticipant[]	Liste der aktuellen Teilnehmer im Anruf.

Freigeben über