Call Connection - Mute

Referens

Tjänst:: Communication

API-version:: 2024-09-15

Stäng av ljudet för deltagare från anropet med hjälp av identifierare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
callConnectionId	path	True	string	Samtalsanslutnings-ID: t.
endpoint	path	True	string url	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En användaråtkomsttoken för Azure Communication Services.
Repeatability-Request-ID		string uuid	Om det anges dirigerar klienten att begäran kan upprepas. det vill säga att klienten kan göra begäran flera gånger med samma repeterbarhet –Request-Id och få tillbaka ett lämpligt svar utan att servern kör begäran flera gånger. Värdet för repeatability-Request-Id är en ogenomskinlig sträng som representerar en klientgenererad unik identifierare för begäran. Det är en version 4 (slumpmässig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Om repeterbarhet –Request-ID rubrik anges måste även repeterbarhetFirst-Sent rubrik anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av IMF-fixdate-formen av HTTP-date. Exempel: Sön, 06 nov 1994 08:49:37 GMT.

Begärandetext

Name	Obligatorisk	Typ	Description
targetParticipants	True	CommunicationIdentifierModel[]	Deltagare som ska stängas av från samtalet. Endast ACS-användare stöds.
operationContext		string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.

Svar

Name	Typ	Description
200 OK	MuteParticipantsResult	Returnerar svar från avstänga deltagare
Other Status Codes	CommunicationErrorResponse	Fel

Säkerhet

Authorization

En användaråtkomsttoken för Azure Communication Services.

Typ: apiKey
I: header

Exempel

CallConnection_Mute

Exempelbegäran

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

Exempelsvar

Statuskod:: 200

{
  "operationContext": "mute participant"
}

Definitioner

Name	Description
MuteParticipantsRequest	Nyttolasten för begäran för att stänga av deltagare från anropet.
MuteParticipantsResult	Resultatnyttolasten för att stänga av deltagare från anropet.

MuteParticipantsRequest

Nyttolasten för begäran för att stänga av deltagare från anropet.

Name	Typ	Description
operationContext	string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.
targetParticipants	CommunicationIdentifierModel[]	Deltagare som ska stängas av från samtalet. Endast ACS-användare stöds.

MuteParticipantsResult

Resultatnyttolasten för att stänga av deltagare från anropet.

Name	Typ	Description
operationContext	string	Åtgärdskontexten som tillhandahålls av klienten.

Dela via