Menu

Expand
Rate this page:

Call Insights Event Resource

A Call Insights Event is an object representing an event which occurred during a voice call.

Call Events can be:

Using the Call Insights Event Resource, you can read a list of Call Insights Events for a specific voice call.

Voice Insights Advanced Features must be active to use this API Resource.

Voice Insights for mobile SDKs is supported for versions 3.x and later. Calls placed using 2.x mobile SDKs are not supported and details are provided as-is and may not be reliable indicators of actual behavior on the handset.

Events are typically available via the API within 90 seconds.

Call Insights Event properties

The following table details the properties of a single Call Insights Event instance.

Resource Properties in REST API format
timestamp
string Not PII

Event time.

call_sid
sid<CA> Not PII

The unique SID identifier of the Call.

account_sid
sid<AC> Not PII

The unique SID identifier of the Account.

edge
enum:twilio_edge Not PII

The Edge of this Event. One of unknown_edge, carrier_edge, sip_edge, sdk_edge or client_edge.

group
string Not PII

Event group.

level
enum:level Not PII

The Level of this Event. One of UNKNOWN, DEBUG, INFO, WARNING or ERROR.

name
string Not PII

Event name.

carrier_edge
object Not PII

Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio's carrier media gateways.

sip_edge
object Not PII

Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio's public media gateways.

sdk_edge
object Not PII

Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.

client_edge
object Not PII

Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio's Voice SDK media gateways.

Read multiple Call Insights Event resources

get
https://insights.twilio.com/v1/Voice/{CallSid}/Events

Use this action to retrieve a list of Call Insights Events for the specified voice call.

You can use the optional edge parameter to filter the list by media edge. See Understanding Twilio Media Edges for more information.

If no edge parameter is provided, the resulting list will depend on the call type:

Call Type Default Edge Additional Edge
Carrier carrier_edge N/A
SIP sip_edge N/A
Client sdk_edge client_edge
Trunking Originating carrier_edge sip_edge
Trunking Terminating sip_edge carrier_edge

Parameters
Parameters in REST API format
call_sid
Path
get sid<CA> Not PII

The unique SID identifier of the Call.

edge
Optional
get ienum:twilio_edge Not PII

The Edge of this Event. One of unknown_edge, carrier_edge, sip_edge, sdk_edge or client_edge.

Example 1
Loading Code Sample...
        
        

        Read multiple Call Insights Events for a Call

        Example 2
        Loading Code Sample...
              
              

              Read multiple Call Insights Events for a Call filtered by Media Edge

              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

              Loading Code Sample...
                    
                    
                    

                    Thank you for your feedback!

                    Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    thanks-feedback-gif