Create Call - Create Call

Referencia

Szolgáltatás:: Communication

API-verzió:: 2025-05-15

Kimenő hívás létrehozása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (url)	Az Azure Communication-erőforrás végpontja.
api-version	query	True	string	A meghívandó API verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	Egy Azure Communication Services felhasználói hozzáférési jogkivonat.
Repeatability-Request-ID		string (uuid)	Ha meg van adva, az ügyfél azt irányítja, hogy a kérés megismételhető legyen; vagyis az ügyfél többször is végrehajthatja a kérést ugyanazzal az ismétlhetőséggel–Request-Id és a megfelelő választ kaphatja vissza anélkül, hogy a kiszolgáló többször hajtja végre a kérést. Az ismétlődésRequest-Id értéke egy átlátszatlan sztring, amely a kérelem ügyfél által létrehozott egyedi azonosítóját jelöli. Ez egy 4-es verziójú (véletlenszerű) UUID.
Repeatability-First-Sent		string (date-time-rfc1123)	Ha az ismételhetőségRequest-ID fejléc van megadva, akkor az Ismételhetőség-First-Sent fejlécet is meg kell adni. Az értéknek a kérelem első létrehozásának dátuma és időpontja kell, hogy legyen, a HTTP-dátum IMF-fixdátum formájában kifejezve. Példa: V, 06 Nov 1994 08:49:37 GMT.

Kérelem törzse

Name	Kötelező	Típus	Description
callbackUri	True	string	A visszahívási URI.
targets	True	CommunicationIdentifierModel[]	A hívás célpontjai.
callIntelligenceOptions		CallIntelligenceOptions	A hívás AI-beállításai.
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	Médiastreamelési beállítások.
operationContext		string	Egy ügyfél által beállított érték, amely egy hívás fogadásának nyomon követésére szolgál.
source		CommunicationUserIdentifierModel
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	A hívás neve, ha pstn-számra tárcsáz
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	Átírási beállítások.

Válaszok

Name	Típus	Description
201 Created	CallConnectionProperties	A hívás tulajdonságainak részleteit adja vissza, miután a CreateCall-kérést megkapta a szolgáltatás. A hívás csatlakoztatása után a callConnected eseményt a megadott visszahívási URI-n fogja megkapni.
Other Status Codes	CommunicationErrorResponse	Hiba

Biztonság

Authorization

Egy Azure Communication Services felhasználói hozzáférési jogkivonat.

Típus: apiKey
In: header

Példák

CreateCall

Mintakérelem

HTTP

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

{
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callbackUri": "https://app.contoso.com/callback",
  "operationContext": "string",
  "callIntelligenceOptions": {
    "cognitiveServicesEndpoint": "string"
  },
  "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
  }
}

Mintaválasz

Állapotkód:: 201

{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "source": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "targets": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_0f50d091-5bd3-448b-884d-44be7037d9b9"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.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"
  }
}

Definíciók

Name	Description
AudioFormat	A kódoláshoz használt hangformátum, beleértve a mintavételezési frekvenciát és a csatornatípust. Az alapértelmezett érték a Pcm16KMono.
CallConnectionProperties	Híváskapcsolat tulajdonságai
CallConnectionStateModel	A híváskapcsolat állapota.
CallIntelligenceOptions	A hívás AI-beállításai.
CreateCallRequest	A hívás létrehozásához szükséges hasznos adatkérés.
MediaStreamingAudioChannelType	A streamelni kívánt hangcsatorna típusa, pl. keveretlen hang, vegyes hang.
MediaStreamingContentType
MediaStreamingSubscription	Médiastreamelő előfizetési objektum.
MediaStreamingSubscriptionState	Médiastreamelési előfizetés állapota.
StreamingTransportType	Meghatározza a streameléshez használt átviteli típust. Vegye figyelembe, hogy a jövőben olyan értékek kerülhetnek bevezetésre, amelyek jelenleg nincsenek dokumentálva.
TranscriptionResultType
TranscriptionSubscription	Átirat-előfizetés objektuma.
TranscriptionSubscriptionState	Átírási előfizetés állapota.
WebSocketMediaStreamingOptions	A WebSocket-átvitel beállításait jelöli.
WebSocketTranscriptionOptions	A WebSocket-átvitel beállításait jelöli.

AudioFormat

Enumerálás

A kódoláshoz használt hangformátum, beleértve a mintavételezési frekvenciát és a csatornatípust. Az alapértelmezett érték a Pcm16KMono.

Érték	Description
pcm16KMono
pcm24KMono

CallConnectionProperties

Objektum

Híváskapcsolat tulajdonságai

Name	Típus	Description
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	A híváskapcsolat azonosítója.
callConnectionState	CallConnectionStateModel	A híváskapcsolat állapota.
callbackUri	string	A visszahívási URI.
correlationId	string	A korrelációs azonosító.
mediaStreamingSubscription	MediaStreamingSubscription	A hívás médiastreamelési előfizetésének állapota
serverCallId	string	A kiszolgáló hívásazonosítója.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	A hívás megjelenítendő neve, ha pstn-számra tárcsáz.
targets	CommunicationIdentifierModel[]	A hívás célpontjai.
transcriptionSubscription	TranscriptionSubscription	Átírási előfizetés.

CallConnectionStateModel

Enumerálás

A híváskapcsolat állapota.

Érték	Description
connected
connecting
disconnected
disconnecting
transferAccepted
transferring
unknown

CallIntelligenceOptions

Objektum

A hívás AI-beállításai.

Name	Típus	Description
cognitiveServicesEndpoint	string	A híváshoz rendelt Cognitive Service-erőforrás azonosítója.

CreateCallRequest

Objektum

A hívás létrehozásához szükséges hasznos adatkérés.

Name	Típus	Description
callIntelligenceOptions	CallIntelligenceOptions	A hívás AI-beállításai.
callbackUri	string	A visszahívási URI.
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	Médiastreamelési beállítások.
operationContext	string	Egy ügyfél által beállított érték, amely egy hívás fogadásának nyomon követésére szolgál.
source	CommunicationUserIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	A hívás neve, ha pstn-számra tárcsáz
targets	CommunicationIdentifierModel[]	A hívás célpontjai.
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	Átírási beállítások.

MediaStreamingAudioChannelType

Enumerálás

A streamelni kívánt hangcsatorna típusa, pl. keveretlen hang, vegyes hang.

Érték	Description
mixed
unmixed

MediaStreamingContentType

Enumerálás

Érték	Description
audio

MediaStreamingSubscription

Objektum

Médiastreamelő előfizetési objektum.

Name	Típus	Description
id	string	Előfizetés azonosítója.
state	MediaStreamingSubscriptionState	Médiastreamelési előfizetés állapota.
subscribedContentTypes	MediaStreamingContentType[]	Előfizetett médiastreamelési tartalomtípusok.

MediaStreamingSubscriptionState

Enumerálás

Médiastreamelési előfizetés állapota.

Érték	Description
active
disabled
inactive

StreamingTransportType

Enumerálás

Meghatározza a streameléshez használt átviteli típust. Vegye figyelembe, hogy a jövőben olyan értékek kerülhetnek bevezetésre, amelyek jelenleg nincsenek dokumentálva.

Érték	Description
websocket

TranscriptionResultType

Enumerálás

Érték	Description
final
intermediate

TranscriptionSubscription

Objektum

Átirat-előfizetés objektuma.

Name	Típus	Description
id	string	Előfizetés azonosítója.
locale	string	Megadja az átíráshoz használt területi beállítást, például en-CA vagy en-AU.
state	TranscriptionSubscriptionState	Átírási előfizetés állapota.
subscribedResultTypes	TranscriptionResultType[]	Előfizetett átírás eredménytípusai.

TranscriptionSubscriptionState

Enumerálás

Átírási előfizetés állapota.

Érték	Description
active
disabled
inactive

WebSocketMediaStreamingOptions

Objektum

A WebSocket-átvitel beállításait jelöli.

Name	Típus	Description
audioChannelType	MediaStreamingAudioChannelType	A streamelni kívánt hangcsatorna típusa, pl. keveretlen hang, vegyes hang.
audioFormat	AudioFormat	A kódoláshoz használt hangformátum, beleértve a mintavételezési frekvenciát és a csatornatípust. Az alapértelmezett érték a Pcm16KMono.
contentType	MediaStreamingContentType
enableBidirectional	boolean	Egy érték, amely jelzi, hogy engedélyezve van-e a kétirányú streamelés.
enableDtmfTones	boolean	Olyan érték, amely jelzi, hogy a DTMF-hangokat továbbítani kell-e.
startMediaStreaming	boolean	Olyan érték, amely azt jelzi, hogy a médiaadatfolyam azonnal elinduljon-e a hívás fogadása után.
transportType	string: websocket	Meghatározza a streameléshez használt átviteli típust. Vegye figyelembe, hogy a jövőben olyan értékek kerülhetnek bevezetésre, amelyek jelenleg nincsenek dokumentálva.
transportUrl	string	A médiaadatfolyam-továbbítás átviteli URL-címe.

WebSocketTranscriptionOptions

Objektum

A WebSocket-átvitel beállításait jelöli.

Name	Típus	Description
enableIntermediateResults	boolean	Lehetővé teszi az átírt beszéd köztes eredményeit.
locale	string	Megadja az átíráshoz használt területi beállítást, például en-CA vagy en-AU.
speechModelEndpointId	string	Az üzembe helyezett egyéni modell azonosítója GUID formátumban. A GUID azonosítót a Azure Speech Studio hozza létre, például a259c255-1cdw-4ed7-a693-dd58563b6f6a.
startTranscription	boolean	Azt jelzi, hogy az átírásnak azonnal el kell-e kezdődnie a hívás fogadása után.
transportType	string: websocket	Meghatározza a streameléshez használt átviteli típust. Vegye figyelembe, hogy a jövőben olyan értékek kerülhetnek bevezetésre, amelyek jelenleg nincsenek dokumentálva.
transportUrl	string	Az élő átírás átviteléhez használt URL-cím.

Megosztás a következőn keresztül:

Create Call - Create Call

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

Authorization

Példák

CreateCall

Mintakérelem

Mintaválasz

Definíciók

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

CreateCallRequest

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions