Call Connection - Mute

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-09-15

Wycisz uczestników połączenia przy użyciu identyfikatora.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
callConnectionId	path	True	string	Identyfikator połączenia wywołania.
endpoint	path	True	string (url)	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług Azure Communication Services.
Repeatability-Request-ID		string (uuid)	Jeśli zostanie określony, klient kieruje żądanie jest powtarzalne; oznacza to, że klient może wysłać żądanie wiele razy z tą samą powtarzalnością-Request-Id i wrócić odpowiednią odpowiedź bez serwera wykonującego żądanie wiele razy. WartośćRequest-Id powtarzalności jest nieprzezroczystym ciągiem reprezentującym unikatowy identyfikator wygenerowany przez klienta dla żądania. Jest to identyfikator UUID w wersji 4 (losowej).
Repeatability-First-Sent		string (date-time-rfc1123)	Jeśli określono nagłówek Powtarzalność —Request-ID, należy również określić nagłówek powtarzalnośćFirst-Sent. Wartość powinna być datą i godziną, o której po raz pierwszy utworzono żądanie, wyrażoną przy użyciu poprawionej formy HTTP-date mfw. Przykład: Sun, 06 Listopad 1994 08:49:37 GMT.

Treść żądania

Nazwa	Wymagane	Typ	Opis
targetParticipants	True	CommunicationIdentifierModel[]	Uczestnicy, którzy mają być wyciszeni z połączenia. Obsługiwane są tylko użytkownicy usługi ACS.
operationContext		string	Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	MuteParticipantsResult	Zwraca odpowiedź uczestników wyciszenia
Other Status Codes	CommunicationErrorResponse	Błąd

Zabezpieczenia

Authorization

Token dostępu użytkownika usług Azure Communication Services.

Typ: apiKey
W: header

Przykłady

CallConnection_Mute

Przykładowe żądanie

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"
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "operationContext": "mute participant"
}

Definicje

Nazwa	Opis
MuteParticipantsRequest	Ładunek żądania dla wyciszania uczestników z wywołania.
MuteParticipantsResult	Ładunek wyniku dla wyciszania uczestników z wywołania.

MuteParticipantsRequest

Objekt

Ładunek żądania dla wyciszania uczestników z wywołania.

Nazwa	Typ	Opis
operationContext	string	Używany przez klientów podczas wywoływania akcji w połowie wywołania w celu skorelowania żądania ze zdarzeniem odpowiedzi.
targetParticipants	CommunicationIdentifierModel[]	Uczestnicy, którzy mają być wyciszeni z połączenia. Obsługiwane są tylko użytkownicy usługi ACS.

MuteParticipantsResult