DocumentationEngagement Platform API
Sign inGet started
Guides
API

Get a call insights

Use this endpoint to to retrieve media and signalling insights of a voice call.
GET
/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights
Get a channel call insights
Corps de la réponse
id
string
obligatoire
channelId
string
obligatoire
from
string
obligatoire
to
string
obligatoire
parentId
string
direction
string
obligatoire
Possible values: incoming, outgoing
status
string
obligatoire
Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled
type
string
obligatoire
Possible values: pstn, sip, webrtc
duration
integer
hangupCauseCode
integer
hangupSource
string
Possible values: callee, caller, api, timeout, media-timeout, none
hangupSipCode
string
createdAt
string
obligatoire
updatedAt
string
obligatoire
ringingAt
string
answeredAt
string
endedAt
string
signallingMetrics
object
Afficher les attributs enfants
signallingMetrics.pdd
number
signallingMetrics.edgeRegion
string
signallingMetrics.providerName
string
signallingMetrics.userAgent
string
signallingMetrics.remoteSignallingIp
string
signallingMetrics.remoteMediaIp
string
mediaMetrics
object
Afficher les attributs enfants
mediaMetrics.mos
number
mediaMetrics.qualityScore
number
mediaMetrics.inBytes
number
mediaMetrics.outBytes
number
mediaMetrics.inPacketCount
number
mediaMetrics.outPacketCount
number
mediaMetrics.inMediaPacketCount
number
mediaMetrics.outMediaPacketCount
number
mediaMetrics.inDtmfPacketCount
number
mediaMetrics.outDtmfPacketCount
number
mediaMetrics.jitterMinVar
number
mediaMetrics.jitterMaxVar
number
mediaMetrics.jitterLossRate
number
mediaMetrics.jitterBurstRate
number
mediaMetrics.meanInterval
number
mediaMetrics.flawTotal
number
mediaMetrics.readCodecName
string
mediaMetrics.readCodecRate
string
mediaMetrics.writeCodecName
string
mediaMetrics.writeCodecRate
string
mediaMetrics.dtmfType
string
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Example 1: Get insights from an outbound call

Exemple de code
curl "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/insights" \
     -H "Authorization: AccessKey YOUR_SECRET_TOKEN"