Connect - Connect

サービス:

Communication

API バージョン:

2024-09-15

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

POST {endpoint}/calling/callConnections:connect?api-version=2024-09-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 オプション。
operationContext		string	顧客が要求を応答イベントに関連付けるために使用されます。

応答

名前	型	説明
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=2024-09-15

{
  "callbackUri": "https://contoso.communications.azure.com/callback",
  "callLocator": {
    "roomId": "99434917639286209",
    "kind": "roomCallLocator"
  },
  "callIntelligenceOptions": {
    "cognitiveServicesEndpoint": "https://cognitiveservice.com"
  }
}

応答のサンプル

状態コード:

200

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "targets": [],
  "callConnectionState": "connecting",
  "callbackUri": "https://contoso.communications.azure.com/callback"
}

定義

名前	説明
CallConnectionProperties	呼び出し接続のプロパティ
CallConnectionStateModel	呼び出し接続の状態。
CallIntelligenceOptions	通話の AI オプション。
CallLocator	通話への参加またはアクションの実行に使用されるロケーター
CallLocatorKind	呼び出しロケーターの種類。
ConnectRequest	CallLocator への接続を作成するための要求ペイロード。

CallConnectionProperties

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

名前	型	説明
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	呼び出し接続 ID。
callConnectionState	CallConnectionStateModel	呼び出し接続の状態。
callbackUri	string	コールバック URI。
correlationId	string	関連付け ID。
serverCallId	string	サーバー呼び出し ID。
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	pstn 番号にダイヤルアウトする場合の通話の表示名。
targets	CommunicationIdentifierModel[]	呼び出しのターゲット。

CallConnectionStateModel

呼び出し接続の状態。

名前	型	説明
connected	string
connecting	string
disconnected	string
disconnecting	string
transferAccepted	string
transferring	string
unknown	string

CallIntelligenceOptions

通話の AI オプション。

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

CallLocator

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

名前	型	説明
groupCallId	string	グループ呼び出し ID
kind	CallLocatorKind	呼び出しロケーターの種類。
roomId	string	Acs ルーム ID
serverCallId	string	サーバー呼び出し ID。

CallLocatorKind

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

名前	型	説明
groupCallLocator	string
roomCallLocator	string
serverCallLocator	string

ConnectRequest

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

名前	型	説明
callIntelligenceOptions	CallIntelligenceOptions	通話の AI オプション。
callLocator	CallLocator	呼び出しロケーター。
callbackUri	string	コールバック URI。
operationContext	string	顧客が要求を応答イベントに関連付けるために使用されます。