Share via

Call Connection - Get Call

Service:
Communication
API Version:
2025-06-15

Get the detail properties of an ongoing call.

GET {endpoint}/calling/callConnections/{callConnectionId}?api-version=2025-06-15

URI Parameters

Name In Required Type Description
callConnectionId
 path True

string

The call connection id.
endpoint
 path True

string (url)

The endpoint of the Azure Communication resource.
api-version
 query True

string

Version of API to invoke.

Request Header

Name Required Type Description
Authorization True

string

An Azure Communication Services user access token.

Responses

Name Type Description
200 OK

CallConnectionProperties

Returns details of the call properties.
Other Status Codes

CommunicationErrorResponse

Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_GetCall

Sample request

GET https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c?api-version=2025-06-15

Sample response

Status code:
200 
{
  "callConnectionId": "18dea47f-b081-4107-9a5c-4300819d2c6c",
  "serverCallId": "aHR0cHM6Ly9jb252ZXJzYXRpb251cmwvdGVzdA",
  "sourceCallerIdNumber": {
    "value": "+18440123456"
  },
  "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"
      }
    },
    {
      "kind": "phoneNumber",
      "phoneNumber": {
        "value": "+14250123456"
      }
    }
  ],
  "callConnectionState": "connected",
  "callbackUri": "https://app.contoso.com/callback"
}

Definitions

Name Description
CallConnectionProperties

Properties of a call connection
CallConnectionStateModel

The state of the call connection.
MediaStreamingContentType
MediaStreamingSubscription

Media streaming Subscription Object.
MediaStreamingSubscriptionState

Media streaming subscription state.
TranscriptionResultType
TranscriptionSubscription

Transcription Subscription Object.
TranscriptionSubscriptionState

Transcription subscription state.

CallConnectionProperties

Object

Properties of a call connection

Name Type Description
answeredBy

CommunicationUserIdentifierModel

answeredFor

PhoneNumberIdentifierModel

callConnectionId

string

The call connection id.
callConnectionState

CallConnectionStateModel

The state of the call connection.
callbackUri

string

The callback URI.
correlationId

string

The correlation ID.
mediaStreamingSubscription

MediaStreamingSubscription

The state of media streaming subscription for the call
serverCallId

string

The server call id.
source

CommunicationIdentifierModel

sourceCallerIdNumber

PhoneNumberIdentifierModel

sourceDisplayName

string

Display name of the call if dialing out to a pstn number.
targets

CommunicationIdentifierModel[]

The targets of the call.
transcriptionSubscription

TranscriptionSubscription

Transcription Subscription.

CallConnectionStateModel

Enumeration

The state of the call connection.

Value Description
unknown
connecting
connected
transferring
transferAccepted
disconnecting
disconnected

MediaStreamingContentType

Enumeration
Value Description
audio

MediaStreamingSubscription

Object

Media streaming Subscription Object.

Name Type Description
id

string

Subscription Id.
state

MediaStreamingSubscriptionState

Media streaming subscription state.
subscribedContentTypes

MediaStreamingContentType[]

Subscribed media streaming content types.

MediaStreamingSubscriptionState

Enumeration

Media streaming subscription state.

Value Description
disabled
inactive
active

TranscriptionResultType

Enumeration
Value Description
final
intermediate

TranscriptionSubscription

Object

Transcription Subscription Object.

Name Type Description
id

string

Subscription Id.
locale

string

Specifies the locale used for transcription, e.g., en-CA or en-AU.
state

TranscriptionSubscriptionState

Transcription subscription state.
subscribedResultTypes

TranscriptionResultType[]

Subscribed transcription result types.

TranscriptionSubscriptionState

Enumeration

Transcription subscription state.

Value Description
disabled
inactive
active