Connect - Connect

Dienst:: Communication

API-Version:: 2025-05-15

Erstellen Sie eine Verbindung mit einem CallLocator.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services-Benutzerzugriffstoken.
Repeatability-Request-ID		string (uuid)	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-Id und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-Id ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine Version 4 (zufällig) UUID.
Repeatability-First-Sent		string (date-time-rfc1123)	Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums. Beispiel: Sun, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
callLocator	True	CallLocator	Der Anruflocator.
callbackUri	True	string	Der Rückruf-URI.
callIntelligenceOptions		CallIntelligenceOptions	KI-Optionen für den Anruf.
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	Medienstreamingoptionen.
operationContext		string	Wird von Kunden verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	Transkriptionsoptionen.

Antworten

Name	Typ	Beschreibung
200 OK	CallConnectionProperties	Gibt eine Verbindung mit einem CallLocator zurück.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

Connect

Beispielanforderung

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
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
AudioFormat	Das Audioformat, das für die Codierung verwendet wird, einschließlich Abtastrate und Kanaltyp. Der Standardwert ist Pcm16KMono.
CallConnectionProperties	Eigenschaften einer Anrufverbindung
CallConnectionStateModel	Der Status der Anrufverbindung.
CallIntelligenceOptions	KI-Optionen für den Anruf.
CallLocator	Der Locator, der für den Beitritt oder die Aktion bei einem Anruf verwendet wird.
CallLocatorKind	Die Art der Anruflocator.
ConnectRequest	Die Anforderungsnutzlast zum Erstellen einer Verbindung mit einem CallLocator.
MediaStreamingAudioChannelType	Der Audiokanaltyp, der gestreamt werden soll, z. B. ungemischtes Audio, gemischtes Audio.
MediaStreamingContentType
MediaStreamingSubscription	Media Streaming Subscription-Objekt.
MediaStreamingSubscriptionState	Status des Medienstreamingabonnements.
StreamingTransportType	Definiert den Transporttyp, der für das Streaming verwendet wird. Beachten Sie, dass zukünftige Werte eingeführt werden können, die derzeit nicht dokumentiert sind.
TranscriptionResultType
TranscriptionSubscription	Subscription-Objekt für Transkription.
TranscriptionSubscriptionState	Status des Transkriptionsabonnements.
WebSocketMediaStreamingOptions	Stellt die Optionen für den WebSocket-Transport dar.
WebSocketTranscriptionOptions	Stellt die Optionen für den WebSocket-Transport dar.

AudioFormat

Enumeration

Das Audioformat, das für die Codierung verwendet wird, einschließlich Abtastrate und Kanaltyp. Der Standardwert ist Pcm16KMono.

Wert	Beschreibung
pcm16KMono
pcm24KMono

CallConnectionProperties

Objekt

Eigenschaften einer Anrufverbindung

Name	Typ	Beschreibung
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	Die Anrufverbindungs-ID.
callConnectionState	CallConnectionStateModel	Der Status der Anrufverbindung.
callbackUri	string	Der Rückruf-URI.
correlationId	string	Die Korrelations-ID.
mediaStreamingSubscription	MediaStreamingSubscription	Der Status des Medienstreamingabonnements für den Anruf
serverCallId	string	Die Serveranruf-ID.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Anzeigename des Anrufs, wenn eine Pstn-Nummer angerufen wird.
targets	CommunicationIdentifierModel[]	Die Ziele des Anrufs.
transcriptionSubscription	TranscriptionSubscription	Transkription-Abonnement.

CallConnectionStateModel

Enumeration

Der Status der Anrufverbindung.

Wert	Beschreibung
unknown
connecting
connected
transferring
transferAccepted
disconnecting
disconnected

CallIntelligenceOptions

Objekt

KI-Optionen für den Anruf.

Name	Typ	Beschreibung
cognitiveServicesEndpoint	string	Der Bezeichner der cognitive Service-Ressource, die diesem Aufruf zugewiesen ist.

CallLocator

Objekt

Der Locator, der für den Beitritt oder die Aktion bei einem Anruf verwendet wird.

Name	Typ	Beschreibung
groupCallId	string	Die Gruppenanruf-ID
kind	CallLocatorKind	Die Art der Anruflocator.
roomId	string	Die ACS-Raum-ID (wird für "Aufzeichnung starten" nicht unterstützt)
serverCallId	string	Die Serveranruf-ID.

CallLocatorKind

Enumeration

Die Art der Anruflocator.

Wert	Beschreibung
groupCallLocator
serverCallLocator
roomCallLocator

ConnectRequest

Objekt

Die Anforderungsnutzlast zum Erstellen einer Verbindung mit einem CallLocator.

Name	Typ	Beschreibung
callIntelligenceOptions	CallIntelligenceOptions	KI-Optionen für den Anruf.
callLocator	CallLocator	Der Anruflocator.
callbackUri	string	Der Rückruf-URI.
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	Medienstreamingoptionen.
operationContext	string	Wird von Kunden verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	Transkriptionsoptionen.

MediaStreamingAudioChannelType

Enumeration

Der Audiokanaltyp, der gestreamt werden soll, z. B. ungemischtes Audio, gemischtes Audio.

Wert	Beschreibung
mixed
unmixed

MediaStreamingContentType

Enumeration

Wert	Beschreibung
audio

MediaStreamingSubscription

Objekt

Media Streaming Subscription-Objekt.

Name	Typ	Beschreibung
id	string	Abonnement-ID.
state	MediaStreamingSubscriptionState	Status des Medienstreamingabonnements.
subscribedContentTypes	MediaStreamingContentType[]	Abonnierte Medienstreaming-Inhaltstypen.

MediaStreamingSubscriptionState

Enumeration

Status des Medienstreamingabonnements.

Wert	Beschreibung
disabled
inactive
active

StreamingTransportType

Enumeration

Definiert den Transporttyp, der für das Streaming verwendet wird. Beachten Sie, dass zukünftige Werte eingeführt werden können, die derzeit nicht dokumentiert sind.

Wert	Beschreibung
websocket

TranscriptionResultType

Enumeration

Wert	Beschreibung
final
intermediate

TranscriptionSubscription

Objekt

Subscription-Objekt für Transkription.

Name	Typ	Beschreibung
id	string	Abonnement-ID.
locale	string	Gibt das Gebietsschema an, das für die Transkription verwendet wird, z. B. en-CA oder en-AU.
state	TranscriptionSubscriptionState	Status des Transkriptionsabonnements.
subscribedResultTypes	TranscriptionResultType[]	Abonnierte Transkriptionsergebnistypen.

TranscriptionSubscriptionState

Enumeration

Status des Transkriptionsabonnements.

Wert	Beschreibung
disabled
inactive
active

WebSocketMediaStreamingOptions

Objekt

Stellt die Optionen für den WebSocket-Transport dar.

Name	Typ	Beschreibung
audioChannelType	MediaStreamingAudioChannelType	Der Audiokanaltyp, der gestreamt werden soll, z. B. ungemischtes Audio, gemischtes Audio.
audioFormat	AudioFormat	Das Audioformat, das für die Codierung verwendet wird, einschließlich Abtastrate und Kanaltyp. Der Standardwert ist Pcm16KMono.
contentType	MediaStreamingContentType
enableBidirectional	boolean	Ein Wert, der angibt, ob bidirektionales Streaming aktiviert ist.
enableDtmfTones	boolean	Ein Wert, der angibt, ob die DTMF-Töne gestreamt werden sollen.
startMediaStreaming	boolean	Ein Wert, der angibt, ob das Medienstreaming unmittelbar nach der Anrufannahme gestartet werden soll.
transportType	string: websocket	Definiert den Transporttyp, der für das Streaming verwendet wird. Beachten Sie, dass zukünftige Werte eingeführt werden können, die derzeit nicht dokumentiert sind.
transportUrl	string	Die Transport-URL für das Medienstreaming.

WebSocketTranscriptionOptions

Objekt

Stellt die Optionen für den WebSocket-Transport dar.

Name	Typ	Beschreibung
enableIntermediateResults	boolean	Aktiviert Zwischenergebnisse für die transkribierte Sprache.
locale	string	Gibt das Gebietsschema an, das für die Transkription verwendet wird, z. B. en-CA oder en-AU.
speechModelEndpointId	string	Die ID des bereitgestellten benutzerdefinierten Modells im GUID-Format. Die GUID wird von Azure Speech Studio generiert, z. B. a259c255-1cdw-4ed7-a693-dd58563b6f6a.
startTranscription	boolean	Gibt an, ob die Transkription unmittelbar nach der Anrufannahme beginnen soll.
transportType	string: websocket	Definiert den Transporttyp, der für das Streaming verwendet wird. Beachten Sie, dass zukünftige Werte eingeführt werden können, die derzeit nicht dokumentiert sind.
transportUrl	string	Die URL, die für den Livetranskriptionstransport verwendet wird.

Freigeben über

Connect - Connect

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

Connect

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

CallLocator

CallLocatorKind

ConnectRequest

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions