Get a call insights
Use this endpoint to to retrieve media and signalling insights of a voice call.
Command get a call insights
type: object
title: ChannelCall
additionalProperties: false
properties:
id:
$ref: './properties/Id.yml'
channelId:
$ref: '../messages/properties/ChannelId.yml'
from:
type: string
to:
type: string
parentId:
$ref: './properties/Id.yml'
direction:
$ref: './properties/Direction.yml'
status:
$ref: './properties/Status.yml'
type:
$ref: './properties/Type.yml'
duration:
type: integer
hangupCauseCode:
type: integer
hangupSource:
$ref: './properties/HangupSource.yml'
hangupSipCode:
type: string
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
ringingAt:
type: string
format: date-time
answeredAt:
type: string
format: date-time
endedAt:
type: string
format: date-time
signallingMetrics:
$ref: './properties/CallSignallingMetrics.yml'
mediaMetrics:
$ref: './properties/CallMediaMetrics.yml'
required:
- id
- channelId
- from
- to
- status
- type
- direction
- createdAt
- updatedAt
Get a channel call insights
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
callIdstring · uuidRequired
The ID for a call
channelIdstring · uuidRequired
The ID for a channel
Responses
200
OK
application/json
404
The request did not pass validation
application/json
get
GET /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"channelId": "123e4567-e89b-12d3-a456-426614174000",
"from": "text",
"to": "text",
"parentId": "123e4567-e89b-12d3-a456-426614174000",
"direction": "incoming",
"status": "accepted",
"type": "pstn",
"duration": 1,
"hangupCauseCode": 1,
"hangupSource": "callee",
"hangupSipCode": "text",
"createdAt": "2025-07-04T00:22:59.292Z",
"updatedAt": "2025-07-04T00:22:59.292Z",
"ringingAt": "2025-07-04T00:22:59.292Z",
"answeredAt": "2025-07-04T00:22:59.292Z",
"endedAt": "2025-07-04T00:22:59.292Z",
"signallingMetrics": {
"pdd": 1,
"edgeRegion": "text",
"providerName": "text",
"userAgent": "text",
"remoteSignallingIp": "text",
"remoteMediaIp": "text"
},
"mediaMetrics": {
"mos": 1,
"qualityScore": 1,
"inBytes": 1,
"outBytes": 1,
"inPacketCount": 1,
"outPacketCount": 1,
"inMediaPacketCount": 1,
"outMediaPacketCount": 1,
"inDtmfPacketCount": 1,
"outDtmfPacketCount": 1,
"jitterMinVar": 1,
"jitterMaxVar": 1,
"jitterLossRate": 1,
"jitterBurstRate": 1,
"meanInterval": 1,
"flawTotal": 1,
"readCodecName": "text",
"readCodecRate": "text",
"writeCodecName": "text",
"writeCodecRate": "text",
"dtmfType": "text"
}
}
Example 1: Get insights from an outbound call
curl "/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights" \
-H 'Authorization: Bearer {Token}'
Last updated
Was this helpful?