Connect - Connect

サービス:: Communication

API バージョン:: 2025-05-15

CallLocator への接続を作成します。

POST {endpoint}/calling/callConnections:connect?api-version=2025-05-15

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザーアクセストークン。
Repeatability-Request-ID		string (uuid)	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability -Request-Id で要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-Id の値は、クライアントによって生成された要求の一意識別子を表す不透明な文字列です。これはバージョン 4 (ランダム) UUID です。
Repeatability-First-Sent		string (date-time-rfc1123)	Repeatability-Request-ID ヘッダーを指定する場合は、Repeatability-First-Sent ヘッダーも指定する必要があります。値は、要求が最初に作成された日時で、HTTP 日付の IMF-fixdate 形式を使用して表されます。例: Sun, 06 Nov 1994 08:49:37 GMT.

要求本文

名前	必須	型	説明
callLocator	True	CallLocator	呼び出しロケーター。
callbackUri	True	string	コールバック URI。
callIntelligenceOptions		CallIntelligenceOptions	通話の AI オプション。
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	メディアストリーミングオプション。
operationContext		string	顧客が要求を応答イベントに関連付けるために使用されます。
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	文字起こしオプション。

応答

名前	型	説明
200 OK	CallConnectionProperties	callLocator への接続を返します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

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

型: apiKey
/: header

例

Connect

要求のサンプル

HTTP

POST https://contoso.communications.azure.com/calling/callConnections:connect?api-version=2025-05-15

{
  "callbackUri": "https://contoso.communications.azure.com/callback",
  "callLocator": {
    "roomId": "99434917639286209",
    "kind": "roomCallLocator"
  },
  "callIntelligenceOptions": {
    "cognitiveServicesEndpoint": "https://cognitiveservice.com"
  },
  "mediaStreamingOptions": {
    "audioChannelType": "mixed",
    "transportUrl": "string",
    "transportType": "websocket",
    "contentType": "audio",
    "startMediaStreaming": true,
    "enableBidirectional": true,
    "audioFormat": "pcm16KMono",
    "enableDtmfTones": true
  },
  "transcriptionOptions": {
    "locale": "en-US",
    "transportUrl": "string",
    "transportType": "websocket",
    "speechModelEndpointId": "string",
    "startTranscription": true,
    "enableIntermediateResults": true
  }
}

応答のサンプル

状態コード:: 200

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "targets": [],
  "callConnectionState": "connecting",
  "callbackUri": "https://contoso.communications.azure.com/callback",
  "mediaStreamingSubscription": {
    "id": "23dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedContentTypes": [
      "audio"
    ]
  },
  "transcriptionSubscription": {
    "id": "45dea47f-b081-4107-9a5c-4300819d2caa",
    "state": "active",
    "subscribedResultTypes": [
      "final"
    ]
  },
  "answeredFor": {
    "value": "+11234567890"
  }
}

定義

名前	説明
AudioFormat	エンコードに使用されるオーディオ形式 (サンプルレートやチャネルの種類など)。デフォルトは Pcm16KMono です。
CallConnectionProperties	呼び出し接続のプロパティ
CallConnectionStateModel	呼び出し接続の状態。
CallIntelligenceOptions	通話の AI オプション。
CallLocator	通話への参加またはアクションの実行に使用されるロケーター
CallLocatorKind	呼び出しロケーターの種類。
ConnectRequest	CallLocator への接続を作成するための要求ペイロード。
MediaStreamingAudioChannelType	ストリームするオーディオチャネルの種類 (非混合オーディオ、混合オーディオなど)。
MediaStreamingContentType
MediaStreamingSubscription	メディアストリーミングサブスクリプションオブジェクト。
MediaStreamingSubscriptionState	メディアストリーミングサブスクリプションの状態。
StreamingTransportType	ストリーミングに使用するトランスポートの種類を定義します。現在文書化されていない将来の値が導入される可能性があることに注意してください。
TranscriptionResultType
TranscriptionSubscription	文字起こしサブスクリプションオブジェクト。
TranscriptionSubscriptionState	文字起こしサブスクリプションの状態。
WebSocketMediaStreamingOptions	WebSocket トランスポートのオプションを表します。
WebSocketTranscriptionOptions	WebSocket トランスポートのオプションを表します。

AudioFormat

列挙

エンコードに使用されるオーディオ形式 (サンプルレートやチャネルの種類など)。デフォルトは Pcm16KMono です。

値	説明
pcm16KMono
pcm24KMono

CallConnectionProperties

Object

呼び出し接続のプロパティ

名前	型	説明
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	呼び出し接続 ID。
callConnectionState	CallConnectionStateModel	呼び出し接続の状態。
callbackUri	string	コールバック URI。
correlationId	string	関連付け ID。
mediaStreamingSubscription	MediaStreamingSubscription	通話のメディアストリーミングサブスクリプションの状態
serverCallId	string	サーバー呼び出し ID。
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	pstn 番号にダイヤルアウトする場合の通話の表示名。
targets	CommunicationIdentifierModel[]	呼び出しのターゲット。
transcriptionSubscription	TranscriptionSubscription	文字起こしサブスクリプション。

CallConnectionStateModel

列挙

呼び出し接続の状態。

値	説明
unknown
connecting
connected
transferring
transferAccepted
disconnecting
disconnected

CallIntelligenceOptions

Object

通話の AI オプション。

名前	型	説明
cognitiveServicesEndpoint	string	この呼び出しに割り当てられている Cognitive Service リソースの識別子。

CallLocator

Object

通話への参加またはアクションの実行に使用されるロケーター

名前	型	説明
groupCallId	string	グループ呼び出し ID
kind	CallLocatorKind	呼び出しロケーターの種類。
roomId	string	ACS ルーム ID (録音開始ではサポートされていません)
serverCallId	string	サーバー呼び出し ID。

CallLocatorKind

列挙

呼び出しロケーターの種類。

値	説明
groupCallLocator
serverCallLocator
roomCallLocator

ConnectRequest

Object

CallLocator への接続を作成するための要求ペイロード。

名前	型	説明
callIntelligenceOptions	CallIntelligenceOptions	通話の AI オプション。
callLocator	CallLocator	呼び出しロケーター。
callbackUri	string	コールバック URI。
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	メディアストリーミングオプション。
operationContext	string	顧客が要求を応答イベントに関連付けるために使用されます。
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	文字起こしオプション。

MediaStreamingAudioChannelType

列挙

ストリームするオーディオチャネルの種類 (非混合オーディオ、混合オーディオなど)。

値	説明
mixed
unmixed

MediaStreamingContentType

列挙

値	説明
audio

MediaStreamingSubscription

Object

メディアストリーミングサブスクリプションオブジェクト。

名前	型	説明
id	string	サブスクリプション ID。
state	MediaStreamingSubscriptionState	メディアストリーミングサブスクリプションの状態。
subscribedContentTypes	MediaStreamingContentType[]	サブスクライブされたメディアストリーミングコンテンツタイプ。

MediaStreamingSubscriptionState

列挙

メディアストリーミングサブスクリプションの状態。

値	説明
disabled
inactive
active

StreamingTransportType

列挙

ストリーミングに使用するトランスポートの種類を定義します。現在文書化されていない将来の値が導入される可能性があることに注意してください。

値	説明
websocket

TranscriptionResultType

列挙

値	説明
final
intermediate

TranscriptionSubscription

Object

文字起こしサブスクリプションオブジェクト。

名前	型	説明
id	string	サブスクリプション ID。
locale	string	文字起こしに使用するロケールを指定します(例: en-CA や en-AU)。
state	TranscriptionSubscriptionState	文字起こしサブスクリプションの状態。
subscribedResultTypes	TranscriptionResultType[]	サブスクライブされた文字起こしの結果の種類。

TranscriptionSubscriptionState

列挙

文字起こしサブスクリプションの状態。

値	説明
disabled
inactive
active

WebSocketMediaStreamingOptions

Object

WebSocket トランスポートのオプションを表します。

名前	型	説明
audioChannelType	MediaStreamingAudioChannelType	ストリームするオーディオチャネルの種類 (非混合オーディオ、混合オーディオなど)。
audioFormat	AudioFormat	エンコードに使用されるオーディオ形式 (サンプルレートやチャネルの種類など)。デフォルトは Pcm16KMono です。
contentType	MediaStreamingContentType
enableBidirectional	boolean	双方向ストリーミングが有効かどうかを示す値。
enableDtmfTones	boolean	DTMF トーンをストリーミングするかどうかを示す値。
startMediaStreaming	boolean	通話に応答した直後にメディアストリーミングを開始するかどうかを示す値。
transportType	string: websocket	ストリーミングに使用するトランスポートの種類を定義します。現在文書化されていない将来の値が導入される可能性があることに注意してください。
transportUrl	string	メディアストリーミングのトランスポート URL。

WebSocketTranscriptionOptions

Object

WebSocket トランスポートのオプションを表します。

名前	型	説明
enableIntermediateResults	boolean	文字起こしされた音声の中間結果を有効にします。
locale	string	文字起こしに使用するロケールを指定します (例: en-CA や en-AU)。
speechModelEndpointId	string	デプロイされたカスタムモデルの ID (GUID 形式)。 GUID は Azure Speech Studio によって生成されます (例: a259c255-1cdw-4ed7-a693-dd58563b6f6a)。
startTranscription	boolean	通話に応答した直後に文字起こしを開始するかどうかを示します。
transportType	string: websocket	ストリーミングに使用するトランスポートの種類を定義します。現在文書化されていない将来の値が導入される可能性があることに注意してください。
transportUrl	string	ライブ文字起こしの転送に使用される URL。

次の方法で共有

Connect - Connect

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

Connect

要求のサンプル

応答のサンプル

定義

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

CallLocator

CallLocatorKind

ConnectRequest

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions