Call Connection - Mute

Referência

Serviço:: Communication

Versão da API:: 2024-09-15

Silencie os participantes da chamada usando o identificador.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
callConnectionId	path	True	string	A ID de conexão de chamada.
endpoint	path	True	string url	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a invocar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Authorization	True	string	Um token de acesso de usuário dos Serviços de Comunicação do Azure.
Repeatability-Request-ID		string uuid	Se especificado, o cliente direciona que a solicitação é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com o mesmoRequest-Id de repetibilidade e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-Id Repeatability- é uma cadeia de caracteres opaca que representa um identificador exclusivo gerado pelo cliente para a solicitação. É uma versão 4 (aleatória) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Se o cabeçalho Repeatability-Request-ID for especificado, o cabeçalho Repeatability-First-Sent também deverá ser especificado. O valor deve ser a data e a hora em que a solicitação foi criada pela primeira vez, expressa usando a forma IMF-fixdate de HTTP-date. Exemplo: Sun, 06 nov 1994 08:49:37 GMT.

Corpo do Pedido

Name	Necessário	Tipo	Description
targetParticipants	True	CommunicationIdentifierModel[]	Os participantes serão silenciados a partir da chamada. Apenas usuários ACS são suportados.
operationContext		string	Usado por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.

Respostas

Name	Tipo	Description
200 OK	MuteParticipantsResult	Devolve a resposta dos participantes mudos
Other Status Codes	CommunicationErrorResponse	Erro

Segurança

Authorization

Um token de acesso de usuário dos Serviços de Comunicação do Azure.

Tipo: apiKey
Em: header

Exemplos

CallConnection_Mute

Pedido de amostra

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

Resposta da amostra

Código de estado:: 200

{
  "operationContext": "mute participant"
}

Definições

Name	Description
MuteParticipantsRequest	A carga útil da solicitação para silenciar os participantes da chamada.
MuteParticipantsResult	A carga útil resultante para silenciar os participantes da chamada.

MuteParticipantsRequest

A carga útil da solicitação para silenciar os participantes da chamada.

Name	Tipo	Description
operationContext	string	Usado por clientes ao chamar ações de chamada intermediária para correlacionar a solicitação ao evento de resposta.
targetParticipants	CommunicationIdentifierModel[]	Os participantes serão silenciados a partir da chamada. Apenas usuários ACS são suportados.

MuteParticipantsResult

A carga útil resultante para silenciar os participantes da chamada.

Name	Tipo	Description
operationContext	string	O contexto da operação fornecido pelo cliente.

Partilhar via