다음을 통해 공유

Call Connection - Cancel Add Participant

  • 참조
서비스:
Communication
API 버전:
2024-09-15

참가자 추가 작업을 취소합니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
callConnectionId
 path True

string

통화 연결 ID
endpoint
 path True

string

url

Azure Communication 리소스의 엔드포인트입니다.
api-version
 query True

string

호출할 API의 버전입니다.

요청 헤더

Name 필수 형식 Description
Authorization True

string

Azure Communication Services 사용자 액세스 토큰입니다.
Repeatability-Request-ID

string

uuid

지정된 경우 클라이언트는 요청을 반복할 수 있도록 지시합니다. 즉, 클라이언트가 동일한 반복성Request-Id 요청을 여러 번 수행하고 서버에서 요청을 여러 번 실행하지 않고 적절한 응답을 다시 가져올 수 있습니다. Repeatability-Request-Id 값은 요청에 대해 클라이언트에서 생성된 고유 식별자를 나타내는 불투명 문자열입니다. 버전 4(임의) UUID입니다.
Repeatability-First-Sent

string

date-time-rfc1123

Repeatability-Request-ID 헤더가 지정된 경우 Repeatability-First-Sent 헤더도 지정해야 합니다. 값은 요청이 처음 생성된 날짜 및 시간이어야 하며, HTTP 날짜의 IMF 수정 형식을 사용하여 표현됩니다. 예: 1994년 11월 6일 일요일 08:49:37 GMT.

요청 본문

Name 필수 형식 Description
invitationId True

string

참가자를 추가하는 데 사용되는 초대 ID입니다.
operationCallbackUri

string

이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext

string

응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.

응답

Name 형식 Description
202 Accepted

CancelAddParticipantResponse

cancelAddParticipant 응답을 반환합니다.
Other Status Codes

CommunicationErrorResponse

오류

보안

Authorization

Azure Communication Services 사용자 액세스 토큰입니다.

형식: apiKey
In(다음 안에): header

예제

CallConnection_CancelAddParticipant

샘플 요청

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

샘플 응답

상태 코드:
202 
{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

정의

Name Description
CancelAddParticipantRequest

참가자 추가 요청을 취소하기 위한 요청 페이로드입니다.
CancelAddParticipantResponse

취소에 대한 응답 페이로드는 참가자 요청을 추가합니다.

CancelAddParticipantRequest

참가자 추가 요청을 취소하기 위한 요청 페이로드입니다.

Name 형식 Description
invitationId

string

참가자를 추가하는 데 사용되는 초대 ID입니다.
operationCallbackUri

string

이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext

string

응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.

CancelAddParticipantResponse

취소에 대한 응답 페이로드는 참가자 요청을 추가합니다.

Name 형식 Description
invitationId

string

참가자 추가 작업을 취소하는 데 사용되는 초대 ID입니다.
operationContext

string

클라이언트에서 제공하는 작업 컨텍스트입니다.