Skip to content Skip to navigation Skip to topbar

On 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:

call progress events , or
Voice SDK quality events .

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

(warning)

Warning

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

(warning)

Warning

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.

(information)

Info

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.

Property nameTypeRequiredDescriptionChild properties

timestampstringOptional

Not PII

Event time.

call_sidSID<CA>Optional

Not PII

The unique SID identifier of the Call.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>Optional

Not PII

The unique SID identifier of the Account.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

edgeenum<string>Optional

Not PII

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

Possible values:

unknown_edgecarrier_edgesip_edgesdk_edgeclient_edge

groupstringOptional

Not PII

Event group.

levelenum<string>Optional

Not PII

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

Possible values:

UNKNOWNDEBUGINFOWARNINGERROR

namestringOptional

Not PII

Event name.

carrier_edgeobjectOptional

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_edgeobjectOptional

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_edgeobjectOptional

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_edgeobjectOptional

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`

Path parameters

Property nameTypeRequiredPIIDescription

CallSidSID<CA>required

Not PII

The unique SID identifier of the Call.

Pattern: ^CA[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

Edgeenum<string>Optional

Not PII

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

Possible values:

unknown_edgecarrier_edgesip_edgesdk_edgeclient_edge

PageSizeintegerOptional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

Read multiple Call Insights Events for a Call

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listEvent() {
11  const events = await client.insights.v1
12    .calls("CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .events.list({ limit: 20 });
14
15  events.forEach((e) => console.log(e.timestamp));
16}
17
18listEvent();

Output

1{
2  "meta": {
3    "page": 0,
4    "page_size": 50,
5    "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0",
6    "previous_page_url": null,
7    "next_page_url": null,
8    "key": "events",
9    "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0"
10  },
11  "events": [
12    {
13      "timestamp": "2019-09-19T22:15:23Z",
14      "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38",
15      "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9",
16      "edge": "sdk_edge",
17      "group": "connection",
18      "name": "error",
19      "level": "ERROR",
20      "sdk_edge": {
21        "error": {
22          "code": 31600
23        },
24        "metadata": {
25          "client_name": "GTI9300323095d271b890c91568931321395",
26          "location": {
27            "lat": 37.4192,
28            "lon": -122.0574
29          },
30          "city": "Mountain View",
31          "country_code": "US",
32          "country_subdivision": "California",
33          "ip_address": "108.177.7.83",
34          "sdk": {
35            "type": "twilio-voice-android",
36            "version": "4.5.1",
37            "platform": "android",
38            "selected_region": "gll",
39            "os": {
40              "name": "android",
41              "version": "4.3"
42            },
43            "device": {
44              "model": "GT-I9300",
45              "type": "GT-I9300",
46              "vendor": "samsung",
47              "arch": "armeabi-v7a"
48            }
49          }
50        }
51      },
52      "client_edge": null,
53      "carrier_edge": null,
54      "sip_edge": null
55    }
56  ]
57}

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

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listEvent() {
11  const events = await client.insights.v1
12    .calls("CAXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13    .events.list({
14      edge: "sdk_edge",
15      limit: 20,
16    });
17
18  events.forEach((e) => console.log(e.timestamp));
19}
20
21listEvent();

Output

1{
2  "meta": {
3    "page": 0,
4    "page_size": 50,
5    "first_page_url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0",
6    "previous_page_url": null,
7    "next_page_url": null,
8    "key": "events",
9    "url": "https://insights.twilio.com/v1/Voice/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events?PageSize=50&Page=0"
10  },
11  "events": [
12    {
13      "timestamp": "2019-09-19T22:15:23Z",
14      "call_sid": "CA03a02b156c6faa96c86906f7e9ad0f38",
15      "account_sid": "AC998c10b68cbfda9f67277f7d8f4439c9",
16      "edge": "sdk_edge",
17      "group": "connection",
18      "name": "error",
19      "level": "ERROR",
20      "sdk_edge": {
21        "error": {
22          "code": 31600
23        },
24        "metadata": {
25          "client_name": "GTI9300323095d271b890c91568931321395",
26          "location": {
27            "lat": 37.4192,
28            "lon": -122.0574
29          },
30          "city": "Mountain View",
31          "country_code": "US",
32          "country_subdivision": "California",
33          "ip_address": "108.177.7.83",
34          "sdk": {
35            "type": "twilio-voice-android",
36            "version": "4.5.1",
37            "platform": "android",
38            "selected_region": "gll",
39            "os": {
40              "name": "android",
41              "version": "4.3"
42            },
43            "device": {
44              "model": "GT-I9300",
45              "type": "GT-I9300",
46              "vendor": "samsung",
47              "arch": "armeabi-v7a"
48            }
49          }
50        }
51      },
52      "client_edge": null,
53      "carrier_edge": null,
54      "sip_edge": null
55    }
56  ]
57}