components:
schemas:
insights.v1.account_settings:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
advanced_features:
type: boolean
nullable: true
description: >-
A boolean flag indicating whether Advanced Features for Voice
Insights are enabled.
voice_trace:
type: boolean
nullable: true
description: A boolean flag indicating whether Voice Trace is enabled.
url:
type: string
format: uri
nullable: true
description: The URL of this resource.
insights.v1.call.annotation:
type: object
properties:
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Call.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
answered_by:
type: string
$ref: '#/components/schemas/annotation_enum_answered_by'
nullable: true
description: >-
Specifies which entity answered the call as determined by Answering
Machine Detection. Possible enumerated values, one of: `human`,
`machine`. `human` indicates the call was answered by a person.
`machine` indicates the call was answered by an answering machine.
connectivity_issue:
type: string
$ref: '#/components/schemas/annotation_enum_connectivity_issue'
nullable: true
description: >-
Specifies if the call had any connectivity issues. One of
`no_connectivity_issue`, `invalid_number`, `caller_id`,
`dropped_call`, or `number_reachability`.
quality_issues:
type: array
items:
type: string
nullable: true
description: >-
Specifies if the call had any subjective quality issues. Possible
values are one or more of `no_quality_issue`, `low_volume`,
`choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or
`static_noise`.
spam:
type: boolean
nullable: true
description: >-
Specifies if the call was a spam call. Use this to provide feedback
on whether calls placed from your account were marked as spam, or if
inbound calls received by your account were unwanted spam. Is of
type Boolean: true, false. Use true if the call was a spam call.
call_score:
type: integer
nullable: true
description: >-
Specifies the Call Score, if available. This is of type integer. Use
a range of 1-5 to indicate the call experience score, with the
following mapping as a reference for rating the call [5: Excellent,
4: Good, 3 : Fair, 2 : Poor, 1: Bad].
comment:
type: string
nullable: true
description: >-
Specifies any comments pertaining to the call. Twilio does not treat
this field as PII, so no PII should be included in comments.
incident:
type: string
nullable: true
description: >-
Incident or support ticket associated with this call. The `incident`
property is of type string with a maximum character limit of 100.
Twilio does not treat this field as PII, so no PII should be
included in `incident`.
url:
type: string
format: uri
nullable: true
annotation_enum_answered_by:
type: string
enum:
- unknown_answered_by
- human
- machine
annotation_enum_connectivity_issue:
type: string
enum:
- unknown_connectivity_issue
- no_connectivity_issue
- invalid_number
- caller_id
- dropped_call
- number_reachability
annotation_enum_quality_issues:
type: string
enum:
- unknown_quality_issue
- no_quality_issue
- low_volume
- choppy_robotic
- echo
- dtmf
- latency
- owa
- static_noise
insights.v1.call:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
url:
type: string
format: uri
nullable: true
links:
type: object
format: uri-map
nullable: true
insights.v1.call_summaries:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Call.
answered_by:
type: string
$ref: '#/components/schemas/call_summaries_enum_answered_by'
nullable: true
description: >-
The Answered By value for the summarized call based on `Answering
Machine Detection (AMD)`. One of `unknown`, `machine_start`,
`machine_end_beep`, `machine_end_silence`, `machine_end_other`,
`human` or `fax`. Refer to
[AMD](https://www.twilio.com/docs/voice/answering-machine-detection)
for more detail.
call_type:
type: string
$ref: '#/components/schemas/call_summaries_enum_call_type'
nullable: true
description: >-
The Call Type of the summarized Call. One of `carrier`, `sip`,
`trunking` or `client`.
call_state:
type: string
$ref: '#/components/schemas/call_summaries_enum_call_state'
nullable: true
description: >-
The Call State of the summarized Call. One of `ringing`,
`completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`,
`undialed`.
processing_state:
type: string
$ref: '#/components/schemas/call_summaries_enum_processing_state'
nullable: true
description: >-
The Processing State of the Call Summary. The Processing State will
be `partial` until the assembly of the Call Summary finishes, which
occurs approximately 30 minutes after Call end. Then the Processing
State changes to `complete`
created_time:
type: string
format: date-time
nullable: true
description: >-
The time at which the Call was created, given in ISO 8601 format.
Can be different from `start_time` in the event of queueing due to
CPS
start_time:
type: string
format: date-time
nullable: true
description: The time at which the Call was started, given in ISO 8601 format.
end_time:
type: string
format: date-time
nullable: true
description: The time at which the Call was ended, given in ISO 8601 format.
duration:
type: integer
nullable: true
description: Duration between when the call was initiated and the call was ended
connect_duration:
type: integer
nullable: true
description: Duration between when the call was answered and when it ended
from:
nullable: true
description: The calling party.
x-twilio:
pii:
handling: standard
deleteSla: 30
to:
nullable: true
description: The called party.
x-twilio:
pii:
handling: standard
deleteSla: 30
carrier_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
PSTN call.
client_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
Client call.
sdk_edge:
nullable: true
description: >-
Contains metrics and properties for the SDK sensor library for
Client calls.
sip_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
SIP Interface or Trunking call.
tags:
type: array
items:
type: string
nullable: true
description: >-
Tags applied to calls by Voice Insights analysis indicating a
condition that could result in subjective degradation of the call
quality.
url:
type: string
format: uri
nullable: true
description: The URL of this resource.
attributes:
nullable: true
description: Attributes capturing call-flow-specific details.
properties:
nullable: true
description: Contains edge-agnostic call-level details.
trust:
nullable: true
description: >-
Contains trusted communications details including Branded Call and
verified caller ID.
annotation:
nullable: true
call_summaries_enum_answered_by:
type: string
enum:
- unknown
- machine_start
- machine_end_beep
- machine_end_silence
- machine_end_other
- human
- fax
call_summaries_enum_call_type:
type: string
enum:
- carrier
- sip
- trunking
- client
call_summaries_enum_call_state:
type: string
enum:
- ringing
- completed
- busy
- fail
- noanswer
- canceled
- answered
- undialed
call_summaries_enum_processing_state:
type: string
enum:
- complete
- partial
call_summaries_enum_call_direction:
type: string
enum:
- outbound_api
- outbound_dial
- inbound
- trunking_originating
- trunking_terminating
call_summaries_enum_sort_by:
type: string
enum:
- start_time
- end_time
call_summaries_enum_processing_state_request:
type: string
enum:
- completed
- started
- partial
- all
insights.v1.conference:
type: object
properties:
conference_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CF[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Conference.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
friendly_name:
type: string
nullable: true
description: Custom label for the conference resource, up to 64 characters.
x-twilio:
pii:
handling: standard
deleteSla: 30
create_time:
type: string
format: date-time
nullable: true
description: Conference creation date and time in ISO 8601 format.
start_time:
type: string
format: date-time
nullable: true
description: >-
Timestamp in ISO 8601 format when the conference started.
Conferences do not start until at least two participants join, at
least one of whom has startConferenceOnEnter=true.
end_time:
type: string
format: date-time
nullable: true
description: Conference end date and time in ISO 8601 format.
duration_seconds:
type: integer
nullable: true
description: Conference duration in seconds.
connect_duration_seconds:
type: integer
nullable: true
description: >-
Duration of the between conference start event and conference end
event in seconds.
status:
type: string
$ref: '#/components/schemas/conference_enum_conference_status'
nullable: true
description: >-
Status of this Conference; `in_progress`, `not_started`, `completed`
or `summary_timeout`. if Twilio don't receive
`last_participant_left` event, summary will be timeout after 24
hours
max_participants:
type: integer
nullable: true
description: >-
Maximum number of concurrent participants as specified by the
configuration.
max_concurrent_participants:
type: integer
nullable: true
description: Actual maximum number of concurrent participants in the conference.
unique_participants:
type: integer
nullable: true
description: Unique conference participants based on caller ID.
end_reason:
type: string
$ref: '#/components/schemas/conference_enum_conference_end_reason'
nullable: true
description: >-
Conference end reason; e.g. last participant left, modified by API,
etc.
ended_by:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: Call SID of the participant whose actions ended the conference.
mixer_region:
type: string
$ref: '#/components/schemas/conference_enum_region'
nullable: true
description: Twilio region where the conference media was mixed.
mixer_region_requested:
type: string
$ref: '#/components/schemas/conference_enum_region'
nullable: true
description: >-
Twilio region where conference mixed was specified to be mixed in
configuration.
recording_enabled:
type: boolean
nullable: true
description: >-
Boolean. Indicates whether recording was enabled at the conference
mixer.
detected_issues:
nullable: true
description: Potential issues detected by Twilio during the conference.
tags:
type: array
items:
type: string
$ref: '#/components/schemas/conference_enum_tag'
nullable: true
description: >-
Tags for detected conference conditions and participant behaviors
which may be of interest.
tag_info:
nullable: true
description: Object. Contains details about conference tags including severity.
processing_state:
type: string
$ref: '#/components/schemas/conference_enum_processing_state'
nullable: true
description: >-
Processing state for the Conference Summary resource. Will be
`in_progress` while data is being aggregated, `timeout` if Twilio
couldn't process the summary in 24hrs, and `complete` once
aggregations and analysis has ended.
url:
type: string
format: uri
nullable: true
description: The URL of this resource.
links:
type: object
format: uri-map
nullable: true
description: >-
Contains a dictionary of URL links to nested resources of this
Conference.
conference_enum_conference_status:
type: string
enum:
- in_progress
- not_started
- completed
- summary_timeout
conference_enum_conference_end_reason:
type: string
enum:
- last_participant_left
- conference_ended_via_api
- participant_with_end_conference_on_exit_left
- last_participant_kicked
- participant_with_end_conference_on_exit_kicked
conference_enum_region:
type: string
enum:
- us1
- au1
- br1
- ie1
- jp1
- sg1
- de1
conference_enum_tag:
type: string
enum:
- invalid_requested_region
- duplicate_identity
- start_failure
- region_configuration_issues
- quality_warnings
- participant_behavior_issues
- high_packet_loss
- high_jitter
- high_latency
- low_mos
- detected_silence
conference_enum_processing_state:
type: string
enum:
- complete
- in_progress
- timeout
insights.v1.conference.conference_participant:
type: object
properties:
participant_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CP[0-9a-fA-F]{32}$
nullable: true
description: SID for this participant.
label:
type: string
nullable: true
description: The user-specified label of this participant.
x-twilio:
pii:
handling: standard
deleteSla: 30
conference_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CF[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Conference.
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: >-
Unique SID identifier of the call that generated the Participant
resource.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
call_direction:
type: string
$ref: '#/components/schemas/conference_participant_enum_call_direction'
nullable: true
description: Call direction of the participant; inbound or outbound.
from:
type: string
nullable: true
description: Caller ID of the calling party.
x-twilio:
pii:
handling: standard
deleteSla: 30
to:
type: string
nullable: true
description: Called party.
x-twilio:
pii:
handling: standard
deleteSla: 30
call_status:
type: string
$ref: '#/components/schemas/conference_participant_enum_call_status'
nullable: true
description: Call status of the call that generated the participant.
country_code:
type: string
nullable: true
description: >-
ISO alpha-2 country code of the participant based on caller ID or
called number.
is_moderator:
type: boolean
nullable: true
description: >-
Boolean. Indicates whether participant had
startConferenceOnEnter=true or endConferenceOnExit=true.
join_time:
type: string
format: date-time
nullable: true
description: ISO 8601 timestamp of participant join event.
leave_time:
type: string
format: date-time
nullable: true
description: ISO 8601 timestamp of participant leave event.
duration_seconds:
type: integer
nullable: true
description: Participant durations in seconds.
outbound_queue_length:
type: integer
nullable: true
description: Add Participant API only. Estimated time in queue at call creation.
outbound_time_in_queue:
type: integer
nullable: true
description: Add Participant API only. Actual time in queue in seconds.
jitter_buffer_size:
type: string
$ref: '#/components/schemas/conference_participant_enum_jitter_buffer_size'
nullable: true
description: >-
The Jitter Buffer Size of this Conference Participant. One of
`large`, `small`, `medium` or `off`.
is_coach:
type: boolean
nullable: true
description: Boolean. Indicated whether participant was a coach.
coached_participants:
type: array
items:
type: string
nullable: true
description: Call SIDs coached by this participant.
participant_region:
type: string
$ref: '#/components/schemas/conference_participant_enum_region'
nullable: true
description: Twilio region where the participant media originates.
conference_region:
type: string
$ref: '#/components/schemas/conference_participant_enum_region'
nullable: true
description: >-
The Conference Region of this Conference Participant. One of `us1`,
`us2`, `au1`, `br1`, `ie1`, `jp1`, `sg1` or `de1`.
call_type:
type: string
$ref: '#/components/schemas/conference_participant_enum_call_type'
nullable: true
description: >-
The Call Type of this Conference Participant. One of `carrier`,
`client` or `sip`.
processing_state:
type: string
$ref: '#/components/schemas/conference_participant_enum_processing_state'
nullable: true
description: >-
Processing state of the Participant Summary. Will be `in_progress`
while data is being aggregated, `timeout` if Twilio couldn't process
the summary in 24hrs, and `complete` once aggregations and analysis
has ended.
properties:
nullable: true
description: Participant properties and metadata.
events:
nullable: true
description: >-
Object containing information of actions taken by participants.
Contains a dictionary of URL links to nested resources of this
Conference Participant.
metrics:
nullable: true
description: Object. Contains participant call quality metrics.
url:
type: string
format: uri
nullable: true
description: The URL of this resource.
conference_participant_enum_call_direction:
type: string
enum:
- inbound
- outbound
conference_participant_enum_call_status:
type: string
enum:
- answered
- completed
- busy
- fail
- noanswer
- ringing
- canceled
conference_participant_enum_jitter_buffer_size:
type: string
enum:
- large
- small
- medium
- 'off'
conference_participant_enum_region:
type: string
enum:
- us1
- us2
- au1
- br1
- ie1
- jp1
- sg1
- de1
conference_participant_enum_call_type:
type: string
enum:
- carrier
- client
- sip
conference_participant_enum_processing_state:
type: string
enum:
- complete
- in_progress
- timeout
insights.v1.call.event:
type: object
properties:
timestamp:
type: string
nullable: true
description: Event time.
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Call.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
edge:
type: string
$ref: '#/components/schemas/event_enum_twilio_edge'
nullable: true
description: >-
The Edge of this Event. One of `unknown_edge`, `carrier_edge`,
`sip_edge`, `sdk_edge` or `client_edge`.
group:
type: string
nullable: true
description: Event group.
level:
type: string
$ref: '#/components/schemas/event_enum_level'
nullable: true
description: >-
The Level of this Event. One of `UNKNOWN`, `DEBUG`, `INFO`,
`WARNING` or `ERROR`.
name:
type: string
nullable: true
description: Event name.
carrier_edge:
nullable: true
description: >-
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:
nullable: true
description: >-
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:
nullable: true
description: >-
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:
nullable: true
description: >-
Represents the Twilio media gateway for Client calls. The events
here describe the call lifecycle as reported by Twilio's Voice SDK
media gateways.
event_enum_twilio_edge:
type: string
enum:
- unknown_edge
- carrier_edge
- sip_edge
- sdk_edge
- client_edge
event_enum_level:
type: string
enum:
- UNKNOWN
- DEBUG
- INFO
- WARNING
- ERROR
insights.v1.call.metric:
type: object
properties:
timestamp:
type: string
nullable: true
description: >-
Timestamp of metric sample. Samples are taken every 10 seconds and
contain the metrics for the previous 10 seconds.
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Call.
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
edge:
type: string
$ref: '#/components/schemas/metric_enum_twilio_edge'
nullable: true
description: >-
The Twilio media edge this Metric was captured on. One of
`unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or
`client_edge`.
direction:
type: string
$ref: '#/components/schemas/metric_enum_stream_direction'
nullable: true
description: >-
The Direction of the media stream from the perspective of the Twilio
media edge. One of `unknown`, `inbound`, `outbound` or `both`.
carrier_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
PSTN call.
sip_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
SIP Interface or Trunking call.
sdk_edge:
nullable: true
description: >-
Contains metrics and properties for the SDK sensor library for
Client calls.
client_edge:
nullable: true
description: >-
Contains metrics and properties for the Twilio media gateway of a
Client call.
metric_enum_twilio_edge:
type: string
enum:
- unknown_edge
- carrier_edge
- sip_edge
- sdk_edge
- client_edge
metric_enum_stream_direction:
type: string
enum:
- unknown
- inbound
- outbound
- both
insights.v1.call.summary:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
call_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CA[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Call.
call_type:
type: string
$ref: '#/components/schemas/summary_enum_call_type'
nullable: true
description: >-
The Call Type of the summarized Call. One of `carrier`, `sip`,
`trunking` or `client`.
call_state:
type: string
$ref: '#/components/schemas/summary_enum_call_state'
nullable: true
description: >-
The Call State of the summarized Call. One of `ringing`,
`completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`,
`undialed`.
answered_by:
type: string
$ref: '#/components/schemas/summary_enum_answered_by'
nullable: true
description: >-
The Answered By value for the summarized call based on `Answering
Machine Detection (AMD)`. One of `unknown`, `machine_start`,
`machine_end_beep`, `machine_end_silence`, `machine_end_other`,
`human` or `fax`. Refer to
[AMD](https://www.twilio.com/docs/voice/answering-machine-detection)
for more detail.
processing_state:
type: string
$ref: '#/components/schemas/summary_enum_processing_state'
nullable: true
description: >-
The Processing State of the Call Summary. The Processing State will
be `partial` until the assembly of the Call Summary finishes, which
occurs approximately 30 minutes after Call end. Then the Processing
State changes to `complete`
created_time:
type: string
format: date-time
nullable: true
description: >-
The time at which the Call was created, given in ISO 8601 format.
Can be different from `start_time` in the event of queueing due to
CPS
start_time:
type: string
format: date-time
nullable: true
description: The time at which the Call was started, given in ISO 8601 format.
end_time:
type: string
format: date-time
nullable: true
description: The time at which the Call was ended, given in ISO 8601 format.
duration:
type: integer
nullable: true
description: Duration between when the call was initiated and the call was ended
connect_duration:
type: integer
nullable: true
description: Duration between when the call was answered and when it ended
from:
nullable: true
description: The calling party.
x-twilio:
pii:
handling: standard
deleteSla: 30
to:
nullable: true
description
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/insights-openapi-original.yml