Call Connection - Mute

Reference

Služba:: Communication

Verze rozhraní API:: 2024-09-15

Ztlumte účastníky z hovoru pomocí identifikátoru.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
callConnectionId	path	True	string	ID připojení volání.
endpoint	path	True	string url	Koncový bod prostředku komunikace Azure.
api-version	query	True	string	Verze rozhraní API k vyvolání

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token služby Azure Communication Services.
Repeatability-Request-ID		string uuid	Pokud je zadáno, klient směruje, že požadavek je opakovatelný; to znamená, že klient může požadavek provést vícekrát se stejnou opakovatelností –Request-Id a získat odpovídající odpověď bez toho, aby server několikrát požadavek spouštěl. Hodnota repeatability-Request-Id je neprůzrný řetězec představující jedinečný identifikátor vygenerovaný klientem pro požadavek. Jedná se o UUID verze 4 (náhodná).
Repeatability-First-Sent		string date-time-rfc1123	Pokud je zadána opakovatelnost –Request-ID hlavička, musí být zadána také opakovatelnost –First-Sent hlavička. Hodnota by měla být datum a čas, kdy byl požadavek poprvé vytvořen, vyjádřený pomocí formuláře HTTP-fixdate. Příklad: Ne, 06 listopad 1994 08:49:37 GMT.

Text požadavku

Name	Vyžadováno	Typ	Description
targetParticipants	True	CommunicationIdentifierModel[]	Účastníci, kteří se mají ztlumit z hovoru. Podporují se jenom uživatelé ACS.
operationContext		string	Zákazníci používají při volání akcí uprostřed volání ke korelaci požadavku s událostí odpovědi.

Odpovědi

Name	Typ	Description
200 OK	MuteParticipantsResult	Vrátí odpověď ztlumení účastníků.
Other Status Codes	CommunicationErrorResponse	Chyba

Zabezpečení

Authorization

Přístupový token služby Azure Communication Services.

Typ: apiKey
V: header

Příklady

CallConnection_Mute

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

{
  "operationContext": "mute participant"
}

Definice

Name	Description
MuteParticipantsRequest	Datová část požadavku pro ztlumení účastníků z hovoru.
MuteParticipantsResult	Výsledná datová část pro ztlumení účastníků z hovoru.

MuteParticipantsRequest

Datová část požadavku pro ztlumení účastníků z hovoru.

Name	Typ	Description
operationContext	string	Zákazníci používají při volání akcí uprostřed volání ke korelaci požadavku s událostí odpovědi.
targetParticipants	CommunicationIdentifierModel[]	Účastníci, kteří se mají ztlumit z hovoru. Podporují se jenom uživatelé ACS.

MuteParticipantsResult

Výsledná datová část pro ztlumení účastníků z hovoru.

Name	Typ	Description
operationContext	string	Kontext operace poskytovaný klientem.

Sdílet prostřednictvím