Call Connection - Cancel Add Participant

Referencia

Servicio:: Communication

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

Cancelar la operación agregar participante.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant?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
invitationId	True	string	Id. de invitación usado para agregar un participante.
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	CancelAddParticipantResponse	Devuelve la respuesta cancelAddParticipant.
Other Status Codes	CommunicationErrorResponse	Error

Seguridad

Authorization

Un token de acceso de usuario de Azure Communication Services.

Tipo: apiKey
En: header

Ejemplos

CallConnection_CancelAddParticipant

Solicitud de ejemplo

HTTP

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

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Respuesta de muestra

status code:: 202

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

Definiciones

Nombre	Description
CancelAddParticipantRequest	Solicitud de carga para cancelar la solicitud de agregar participante.
CancelAddParticipantResponse	Carga de respuesta para cancelar la solicitud de agregar participante.

CancelAddParticipantRequest

Solicitud de carga para cancelar la solicitud de agregar participante.

Nombre	Tipo	Description
invitationId	string	Id. de invitación usado para agregar un participante.
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.

CancelAddParticipantResponse

Carga de respuesta para cancelar la solicitud de agregar participante.

Nombre	Tipo	Description
invitationId	string	Id. de invitación usado para cancelar la acción agregar participante.
operationContext	string	Contexto de operación proporcionado por el cliente.

Compartir a través de