Create Call - Create Call

Référence

Service:: Communication

Version d'API:: 2025-05-15

Créez un appel sortant.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (url)	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur Azure Communication Services.
Repeatability-Request-ID		string (uuid)	S’il est spécifié, le client indique que la requête est reproductible ; autrement dit, que le client peut effectuer la requête plusieurs fois avec la même répétabilité -Request-Id et récupérer une réponse appropriée sans que le serveur exécute la requête plusieurs fois. La valeur de la répétabilité -Request-Id est une chaîne opaque représentant un identificateur unique généré par le client pour la requête. Il s’agit d’un UUID version 4 (aléatoire).
Repeatability-First-Sent		string (date-time-rfc1123)	Si repeatability-Request-ID en-tête est spécifié, l’en-tête repeatability-First-Sent doit également être spécifié. La valeur doit être la date et l’heure à laquelle la requête a été créée pour la première fois, exprimée à l’aide de la forme IMF-fixdate de la date HTTP. Exemple : Sun, 06 novembre 1994 08:49:37 GMT.

Corps de la demande

Nom	Obligatoire	Type	Description
callbackUri	True	string	URI de rappel.
targets	True	CommunicationIdentifierModel[]	Cibles de l’appel.
callIntelligenceOptions		CallIntelligenceOptions	Options IA pour l’appel.
mediaStreamingOptions		MediaStreamingOptions: WebSocketMediaStreamingOptions	Options de streaming multimédia.
operationContext		string	Valeur définie par le client utilisée pour suivre la réponse d’un appel.
source		CommunicationUserIdentifierModel
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	Nom complet de l’appel si vous composez un numéro rtc
transcriptionOptions		TranscriptionOptions: WebSocketTranscriptionOptions	Options de transcription.

Réponses

Nom	Type	Description
201 Created	CallConnectionProperties	Retourne les détails des propriétés d’appel une fois la requête CreateCall reçue par le service. Vous recevrez l’événement CallConnected à votre URI de rappel spécifié, une fois l’appel connecté.
Other Status Codes	CommunicationErrorResponse	Erreur

Sécurité

Authorization

Jeton d’accès utilisateur Azure Communication Services.

Type: apiKey
Dans: header

Exemples

CreateCall

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
AudioFormat	Format audio utilisé pour l’encodage, y compris la fréquence d’échantillonnage et le type de canal. La valeur par défaut est Pcm16KMono.
CallConnectionProperties	Propriétés d’une connexion d’appel
CallConnectionStateModel	État de la connexion d’appel.
CallIntelligenceOptions	Options IA pour l’appel.
CreateCallRequest	Charge utile de la demande pour la création de l’appel.
MediaStreamingAudioChannelType	Le type de canal audio à diffuser, par exemple, audio non mixé, audio mixte.
MediaStreamingContentType
MediaStreamingSubscription	Objet d’abonnement de streaming multimédia.
MediaStreamingSubscriptionState	État de l’abonnement de diffusion en continu multimédia.
StreamingTransportType	Définit le type de transport utilisé pour la diffusion en continu. Il est à noter que des valeurs futures qui ne sont pas actuellement documentées peuvent être introduites.
TranscriptionResultType
TranscriptionSubscription	Objet d’abonnement de transcription.
TranscriptionSubscriptionState	État de l’abonnement de transcription.
WebSocketMediaStreamingOptions	Représente les options de transport WebSocket.
WebSocketTranscriptionOptions	Représente les options de transport WebSocket.

AudioFormat

Énumération

Format audio utilisé pour l’encodage, y compris la fréquence d’échantillonnage et le type de canal. La valeur par défaut est Pcm16KMono.

Valeur	Description
pcm16KMono
pcm24KMono

CallConnectionProperties

Object

Propriétés d’une connexion d’appel

Nom	Type	Description
answeredBy	CommunicationUserIdentifierModel
answeredFor	PhoneNumberIdentifierModel
callConnectionId	string	ID de connexion d’appel.
callConnectionState	CallConnectionStateModel	État de la connexion d’appel.
callbackUri	string	URI de rappel.
correlationId	string	L’ID de corrélation.
mediaStreamingSubscription	MediaStreamingSubscription	État de l’abonnement de streaming multimédia pour l’appel
serverCallId	string	ID d’appel du serveur.
source	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Nom complet de l’appel si vous composez un numéro rtc.
targets	CommunicationIdentifierModel[]	Cibles de l’appel.
transcriptionSubscription	TranscriptionSubscription	Abonnement de transcription.

CallConnectionStateModel

Énumération

État de la connexion d’appel.

Valeur	Description
connected
connecting
disconnected
disconnecting
transferAccepted
transferring
unknown

CallIntelligenceOptions

Object

Options IA pour l’appel.

Nom	Type	Description
cognitiveServicesEndpoint	string	Identificateur de la ressource Cognitive Service affectée à cet appel.

CreateCallRequest

Object

Charge utile de la demande pour la création de l’appel.

Nom	Type	Description
callIntelligenceOptions	CallIntelligenceOptions	Options IA pour l’appel.
callbackUri	string	URI de rappel.
mediaStreamingOptions	MediaStreamingOptions: WebSocketMediaStreamingOptions	Options de streaming multimédia.
operationContext	string	Valeur définie par le client utilisée pour suivre la réponse d’un appel.
source	CommunicationUserIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	Nom complet de l’appel si vous composez un numéro rtc
targets	CommunicationIdentifierModel[]	Cibles de l’appel.
transcriptionOptions	TranscriptionOptions: WebSocketTranscriptionOptions	Options de transcription.

MediaStreamingAudioChannelType

Énumération

Le type de canal audio à diffuser, par exemple, audio non mixé, audio mixte.

Valeur	Description
mixed
unmixed

MediaStreamingContentType

Énumération

Valeur	Description
audio

MediaStreamingSubscription

Object

Objet d’abonnement de streaming multimédia.

Nom	Type	Description
id	string	ID d’abonnement.
state	MediaStreamingSubscriptionState	État de l’abonnement de diffusion en continu multimédia.
subscribedContentTypes	MediaStreamingContentType[]	Types de contenu de streaming multimédia abonnés.

MediaStreamingSubscriptionState

Énumération

État de l’abonnement de diffusion en continu multimédia.

Valeur	Description
active
disabled
inactive

StreamingTransportType

Énumération

Définit le type de transport utilisé pour la diffusion en continu. Il est à noter que des valeurs futures qui ne sont pas actuellement documentées peuvent être introduites.

Valeur	Description
websocket

TranscriptionResultType

Énumération

Valeur	Description
final
intermediate

TranscriptionSubscription

Object

Objet d’abonnement de transcription.

Nom	Type	Description
id	string	ID d’abonnement.
locale	string	Spécifie les paramètres régionaux utilisés pour la transcription, par exemple, en-CA ou en-AU.
state	TranscriptionSubscriptionState	État de l’abonnement de transcription.
subscribedResultTypes	TranscriptionResultType[]	Types de résultats de transcription abonnés.

TranscriptionSubscriptionState

Énumération

État de l’abonnement de transcription.

Valeur	Description
active
disabled
inactive

WebSocketMediaStreamingOptions

Object

Représente les options de transport WebSocket.

Nom	Type	Description
audioChannelType	MediaStreamingAudioChannelType	Le type de canal audio à diffuser, par exemple, audio non mixé, audio mixte.
audioFormat	AudioFormat	Format audio utilisé pour l’encodage, y compris la fréquence d’échantillonnage et le type de canal. La valeur par défaut est Pcm16KMono.
contentType	MediaStreamingContentType
enableBidirectional	boolean	Valeur indiquant si le streaming bidirectionnel est activé.
enableDtmfTones	boolean	Valeur qui indique si les tonalités DTMF doivent être diffusées en continu.
startMediaStreaming	boolean	Valeur indiquant si la diffusion multimédia en continu doit démarrer immédiatement après la réponse à l’appel.
transportType	string: websocket	Définit le type de transport utilisé pour la diffusion en continu. Il est à noter que des valeurs futures qui ne sont pas actuellement documentées peuvent être introduites.
transportUrl	string	URL de transport pour la diffusion multimédia en continu.

WebSocketTranscriptionOptions

Object

Représente les options de transport WebSocket.

Nom	Type	Description
enableIntermediateResults	boolean	Active les résultats intermédiaires pour la parole transcrite.
locale	string	Spécifie les paramètres régionaux utilisés pour la transcription, par exemple, en-CA ou en-AU.
speechModelEndpointId	string	ID du modèle personnalisé déployé au format GUID. Le GUID est généré par Azure Speech Studio, par exemple, a259c255-1cdw-4ed7-a693-dd58563b6f6a.
startTranscription	boolean	Indique si la transcription doit commencer immédiatement après la réponse à l’appel.
transportType	string: websocket	Définit le type de transport utilisé pour la diffusion en continu. Il est à noter que des valeurs futures qui ne sont pas actuellement documentées peuvent être introduites.
transportUrl	string	URL utilisée pour le transport de la transcription en direct.

Partager via

Create Call - Create Call

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Authorization

Exemples

CreateCall

Exemple de requête

Exemple de réponse

Définitions

AudioFormat

CallConnectionProperties

CallConnectionStateModel

CallIntelligenceOptions

CreateCallRequest

MediaStreamingAudioChannelType

MediaStreamingContentType

MediaStreamingSubscription

MediaStreamingSubscriptionState

StreamingTransportType

TranscriptionResultType

TranscriptionSubscription

TranscriptionSubscriptionState

WebSocketMediaStreamingOptions

WebSocketTranscriptionOptions