Call Media - Hold

サービス:

Communication

API バージョン:

2024-09-15

識別子を使用して通話の参加者を保持します。

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

URI パラメーター

名前	/	必須	型	説明
callConnectionId	path	True	string	呼び出し接続 ID。
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザー アクセス トークン。

要求本文

名前	必須	型	説明
targetParticipant	True	CommunicationIdentifierModel
operationCallbackUri		string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext		string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
playSourceInfo		PlaySource	保留中に再生するように求めるメッセージが表示されます。

応答

名前	型	説明
200 OK		保留参加者の応答を返します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

Azure Communication Services ユーザー アクセス トークン。

型: apiKey
/: header

例

CallMedia_Hold

要求のサンプル

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:hold?api-version=2024-09-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

定義

名前	説明
FileSource
HoldRequest	通話からの参加者を保持するための要求ペイロード。
PlaySource
PlaySourceType	再生ソースの種類を定義します
SsmlSource
TextSource
VoiceKind	音声の種類

FileSource

名前	型	説明
uri	string	再生するオーディオ ファイルの URI

HoldRequest

通話からの参加者を保持するための要求ペイロード。

名前	型	説明
operationCallbackUri	string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext	string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
playSourceInfo	PlaySource	保留中に再生するように求めるメッセージが表示されます。
targetParticipant	CommunicationIdentifierModel

PlaySource

名前	型	説明
file	FileSource	再生に使用するファイル ソース情報を定義します
kind	PlaySourceType	再生ソースの種類を定義します
playSourceCacheId	string	関連メディアのキャッシュに使用する識別子を定義します
ssml	SsmlSource	再生に使用する ssml(Speech Synthesis Markup Language) ソース情報を定義します
text	TextSource	再生に使用するテキスト ソース情報を定義します

PlaySourceType

再生ソースの種類を定義します

名前	型	説明
file	string
ssml	string
text	string

SsmlSource

名前	型	説明
customVoiceEndpointId	string	カスタム音声がデプロイされたエンドポイント。
ssmlText	string	再生するコグニティブ サービスの Ssml 文字列

TextSource

名前	型	説明
customVoiceEndpointId	string	カスタム音声がデプロイされたエンドポイント。
sourceLocale	string	再生するソース言語ロケール ここで使用可能なロケールを参照してください。
text	string	再生するコグニティブ サービスのテキスト
voiceKind	VoiceKind	音声の種類
voiceName	string	再生する音声名 ここで使用可能なテキスト読み上げ音声を参照してください。

VoiceKind

音声の種類

名前	型	説明
female	string
male	string