Call Connection - Add Participant

참조

서비스:: Communication

API 버전:: 2024-09-15

통화에 참가자를 추가합니다.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	고객이 대상에 사용자 지정 호출 컨텍스트를 보내는 데 사용
invitationTimeoutInSeconds		integer	초대된 참가자가 픽업될 때까지 대기할 시간 제한을 가져오거나 설정합니다. 이 값의 최대값은 180초입니다.
operationCallbackUri		string	이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext		string	응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(선택 사항) PSTN 참가자 또는 팀 사용자를 추가할 때 이 초대 작업과 연결된 원본의 표시 이름입니다. 참고: 명단의 표시 이름을 업데이트하지 않습니다.

응답

Name	형식	Description
202 Accepted	AddParticipantResponse	서비스에서 참가자 추가 요청을 수락하고 처리를 시작합니다. 지정된 콜백 URI에서 AddParticipantSucceeded 또는 AddParticipantFailed 이벤트를 수신하여 요청 상태를 업데이트합니다.
Other Status Codes	CommunicationErrorResponse	오류

보안

Authorization

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

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

예제

CallConnection_AddParticipant

샘플 요청

HTTP

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

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

샘플 응답

상태 코드:: 202

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

정의

Name	Description
AddParticipantRequest	통화에 참가자를 추가하기 위한 요청 페이로드입니다.
AddParticipantResponse	통화에 참가자를 추가하기 위한 응답 페이로드입니다.
CallParticipant	통화 참가자입니다.
CustomCallingContext	대상에 전송될 사용자 지정 호출 컨텍스트

AddParticipantRequest

통화에 참가자를 추가하기 위한 요청 페이로드입니다.

Name	형식	Description
customCallingContext	CustomCallingContext	고객이 대상에 사용자 지정 호출 컨텍스트를 보내는 데 사용
invitationTimeoutInSeconds	integer	초대된 참가자가 픽업될 때까지 대기할 시간 제한을 가져오거나 설정합니다. 이 값의 최대값은 180초입니다.
operationCallbackUri	string	이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext	string	응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(선택 사항) PSTN 참가자 또는 팀 사용자를 추가할 때 이 초대 작업과 연결된 원본의 표시 이름입니다. 참고: 명단의 표시 이름을 업데이트하지 않습니다.

AddParticipantResponse

통화에 참가자를 추가하기 위한 응답 페이로드입니다.

Name	형식	Description
invitationId	string	참가자를 추가하는 데 사용되는 초대 ID입니다.
operationContext	string	클라이언트에서 제공하는 작업 컨텍스트입니다.
participant	CallParticipant	통화 중인 현재 참가자 목록입니다.

CallParticipant

통화 참가자입니다.

Name	형식	Description
identifier	CommunicationIdentifierModel
isMuted	boolean	참가자 음소거됨
isOnHold	boolean	대기 중인 참가자입니다.

CustomCallingContext

대상에 전송될 사용자 지정 호출 컨텍스트

Name	형식	Description
sipHeaders	object	사용자 지정 호출 컨텍스트 SIP 헤더
voipHeaders	object	사용자 지정 호출 컨텍스트 VoiP 헤더

다음을 통해 공유

Call Connection - Add Participant

URI 매개 변수

요청 헤더

요청 본문

응답

보안

Authorization

예제

CallConnection_AddParticipant

샘플 요청

샘플 응답

정의

AddParticipantRequest

AddParticipantResponse

CallParticipant

CustomCallingContext

추가 리소스