Retrieve call details by call ID

API Reference

Retrieve call details by call ID

Request

Retrieve detailed information about a specific call using its unique identifier.

Security

BasicAuth or SinchOAuth2

Path

projectIdstring, (uuid)(Project ID)required

The ID of the project.

callIdstring, (ulid)(Call ID)required

The ID of the call.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://voice.api.sinch.com/v2/projects/{projectId}/calls/{callId}'

Responses

A call object

Bodyapplication/json

callIdstring, (ulid)(Call ID)required

The `Id`` of the call.

projectIdstring, (uuid)(Project ID)required

The Id of the project associated with the call.

serviceIdstring, (uuid)(Service ID)required

The ID of the service used.

sessionIdstring, (ulid)(Session ID)required

The ID of the session.

directionstring(Call Direction)required

Indicates the direction of the call.

Enum Value	Description
INBOUND	A call initiated towards the Sinch Calling Platform.
OUTBOUND	A call initiated from the Sinch Calling Platform.

originationTypestring(Origination Type)required

Indicates the origin/source of the call.

This describes how the call was initiated (PSTN or via the API).

Enum Value	Description
PHONE	The call originated from the telephone network (PSTN).
SIP	The call originated from a SIP trunk.
SERVER	The call originated through the Sinch API.

callTypestring(Call Type)required

The type of channel used for the call.

This value indicates what kind of endpoint the call is connected to (PSTN phone number or WebSocket stream).

Enum Value	Description
PHONE	A call from or to the telephone network.
SIP	A call from or to a SIP endpoint.
STREAM	A call to a stream.
VOICE_RELAY	A call to voice relay service.

callResultstring(Call Result)required

The outcome/state of the call.

This field includes both transitional states (during call setup and execution) and final states (when the call has ended).

Enum Value	Description
QUEUED	The call is queued for initiation. This is a transitional state.
INITIATED	The call is connecting but the recipient has not yet answered. This is a transitional state.
IN_PROGRESS	The call has been answered and is in progress. This is a transitional state.
COMPLETED	The call was answered and is ended. This is a final state.
REJECTED	The call was rejected by the recipient.
NO_ANSWER	The call was not answered by the recipient.
CANCEL	The call was cancelled.
BUSY	The call was not answered because the recipient was busy.
FAILED	The call could not be completed.

startTimestring, (date-time)required

Timestamp (RFC 3339) indicating when the call was created and call setup was initiated (start of the call attempt).

Example:"2025-01-01 00:00:00+00:00"

callRateobject(Money)required

The rate charged for this call, expressed as a monetary amount per minute in the specified currency.

callResourceUrlstring, (uri)required

Absolute URI to this call resource. Use this URL to retrieve the call details

Example:"https://voice.api.sinch.com/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01AN4Z07BY79KA1307SR9X4MV3"

callNamestring, [ 1 .. 32 ] characters^\S+$

The name identifying this call leg within the session, as assigned by the callName property in the dial command or in the SVAML response to an incoming call webhook.

Omitted for calls that were not assigned a name.

Example:"origin"

bridgeNamestring

The name of the bridge the call belongs to. Omitted for calls not assigned to any bridge.

Example:"my-bridge"

batchIdstring, (ulid)(Batch ID)

The ID of the batch.

fromany(from)

toany(To)

updateTimestring, (date-time)

Timestamp (RFC 3339) indicating when the call was last updated.

Omitted if no updates were performed on this call.

Example:"2025-01-01 00:00:00+00:00"

answerTimestring, (date-time)

Timestamp (RFC 3339) indicating when the call was answered.

Omitted if the call was not answered.

Example:"2025-01-01 00:00:00+00:00"

endTimestring, (date-time)

Timestamp (RFC 3339) indicating when the call ended.

Omitted for ongoing calls.

Example:"2025-01-01 00:00:00+00:00"

callDurationSecondsinteger

Duration of the call in seconds

Example:42

callReasonstring(Call Reason)

Reason explaining why the call ended in the given callResult.

callResult describes what happened (state/outcome). callReason provides additional context about the underlying cause (for example, who terminated the call, routing issues, or validation errors).

Enum Value	Description
OK	The call was completed successfully.
NOT_AVAILABLE	The callee was not available.
CALLER_HANGUP	The caller hung up the call.
CALLEE_HANGUP	The callee hung up the call.
MANAGER_HANGUP	The call was ended by the call manager.
DID_NOT_FOUND	The DID number was not found.
INVALID_SCRIPT	The SVAML script was invalid.
UNKNOWN_PRODUCT	The product associated with the call is unknown.
NO_MORE_ROUTES	There are no more routes to complete the call.
ERROR	An error occurred during the call.

Response

{
  "callId": "01ARZ3NDEKTSV4RRFFQ69G5FAA",
  "projectId": "5c5bf2b1-35ae-4825-ab89-457e07bb60e6",
  "serviceId": "6e124178-c29d-46a5-943c-5c2ae544aade",
  "sessionId": "01BX5ZZKBKACTAV9WEVGEMMVRB",
  "callName": "origin",
  "direction": "OUTBOUND",
  "originationType": "SERVER",
  "callType": "PHONE",
  "callResult": "COMPLETED",
  "callReason": "CALLEE_HANGUP",
  "startTime": "2025-02-10T09:00:00Z",
  "answerTime": "2025-02-10T09:00:05Z",
  "endTime": "2025-02-10T09:00:47Z",
  "callDurationSeconds": 42,
  "from": {
    "type": "PHONE",
    "phone": { … }
  },
  "to": {
    "type": "PHONE",
    "phone": { … }
  },
  "callRate": {
    "currencyCode": "USD",
    "amount": "0.0123"
  },
  "callResourceUrl": "https://voice.api.sinch.com/v2/projects/5c5bf2b1-35ae-4825-ab89-457e07bb60e6/calls/01ARZ3NDEKTSV4RRFFQ69G5FAA"
}

We'd love to hear from you!