Call Connection - Mute

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Stummschalten von Teilnehmern über den Anruf mithilfe der ID.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?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.
Repeatability-Request-ID		string uuid	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-Id und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-Id ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine Version 4 (zufällig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums. Beispiel: Sun, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
targetParticipants	True	CommunicationIdentifierModel[]	Teilnehmer, die vom Anruf stummgeschaltet werden sollen. Nur ACS-Benutzer werden unterstützt.
operationContext		string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.

Antworten

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

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallConnection_Mute

Beispielanforderung

HTTP

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

{
  "targetParticipants": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    }
  ],
  "operationContext": "mute participant"
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "operationContext": "mute participant"
}

Definitionen

Name	Beschreibung
MuteParticipantsRequest	Die Anforderungsnutzlast für das Stummschalten von Teilnehmern vom Anruf.
MuteParticipantsResult	Die Ergebnisnutzlast für das Stummschalten von Teilnehmern aus dem Anruf.

MuteParticipantsRequest

Die Anforderungsnutzlast für das Stummschalten von Teilnehmern vom Anruf.

Name	Typ	Beschreibung
operationContext	string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
targetParticipants	CommunicationIdentifierModel[]	Teilnehmer, die vom Anruf stummgeschaltet werden sollen. Nur ACS-Benutzer werden unterstützt.

MuteParticipantsResult

Die Ergebnisnutzlast für das Stummschalten von Teilnehmern aus dem Anruf.

Name	Typ	Beschreibung
operationContext	string	Der vom Client bereitgestellte Vorgangskontext.

Freigeben über