Call Media - Hold

서비스:

Communication

API 버전:

2025-05-15

식별자를 사용하여 통화에서 참가자를 대기합니다.

POST {endpoint}/calling/callConnections/{callConnectionId}:hold?api-version=2025-05-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 사용자 액세스 토큰입니다.

요청 본문

Name	필수	형식	Description
targetParticipant	True	CommunicationIdentifierModel
operationCallbackUri		string	이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext		string	응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.
playSourceInfo		PlaySource	대기 중인 동안 재생하라는 메시지가 표시됩니다.

응답

Name	형식	Description
200 OK		참가자 대기 응답을 반환합니다.
Other Status Codes	CommunicationErrorResponse	오류

보안

Authorization

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

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

예제

CallMedia_Hold

샘플 요청

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:hold?api-version=2025-05-15

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
    }
  },
  "playSourceInfo": {
    "kind": "file",
    "file": {
      "uri": "https://some.file.azure.com/sample.wav"
    }
  }
}

샘플 응답

상태 코드:

200

정의

Name	Description
FileSource
HoldRequest	통화에서 참가자를 대기하기 위한 요청 페이로드입니다.
PlaySource
PlaySourceType	재생 소스의 형식을 정의합니다.
SsmlSource
TextSource
VoiceKind	음성 종류 유형

FileSource

Object

Name	형식	Description
uri	string	재생할 오디오 파일의 URI

HoldRequest

Object

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

Name	형식	Description
operationCallbackUri	string	이 작업에 대해 CreateCall/AnswerCall에서 설정한 기본 콜백 URI를 재정의하는 콜백 URI를 설정합니다. 이 설정은 작업별로 수행됩니다. 설정되지 않은 경우 CreateCall/AnswerCall에서 설정한 기본 콜백 URI가 사용됩니다.
operationContext	string	응답 이벤트와 요청을 상호 연결하기 위해 중간 호출 작업을 호출할 때 고객이 사용합니다.
playSourceInfo	PlaySource	대기 중인 동안 재생하라는 메시지가 표시됩니다.
targetParticipant	CommunicationIdentifierModel

PlaySource

Object

Name	형식	Description
file	FileSource	재생에 사용할 파일 원본 정보를 정의합니다.
kind	PlaySourceType	재생 소스의 형식을 정의합니다.
playSourceCacheId	string	관련 미디어를 캐싱하는 데 사용할 식별자를 정의합니다.
ssml	SsmlSource	재생에 사용할 ssml(Speech Synthesis Markup Language) 원본 정보를 정의합니다.
text	TextSource	재생에 사용할 텍스트 원본 정보를 정의합니다.

PlaySourceType

열거형

재생 소스의 형식을 정의합니다.

값	Description
file
text
ssml

SsmlSource

Object

Name	형식	Description
customVoiceEndpointId	string	사용자 지정 음성이 배포된 엔드포인트입니다.
ssmlText	string	재생할 인식 서비스에 대한 Ssml 문자열

TextSource

Object

Name	형식	Description
customVoiceEndpointId	string	사용자 지정 음성이 배포된 엔드포인트입니다.
sourceLocale	string	재생할 원본 언어 로캘은 여기에서 사용 가능한 로캘을 참조하세요.
text	string	재생할 인식 서비스에 대한 텍스트
voiceKind	VoiceKind	음성 종류 유형
voiceName	string	재생할 음성 이름은 여기에서 사용 가능한 텍스트 음성 변환 음성을 참조하세요.

VoiceKind

열거형

음성 종류 유형

값	Description
male
female