Call Connection - Cancel Add Participant

Reference

Service:: Communication

API Version:: 2024-09-15

Cancel add participant operation.

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

URI Parameters

Name	In	Required	Type	Description
callConnectionId	path	True	string	The call connection Id
endpoint	path	True	string url	The endpoint of the Azure Communication resource.
api-version	query	True	string	Version of API to invoke.

Request Header

Name	Required	Type	Description
Authorization	True	string	An Azure Communication Services user access token.
Repeatability-Request-ID		string uuid	If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.
Repeatability-First-Sent		string date-time-rfc1123	If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.

Request Body

Name	Required	Type	Description
invitationId	True	string	Invitation ID used to add a participant.
operationCallbackUri		string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext		string	Used by customers when calling mid-call actions to correlate the request to the response event.

Responses

Name	Type	Description
202 Accepted	CancelAddParticipantResponse	Returns the cancelAddParticipant response
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_CancelAddParticipant

Sample request

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

Sample response

Status code:: 202

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

Definitions

Name	Description
CancelAddParticipantRequest	Request payload for cancelling add participant request.
CancelAddParticipantResponse	Response payload for cancel add participant request.

CancelAddParticipantRequest

Request payload for cancelling add participant request.

Name	Type	Description
invitationId	string	Invitation ID used to add a participant.
operationCallbackUri	string	Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext	string	Used by customers when calling mid-call actions to correlate the request to the response event.

CancelAddParticipantResponse

Response payload for cancel add participant request.

Name	Type	Description
invitationId	string	Invitation ID used to cancel the add participant action.
operationContext	string	The operation context provided by client.

Share via