Call Connection - Mute
Stummschalten von Teilnehmern aus dem Anruf mithilfe des Bezeichners.
POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?api-version=2023-10-15
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
call
|
path | True |
string |
Die Anrufverbindungs-ID. |
endpoint
|
path | True |
string url |
Der Endpunkt der Azure Communication-Ressource. |
api-version
|
query | True |
string |
Version der aufzurufenden API. |
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. Das heißt, dass der Client die Anforderung mehrmals mit derselben Repeatability-Request-ID ausführen und eine entsprechende Antwort erhalten kann, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Repeatability-Request-ID ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine (zufällige) Version 4-UUID. |
|
Repeatability-First-Sent |
string date-time-rfc1123 |
Wenn der Header "Repeatability-Request-ID" angegeben ist, muss auch der Header "Repeatability-First-Sent" angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, an dem die Anforderung zum ersten Mal erstellt wurde, ausgedrückt unter Verwendung der IMF-Fixdate-Form http-date. Beispiel: So, 06 Nov 1994 08:49:37 GMT. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
targetParticipants | True |
Communication |
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 |
Gibt die Stummschaltung der Teilnehmerantwort zurück. |
|
Other Status Codes |
Communication |
Fehler |
Sicherheit
Authorization
Ein Azure Communication Services Benutzerzugriffstoken.
Type:
apiKey
In:
header
Beispiele
CallConnection_Mute
Sample Request
POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:mute?api-version=2023-10-15
{
"targetParticipants": [
{
"kind": "communicationUser",
"communicationUser": {
"id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
}
}
],
"operationContext": "mute participant"
}
Sample Response
{
"operationContext": "mute participant"
}
Definitionen
Name | Beschreibung |
---|---|
Mute |
Die Anforderungsnutzlast für das Stummschalten von Teilnehmern aus dem Anruf. |
Mute |
Die Ergebnisnutzlast für das Stummschalten von Teilnehmern aus dem Anruf. |
MuteParticipantsRequest
Die Anforderungsnutzlast für das Stummschalten von Teilnehmern aus dem 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 |
Communication |
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. |