Twilio - Insights
The Twilio Insights API offers read‑only REST endpoints that expose analytics and metadata for Twilio Voice and Video services, such as call events, quality metrics, annotations, summaries, conference and participant details, as well as configuration settings for voice and video resources.
Admin: update documentationGET
/v1/Voice/{CallSid}/Events
CallSid ( path , required ) Edge ( query ) PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Conferences
Retrieve a list of Conferences.
ConferenceSid ( query ) — The SID of the conference.FriendlyName ( query ) — Custom label for the conference resource, up to 64 characters.Status ( query ) — Conference status.CreatedAfter ( query ) — Conferences created after the provided timestamp specified in ISO 8601 formatCreatedBefore ( query ) — Conferences created before the provided timestamp specified in ISO 8601 format.MixerRegion ( query ) — Twilio region where the conference media was mixed.Tags ( query ) — Tags applied by Twilio for common potential configuration, quality, or performance issues.Subaccount ( query ) — Account SID for the subaccount whose resources you wish to retrieve.DetectedIssues ( query ) — Potential configuration, behavior, or performance issues detected during the conference.EndReason ( query ) — Conference end reason; e.g. last participant left, modified by API, etc.PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Conferences/{ConferenceSid}
Fetch a specific Conference.
ConferenceSid ( path , required ) — The unique SID identifier of the Conference.GET
/v1/Conferences/{ConferenceSid}/Participants
List Conference Participants.
ConferenceSid ( path , required ) — The unique SID identifier of the Conference.ParticipantSid ( query ) — The unique SID identifier of the Participant.Label ( query ) — User-specified label for a participant.Events ( query ) — Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Conferences/{ConferenceSid}/Participants/{ParticipantSid}
Fetch a specific Conference Participant Summary.
ConferenceSid ( path , required ) — The unique SID identifier of the Conference.ParticipantSid ( path , required ) — The unique SID identifier of the Participant.Events ( query ) — Conference events generated by application or participant activity; e.g. `hold`, `mute`, etc.Metrics ( query ) — Object. Contains participant call quality metrics.GET
/v1/Video/Rooms
Get a list of Programmable Video Rooms.
RoomType ( query ) — Type of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`.Codec ( query ) — Codecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`.RoomName ( query ) — Room friendly name.CreatedAfter ( query ) — Only read rooms that started on or after this ISO 8601 timestamp.CreatedBefore ( query ) — Only read rooms that started before this ISO 8601 timestamp.PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Video/Rooms/{RoomSid}
Get Video Log Analyzer data for a Room.
RoomSid ( path , required ) — The SID of the Room resource.GET
/v1/Video/Rooms/{RoomSid}/Participants
Get a list of room participants.
RoomSid ( path , required ) — The SID of the Room resource.PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Video/Rooms/{RoomSid}/Participants/{ParticipantSid}
Get Video Log Analyzer data for a Room Participant.
RoomSid ( path , required ) — The SID of the Room resource.ParticipantSid ( path , required ) — The SID of the Participant resource.GET
/v1/Voice/Summaries
From ( query ) To ( query ) FromCarrier ( query ) ToCarrier ( query ) FromCountryCode ( query ) ToCountryCode ( query ) Branded ( query ) VerifiedCaller ( query ) HasTag ( query ) StartTime ( query ) EndTime ( query ) CallType ( query ) CallState ( query ) Direction ( query ) ProcessingState ( query ) SortBy ( query ) Subaccount ( query ) AbnormalSession ( query ) AnsweredBy ( query ) PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Voice/{CallSid}/Annotation
Fetch a specific Annotation.
CallSid ( path , required ) — The unique SID identifier of the Call.POST
/v1/Voice/{CallSid}/Annotation
Create/Update the annotation for the call
CallSid ( path , required ) — The unique string that Twilio created to identify this Call resource. It always starts with a CA.GET
/v1/Voice/{CallSid}/Metrics
CallSid ( path , required ) Edge ( query ) Direction ( query ) PageSize ( query , limit ) — How many resources to return in each list page. The default is 50, and the maximum is 1000.Page ( query , page ) — The page index. This value is simply for client state.PageToken ( query ) — The page token. This is provided by the API.GET
/v1/Voice/{CallSid}/Summary
CallSid ( path , required ) ProcessingState ( query )
17 endpoints auto-detected
Authentication
This API uses Basic authentication (a username and password).
curl -X GET \
"https://insights.twilio.com/v1/Voice/{CallSid}/Events" insights.twilio.com · HTTPS only