Call Connection - Mute

Referencia

Servicio:: Communication

Versión de la API:: 2024-09-15

Silenciar a los participantes de la llamada mediante el identificador .

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
callConnectionId	path	True	string	Identificador de conexión de llamada.
endpoint	path	True	string url	Punto de conexión del recurso de Comunicación de Azure.
api-version	query	True	string	Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Un token de acceso de usuario de Azure Communication Services.
Repeatability-Request-ID		string uuid	Si se especifica, el cliente dirige que se puede repetir la solicitud; es decir, que el cliente puede realizar la solicitud varias veces con la misma repetibilidad:Request-Id y obtener una respuesta adecuada sin que el servidor ejecute la solicitud varias veces. El valor de repeatability-Request-Id es una cadena opaca que representa un identificador único generado por el cliente para la solicitud. Es un UUID de la versión 4 (aleatorio).
Repeatability-First-Sent		string date-time-rfc1123	Si se especifica repeatability-Request-ID encabezado, también se debe especificar repeatability-First-Sent encabezado. El valor debe ser la fecha y hora en que se creó la solicitud por primera vez, expresada mediante el formato IMF-fixdate de HTTP-date. Ejemplo: Sun, 06 nov 1994 08:49:37 GMT.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
targetParticipants	True	CommunicationIdentifierModel[]	Los participantes que se silenciarán de la llamada. Solo se admiten los usuarios de ACS.
operationContext		string	Lo usan los clientes al llamar a acciones de llamada intermedia para correlacionar la solicitud con el evento de respuesta.

Respuestas

Nombre	Tipo	Description
200 OK	MuteParticipantsResult	Devuelve la respuesta de los participantes silenciados.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallConnection_Mute

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 200

{
  "operationContext": "mute participant"
}

Definiciones

Nombre	Description
MuteParticipantsRequest	Carga de solicitud para silenciar a los participantes de la llamada.
MuteParticipantsResult	La carga del resultado para silenciar a los participantes de la llamada.

MuteParticipantsRequest

Carga de solicitud para silenciar a los participantes de la llamada.

Nombre	Tipo	Description
operationContext	string	Lo usan los clientes al llamar a acciones de llamada intermedia para correlacionar la solicitud con el evento de respuesta.
targetParticipants	CommunicationIdentifierModel[]	Los participantes que se silenciarán de la llamada. Solo se admiten los usuarios de ACS.

MuteParticipantsResult

La carga del resultado para silenciar a los participantes de la llamada.

Nombre	Tipo	Description
operationContext	string	Contexto de operación proporcionado por el cliente.

Compartir a través de