# Voice SDK Events

## Captured

`com.twilio.voice.insights.call-event.sdk`

Voice SDK Events Captured events are compatible with Webhook and Kinesis sinks. To learn more, you can get started with the [Webhook](/docs/events/webhook-quickstart) or [Kinesis](/docs/events/eventstreams-quickstart) quickstarts and refer to the [product documentation](/docs/voice/voice-insights/advanced-features).

**Examples**

```json
{
  "specversion" : "1.0",
  "type" : "com.twilio.voice.insights.call-event.sdk",
  "source" : "AB00000000000000000000000001",
  "id" : "NO00000000000000000000000001",
  "dataschema" : "https://events-schemas.twilio.com/VoiceInsights.CallEvent/2",
  "datacontenttype" : "2025-10-08T07:17:02.363Z",
  "data" : {
    "timestamp" : "2021-05-24T14:15:22Z",
    "call_sid" : "CA0000000000000000000000000000001",
    "account_sid" : "AC0000000000000000000000000000001",
    "edge" : "ashburn",
    "name" : "call.connected",
    "group" : "call",
    "level" : "UNKNOWN",
    "carrier_edge" : {
      "metadata" : {
        "region" : "us1",
        "twilio_ip" : "172.0.0.130",
        "external_ip" : "172.0.0.130",
        "edge_location" : "ashburn"
      }
    },
    "client_edge" : {
      "metadata" : {
        "region" : "us1",
        "twilio_ip" : "172.0.0.130",
        "external_ip" : "172.0.0.130",
        "edge_location" : "ashburn"
      }
    },
    "sip_edge" : {
      "metadata" : {
        "region" : "us1",
        "twilio_ip" : "172.0.0.130",
        "external_ip" : "172.0.0.130",
        "edge_location" : "ashburn"
      }
    },
    "sdk_edge" : {
      "error" : {
        "code" : 31600,
        "message" : "Call failed due to network issues."
      },
      "feedback" : {
        "score" : 1,
        "reason" : "excellent_audio"
      },
      "metric" : {
        "threshold" : 0.5,
        "values" : [
          0.1
        ]
      },
      "ice_candidate_pair" : {
        "remote" : {
          "type" : "host",
          "protocol" : "udp"
        },
        "local" : {
          "type" : "host",
          "protocol" : "udp"
        }
      },
      "metadata" : {
        "client_name" : "MyVoiceApp",
        "location" : {
          "lat" : 20.956036,
          "lon" : -157.23793
        },
        "city" : "San Francisco",
        "country_code" : "US",
        "country_subdivision" : "CA",
        "ip_address" : "172.0.0.130",
        "sdk" : {
          "type" : "Voice",
          "version" : "2.0.0",
          "platform" : "iOS",
          "region" : "us1",
          "selected_region" : "us1",
          "browser" : {
            "name" : "Chrome",
            "major" : "89",
            "version" : "89.0.4389.90"
          },
          "os" : {
            "name" : "Windows",
            "version" : "10"
          },
          "device" : {
            "model" : "iPhone",
            "type" : "mobile",
            "vendor" : "Apple",
            "arch" : "ARM"
          },
          "engine" : {
            "name" : "Blink",
            "version" : "89.0.4389.90"
          },
          "edge_location" : "ashburn"
        }
      }
    }
  }
}
```

**Versions**

#### v2 (latest)

> \[!NOTE]
>
> v2 only contains updates to the schema metadata. In other words, there are no new fields between v1 and v2.

* `string` **timestamp** (required). The timestamp of the event in ISO 8601 format (e.g., 2021-05-24T14:15:22Z).
* `string` **call\_sid** (required). The unique identifier for the call associated with this event.
* `string` **account\_sid** (required). The unique identifier for the account associated with this event.
* `string` **edge** (required). The Twilio edge location that handled the event.
* `string` **name** (required). The name of the event.
* `string` **group** (required). The group category of the event.
* `string` **level** (required). The level of the event.
* `object` **carrier\_edge**. The data associated with the gateway event.
  * `object` **metadata**. The metadata associated with the gateway event.
    * `string` **region** (required). The region where the gateway is located. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). The Twilio IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). The external IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). The specific edge location of the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **client\_edge**. The data associated with the gateway event.
  * `object` **metadata**. The metadata associated with the gateway event.
    * `string` **region** (required). The region where the gateway is located. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). The Twilio IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). The external IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). The specific edge location of the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **sip\_edge**. The data associated with the gateway event.
  * `object` **metadata**. The metadata associated with the gateway event.
    * `string` **region** (required). The region where the gateway is located. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). The Twilio IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). The external IP address associated with the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). The specific edge location of the gateway. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **sdk\_edge**. The data associated with the client event.
  * `object` **error**. The error information associated with the event.
    * `integer` **code** (required). The error code associated with the event. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **message** (required). The error message associated with the event. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **feedback**. The feedback information associated with the event.
    * `integer` **score** (required). The feedback score associated with the event. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **reason** (required). The reason for the feedback score. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metric**. The metric data associated with the event.
    * `number` **threshold** (required). The threshold value for the metric. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `number[]` **values** (required). The list of metric values. For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **ice\_candidate\_pair**. The selected ICE candidate pair information associated with the event.
    * `object` **remote**. The ICE candidate information associated with the event.
      * `string` **type** (required). The type of ICE candidate (e.g., host, srflx, relay). For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **protocol** (required). The protocol used by the ICE candidate (e.g., udp, tcp, tls). For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **local**. The ICE candidate information associated with the event.
      * `string` **type** (required). The type of ICE candidate (e.g., host, srflx, relay). For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **protocol** (required). The protocol used by the ICE candidate (e.g., udp, tcp, tls). For more information, visit https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metadata**. The metadata associated with the client event.
    * `string` **client\_name** (required). The name of the client application. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **location**. The geographical location information associated with the event.
      * `number` **lat** (required). The latitude coordinate. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `number` **lon** (required). The longitude coordinate. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **city** (required). The city associated with the client's IP address. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **country\_code** (required). The ISO 3166-1 alpha-2 country code associated with the client's IP address. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **country\_subdivision** (required). The subdivision (state/province) associated with the client's IP address. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **ip\_address** (required). The IP address of the client. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **sdk**. The Twilio SDK information associated with the event.
      * `string` **type** (required). The type of Twilio SDK (e.g., Voice, Video). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **version** (required). The version of the Twilio SDK. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **platform** (required). The platform on which the Twilio SDK is running (e.g., iOS, Android, Web). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **region** (required). The region where the SDK is operating. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **selected\_region** (required). The specific region selected by the SDK. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **browser**. The browser information associated with the event.
        * `string` **name** (required). The name of the browser (e.g., Chrome, Firefox, Safari). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **major** (required). The major version of the browser. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). The full version of the browser. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **os**. The operating system information associated with the event.
        * `string` **name** (required). The name of the operating system (e.g., Windows, macOS, Linux). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). The version of the operating system. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **device**. The device information associated with the event.
        * `string` **model** (required). The model of the device (e.g., iPhone, Pixel, Galaxy). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **type** (required). The type of device (e.g., mobile, tablet, desktop). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **vendor** (required). The vendor of the device (e.g., Apple, Samsung, Google). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **arch** (required). The architecture of the device (e.g., ARM, x86). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **engine**. The rendering engine information associated with the event.
        * `string` **name** (required). The name of the rendering engine (e.g., Blink, Gecko, WebKit). https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). The version of the rendering engine. https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **edge\_location** (required). The specific edge location used by the SDK. https://www.twilio.com/docs/voice/insights/api/call-events-resource.

The full specification for version 2 is also available as a [JSON schema](https://events-schemas.twilio.com/VoiceInsights.CallEvent/2).

#### v1

* `string` **timestamp** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **call\_sid** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **account\_sid** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **edge** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **name** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **group** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `string` **level** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **carrier\_edge**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metadata**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **region** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **client\_edge**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metadata**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **region** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **sip\_edge**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metadata**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **region** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **twilio\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **external\_ip** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **edge\_location** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
* `object` **sdk\_edge**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **error**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `integer` **code** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **message** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **feedback**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `integer` **score** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **reason** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metric**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `number` **threshold** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `number[]` **values** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **ice\_candidate\_pair**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **remote**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **type** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **protocol** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **local**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **type** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **protocol** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
  * `object` **metadata**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **client\_name** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **location**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `number` **lat** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `number` **lon** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **city** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **country\_code** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **country\_subdivision** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `string` **ip\_address** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
    * `object` **sdk**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **type** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **version** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **platform** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **region** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **selected\_region** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **browser**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **name** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **major** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **os**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **name** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **device**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **model** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **type** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **vendor** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **arch** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `object` **engine**. Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **name** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
        * `string` **version** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.
      * `string` **edge\_location** (required). Https://www.twilio.com/docs/voice/insights/api/call-events-resource.

The full specification for version 1 is also available as a [JSON schema](https://events-schemas.twilio.com/VoiceInsights.CallEvent/1).