Call Connection - Remove Participant

Referencia

Servicio:: Communication

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

Quite un participante de la llamada mediante el identificador .

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:remove?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
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
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
202 Accepted	RemoveParticipantResponse	El servicio ha aceptado la solicitud del participante de eliminación y comenzará a procesarla. Recibirá el evento RemoveParticipantSucceeded o RemoveParticipantFailed en el URI de devolución de llamada especificado para actualizarle el estado de la solicitud.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallConnection_RemoveParticipant

Solicitud de ejemplo

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:remove?api-version=2024-09-15

{
  "participantToRemove": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "removing participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Respuesta de muestra

status code:: 202

{
  "operationContext": "removing participant"
}

Definiciones

Nombre	Description
RemoveParticipantRequest	El participante quita por solicitud de identificador.
RemoveParticipantResponse	Carga de respuesta para quitar participantes de la llamada.

RemoveParticipantRequest

El participante quita por solicitud de identificador.

Nombre	Tipo	Description
operationCallbackUri	string	Establezca un URI de devolución de llamada que invalide el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall para esta operación. Esta configuración es por acción. Si no se establece, se usará el URI de devolución de llamada predeterminado establecido por CreateCall/AnswerCall.
operationContext	string	Lo usan los clientes al llamar a acciones de llamada intermedia para correlacionar la solicitud con el evento de respuesta.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Carga de respuesta para quitar participantes de la llamada.

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

Compartir a través de