# Twilio - Insights API

> Twilio - Insights API on Apizie: 17 endpoints (Get the Voice Insights Settings., Update a specific Voice Insights Setting., Get the Annotation for a specific Call., Update an Annotation for a specific Call., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:twilio-twilio-insights-v1/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:twilio-twilio-insights-v1`
- Category: Communication
- Status: byok
- Source: https://support.twilio.com
- Page: https://apizie.tech/api/communication/twilio-twilio-insights-v1
- OpenAPI: https://apizie.tech/api/communication/twilio-twilio-insights-v1/openapi.json

This is the public Twilio REST API.

## Endpoints

### Get the Voice Insights Settings.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-account-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SubaccountSid | string | no | The unique SID identifier of the Subaccount. |

### Update a specific Voice Insights Setting.
`POST https://apizie.tech/v1/communication:twilio-twilio-insights-v1/update-account-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get the Annotation for a specific Call.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-annotation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CallSid | string | yes | The unique SID identifier of the Call. |

### Update an Annotation for a specific Call.
`POST https://apizie.tech/v1/communication:twilio-twilio-insights-v1/update-annotation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CallSid | string | yes | The unique string that Twilio created to identify this Call resource. It always starts with a CA. |
| body | object | no | Form fields as a JSON object |

### GET /v1/Voice/{Sid}
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Sid | string | yes |  |

### Get a list of Call Summaries.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-call-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| From | string | no | A calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name. |
| To | string | no | A called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name. |
| FromCarrier | string | no | An origination carrier. |
| ToCarrier | string | no | A destination carrier. |
| FromCountryCode | string | no | A source country code based on phone number in From. |
| ToCountryCode | string | no | A destination country code. Based on phone number in To. |
| VerifiedCaller | boolean | no | A boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of 'true' or 'false'. |
| HasTag | boolean | no | A boolean flag indicating the presence of one or more [Voice Insights Call… |
| StartTime | string | no | A Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h. |
| EndTime | string | no | An End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m. |
| CallType | string | no | A Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`. |
| CallState | string | no | A Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`. |
| Direction | string | no | A Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`. |
| ProcessingState | string | no | A Processing State of the Call Summaries. One of `completed`, `partial` or `all`. |
| SortBy | string | no | A Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`. |
| Subaccount | string | no | A unique SID identifier of a Subaccount. |
| AbnormalSession | boolean | no | A boolean flag indicating an abnormal session where the last SIP response was not 200 OK. |
| AnsweredBy | string | no | An Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`,… |
| AnsweredByAnnotation | string | no | Either machine or human. |
| ConnectivityIssueAnnotation | string | no | A Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or… |
| QualityIssueAnnotation | string | no | A subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`,… |
| SpamAnnotation | boolean | no | A boolean flag indicating spam calls. |
| CallScoreAnnotation | string | no | A Call Score of the calls. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for the… |
| BrandedEnabled | boolean | no | A boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of 'true' or 'false' |
| VoiceIntegrityEnabled | boolean | no | A boolean flag indicating whether or not the phone number had voice integrity enabled.One of 'true' or 'false' |
| BrandedBundleSid | string | no | A unique SID identifier of the Branded Call. |
| BrandedLogo | boolean | no | Indicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false… |
| BrandedType | string | no | Indicates whether the Branded Call is in_band vs out_of_band. |
| BrandedUseCase | string | no | Specifies the user-defined purpose for the call, as provided during the setup of in_band branded calling. |
| BrandedCallReason | string | no | Specifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded… |
| VoiceIntegrityBundleSid | string | no | A unique SID identifier of the Voice Integrity Profile. |
| VoiceIntegrityUseCase | string | no | A Voice Integrity Use Case . Is of type enum. One of 'abandoned_cart', 'appointment_reminders', 'appointment_scheduling',… |
| BusinessProfileIdentity | string | no | A Business Identity of the calls. Is of type enum. One of 'direct_customer', 'isv_reseller_or_partner'. |
| BusinessProfileIndustry | string | no | A Business Industry of the calls. Is of type enum. One of 'automotive', 'agriculture', 'banking', 'consumer', 'construction', 'education',… |
| BusinessProfileBundleSid | string | no | A unique SID identifier of the Business Profile. |
| BusinessProfileType | string | no | A Business Profile Type of the calls. Is of type enum. One of 'primary', 'secondary'. |
| PageSize | integer | no | How many resources to return in each list page. The default is 25, and the maximum is 25. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get a specific Conference Summary.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConferenceSid | string | yes | The unique SID identifier of the Conference. |

### Get a list of Conference Summaries.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConferenceSid | string | no | The SID of the conference. |
| FriendlyName | string | no | Custom label for the conference resource, up to 64 characters. |
| Status | string | no | Conference status. |
| CreatedAfter | string | no | Conferences created after the provided timestamp specified in ISO 8601 format |
| CreatedBefore | string | no | Conferences created before the provided timestamp specified in ISO 8601 format. |
| MixerRegion | string | no | Twilio region where the conference media was mixed. |
| Tags | string | no | Tags applied by Twilio for common potential configuration, quality, or performance issues. |
| Subaccount | string | no | Account SID for the subaccount whose resources you wish to retrieve. |
| DetectedIssues | string | no | Potential configuration, behavior, or performance issues detected during the conference. |
| EndReason | string | no | Conference end reason; e.g. last participant left, modified by API, etc. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get a specific Conference Participant Summary for a Conference.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-conference-participant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConferenceSid | string | yes | The unique SID identifier of the Conference. |
| ParticipantSid | string | yes | The unique SID identifier of the Participant. |
| Events | string | no | Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc. |
| Metrics | string | no | Object. Contains participant call quality metrics. |

### Get a list of Conference Participants Summaries for a Conference.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-conference-participant` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ConferenceSid | string | yes | The unique SID identifier of the Conference. |
| ParticipantSid | string | no | The unique SID identifier of the Participant. |
| Label | string | no | User-specified label for a participant. |
| Events | string | no | Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get a list of Call Insight Events for a Call.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CallSid | string | yes | The unique SID identifier of the Call. |
| Edge | string | no | The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get a list of Call Metrics for a Call.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CallSid | string | yes | The unique SID identifier of the Call. |
| Edge | string | no | The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. |
| Direction | string | no | The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get a specific Call Summary.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| CallSid | string | yes | The unique SID identifier of the Call. |
| ProcessingState | string | no | The Processing State of this Call Summary. One of `complete`, `partial` or `all`. |

### Get Video Log Analyzer data for a Room Participant.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-video-participant-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoomSid | string | yes | The SID of the Room resource. |
| ParticipantSid | string | yes | The SID of the Participant resource. |

### Get a list of room participants.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-video-participant-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoomSid | string | yes | The SID of the Room resource. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

### Get Video Log Analyzer data for a Room.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-video-room-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoomSid | string | yes | The SID of the Room resource. |

### Get a list of Programmable Video Rooms.
`GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/list-video-room-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| RoomType | array | no | Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`. |
| Codec | array | no | Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`. |
| RoomName | string | no | Room friendly name. |
| CreatedAfter | string | no | Only read rooms that started on or after this ISO 8601 timestamp. |
| CreatedBefore | string | no | Only read rooms that started before this ISO 8601 timestamp. |
| PageSize | integer | no | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Page | integer | no | The page index. This value is simply for client state. |
| PageToken | string | no | The page token. This is provided by the API. |

## Example
```
curl "https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-account-settings" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Twilio - Insights API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:twilio-twilio-insights-v1/fetch-account-settings with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Twilio - Insights API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Twilio - Insights itself also needs your own key from twilio.

### Can AI agents use the Twilio - Insights API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:twilio-twilio-insights-v1.

### What is the status of the Twilio - Insights API?
Needs your own provider key (bring your own key)