v1

latestOpenAPI 3.1.0MIT License2026-07-17121547.4 KB

ACS Media Session

WebSocket

Create Media Session

Create a new media streaming session for Azure Communication Services.

Initializes a media session with specified audio configuration and returns WebSocket connection details for real-time audio streaming. This endpoint prepares the infrastructure for bidirectional media communication with configurable audio parameters.

Args: request: Media session configuration including call connection ID, audio format, sample rate, and streaming options.

Returns: MediaSessionResponse: Session details containing unique session ID, WebSocket URL for streaming, status, and audio configuration.

Raises: HTTPException: When session creation fails due to invalid configuration or system resource constraints.

Example: >>> request = MediaSessionRequest(call_connection_id="call_123") >>> response = await create_media_session(request) >>> print(response.websocket_url)

post/api/v1/media/sessions

Request body

call_connection_idstring required

ACS call connection identifier

sample_rateinteger nullable

Audio sample rate in Hz

channelsinteger nullable

Number of audio channels

audio_formatstring nullable

Audio format (pcm_16, pcm_24, opus, etc.)

chunk_sizeinteger nullable

Audio chunk size in bytes

enable_transcriptionboolean nullable

Enable real-time transcription

enable_vadboolean nullable

Enable voice activity detection

Example request

{
  "audio_format": "pcm_16",
  "call_connection_id": "call_12345",
  "channels": 1,
  "chunk_size": 1024,
  "enable_transcription": true,
  "enable_vad": true,
  "sample_rate": 16000
}

Response

Successful Response

session_idstring required

Unique media session identifier

websocket_urlstring required

WebSocket URL for audio streaming

statusstring required

Session status

created_atstring required

Session creation timestamp

configurationobject required

Session configuration settings

Example response

{
  "configuration": {
    "channels": 1,
    "chunk_size": 1024,
    "format": "pcm_16",
    "sample_rate": 16000
  },
  "created_at": "2025-08-10T13:45:00Z",
  "session_id": "media_session_123456",
  "status": "active",
  "websocket_url": "wss://api.example.com/v1/media/stream/media_session_123456"
}