Skip to main content
← back to extensions

Twilio/insights

@keeb/twilio/insightsv2026.08.25.2· 16d agoMODELS
01README

Twilio insights API models

02Release Notes
  • Updated: call_summary, conference_participant, conference, event, metadata, metric, participant, phone_number_inbound, phone_number_outbound, query, room
03Models19
annotation.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
call_sidstringPath scope for the annotation: call_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
answered_by?enumSpecify which entity answered the call as determined by Answering Machine Detection. Use this to provide feedback on Answering Machine Detection accuracy. Possible enumerated values, one of: `human`, `machine`. `human` indicates the call was answered by a person. `machine` indicates the call was ans
connectivity_issue?enumSpecify if the call had any connectivity issues. Possible enumerated values, one of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
quality_issues?stringSpecify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call.
spam?booleanA boolean flag to indicate 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. Use `true` if the call was a spam call.
call_score?numberSpecify the call score. 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?stringSpecify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`.
incident?stringAssociate this call with an incident or support ticket. The `incident` parameter 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`.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get()
Get a annotation
fn update()
Update annotation attributes
fn sync()
Sync annotation state from Twilio
call.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
sidstringPath scope for the call: sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a call
ArgumentTypeDescription
idstringThe sid of the call
fn sync()
Sync call state from Twilio
call_summary.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(from?: string, to?: string, from_carrier?: string, to_carrier?: string, from_country_code?: string, to_country_code?: string, verified_caller?: boolean, has_tag?: boolean, start_time?: string, end_time?: string, call_type?: string, call_state?: string, direction?: string, processing_state?: enum, sort_by?: enum, subaccount?: string, abnormal_session?: boolean, answered_by?: enum, answered_by_annotation?: string, connectivity_issue_annotation?: string, quality_issue_annotation?: string, spam_annotation?: boolean, call_score_annotation?: string, branded_enabled?: boolean, voice_integrity_enabled?: boolean, branded_bundle_sid?: string, branded_logo?: boolean, branded_type?: string, branded_use_case?: string, branded_call_reason?: string, voice_integrity_bundle_sid?: string, voice_integrity_use_case?: string, business_profile_identity?: string, business_profile_industry?: string, business_profile_bundle_sid?: string, business_profile_type?: string, max_items?: number)
List call summarys and record each as a data artifact (capped at 200 by default; writes a call_summary_lookup record with the coverage of the walk)
ArgumentTypeDescription
from?stringA calling party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
to?stringA called party. Could be an E.164 number, a SIP URI, or a Twilio Client registered name.
from_carrier?stringAn origination carrier.
to_carrier?stringA destination carrier.
from_country_code?stringA source country code based on phone number in From.
to_country_code?stringA destination country code. Based on phone number in To.
verified_caller?booleanA boolean flag indicating whether or not the caller was verified using SHAKEN/STIR.One of 'true' or 'false'.
has_tag?booleanA boolean flag indicating the presence of one or more [Voice Insights Call Tags](https://www.twilio.com/docs/voice/voice-insights/api/call/details-call-tags).
start_time?stringA Start time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 4h.
end_time?stringAn End Time of the calls. xm (x minutes), xh (x hours), xd (x days), 1w, 30m, 3d, 4w or datetime-ISO. Defaults to 0m.
call_type?stringA Call Type of the calls. One of `carrier`, `sip`, `trunking` or `client`.
call_state?stringA Call State of the calls. One of `ringing`, `completed`, `busy`, `fail`, `noanswer`, `canceled`, `answered`, `undialed`.
direction?stringA Direction of the calls. One of `outbound_api`, `outbound_dial`, `inbound`, `trunking_originating`, `trunking_terminating`.
processing_state?enumA Processing State of the Call Summaries. One of `completed`, `partial` or `all`.
sort_by?enumA Sort By criterion for the returned list of Call Summaries. One of `start_time` or `end_time`.
subaccount?stringA unique SID identifier of a Subaccount.
abnormal_session?booleanA boolean flag indicating an abnormal session where the last SIP response was not 200 OK.
answered_by?enumAn Answered By value for the calls based on `Answering Machine Detection (AMD)`. One of `unknown`, `machine_start`, `machine_end_beep`, `machine_end_silence`, `machine_end_other`, `human` or `fax`.
answered_by_annotation?stringEither machine or human.
connectivity_issue_annotation?stringA Connectivity Issue with the calls. One of `no_connectivity_issue`, `invalid_number`, `caller_id`, `dropped_call`, or `number_reachability`.
quality_issue_annotation?stringA subjective Quality Issue with the calls. One of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`.
spam_annotation?booleanA boolean flag indicating spam calls.
call_score_annotation?stringA 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 rated call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
branded_enabled?booleanA boolean flag indicating whether or not the calls were branded using Twilio Branded Calls. One of 'true' or 'false'
voice_integrity_enabled?booleanA boolean flag indicating whether or not the phone number had voice integrity enabled.One of 'true' or 'false'
branded_bundle_sid?stringA unique SID identifier of the Branded Call.
branded_logo?booleanIndicates whether the branded logo was displayed during the in_brand branded call. Possible values are true (logo was present) or false (logo was not present).
branded_type?stringIndicates whether the Branded Call is in_band vs out_of_band.
branded_use_case?stringSpecifies the user-defined purpose for the call, as provided during the setup of in_band branded calling.
branded_call_reason?stringSpecifies the user-defined reason for the call, which will be displayed to the end user on their mobile device during an in_band branded call.
voice_integrity_bundle_sid?stringA unique SID identifier of the Voice Integrity Profile.
voice_integrity_use_case?stringA Voice Integrity Use Case . Is of type enum. One of 'abandoned_cart', 'appointment_reminders', 'appointment_scheduling', 'asset_management', 'automated_support', 'call_tracking', 'click_to_call', 'contact_tracing', 'contactless_delivery', 'customer_support', 'dating/social', 'delivery_notifications
business_profile_identity?stringA Business Identity of the calls. Is of type enum. One of 'direct_customer', 'isv_reseller_or_partner'.
business_profile_industry?stringA Business Industry of the calls. Is of type enum. One of 'automotive', 'agriculture', 'banking', 'consumer', 'construction', 'education', 'engineering', 'energy', 'oil_and_gas', 'fast_moving_consumer_goods', 'financial', 'fintech', 'food_and_beverage', 'government', 'healthcare', 'hospitality', 'in
business_profile_bundle_sid?stringA unique SID identifier of the Business Profile.
business_profile_type?stringA Business Profile Type of the calls. Is of type enum. One of 'primary', 'secondary'.
max_items?numberStop after this many results (default 200, ceiling 25000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the call_summary_lookup record reports truncated: true.

Resources

state— Call summary resource state
conference.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a conference
ArgumentTypeDescription
idstringThe sid of the conference
fn lookup(conference_sid?: string, friendly_name?: string, status?: string, created_after?: string, created_before?: string, mixer_region?: string, tags?: string, subaccount?: string, detected_issues?: string, end_reason?: string, max_items?: number)
List conferences and record each as a data artifact (capped at 200 by default; writes a conference_lookup record with the coverage of the walk)
ArgumentTypeDescription
conference_sid?stringThe SID of the conference.
friendly_name?stringCustom label for the conference resource, up to 64 characters.
status?stringConference status.
created_after?stringConferences created after the provided timestamp specified in ISO 8601 format
created_before?stringConferences created before the provided timestamp specified in ISO 8601 format.
mixer_region?stringTwilio region where the conference media was mixed.
tags?stringTags applied by Twilio for common potential configuration, quality, or performance issues.
subaccount?stringAccount SID for the subaccount whose resources you wish to retrieve.
detected_issues?stringPotential configuration, behavior, or performance issues detected during the conference.
end_reason?stringConference end reason; e.g. last participant left, modified by API, etc.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the conference_lookup record reports truncated: true.
fn sync()
Sync conference state from Twilio

Resources

state— Conference resource state
conference_participant.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
conference_sidstringPath scope for the conference participant: conference_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a conference participant
ArgumentTypeDescription
idstringThe sid of the conference participant
fn lookup(participant_sid?: string, label?: string, events?: string, max_items?: number)
List conference participants and record each as a data artifact (capped at 200 by default; writes a conference_participant_lookup record with the coverage of the walk)
ArgumentTypeDescription
participant_sid?stringThe unique SID identifier of the Participant.
label?stringUser-specified label for a participant.
events?stringConference events generated by application or participant activity; e.g. `hold`, `mute`, etc.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the conference_participant_lookup record reports truncated: true.
fn sync()
Sync conference participant state from Twilio

Resources

state— Conference participant resource state
event.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
call_sidstringPath scope for the event: call_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(edge?: enum, max_items?: number)
List events and record each as a data artifact (capped at 200 by default; writes a event_lookup record with the coverage of the walk)
ArgumentTypeDescription
edge?enumThe Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the event_lookup record reports truncated: true.

Resources

state— Event resource state
inbound.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
time_range?object
filters?array
size?numberThe number of max available top Phone Numbers to generate.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn update()
Update inbound attributes
metadata.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List metadatas and record each as a data artifact (capped at 200 by default; writes a metadata_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the metadata_lookup record reports truncated: true.

Resources

state— Metadata resource state
metric.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
call_sidstringPath scope for the metric: call_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(edge?: enum, direction?: enum, max_items?: number)
List metrics and record each as a data artifact (capped at 200 by default; writes a metric_lookup record with the coverage of the walk)
ArgumentTypeDescription
edge?enumThe Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`.
direction?enumThe Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the metric_lookup record reports truncated: true.

Resources

state— Metric resource state
outbound.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
time_range?object
filters?array
size?numberThe number of max available top Phone Numbers to generate.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn update()
Update outbound attributes
participant.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
room_sidstringPath scope for the participant: room_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a participant
ArgumentTypeDescription
idstringThe sid of the participant
fn lookup(max_items?: number)
List participants and record each as a data artifact (capped at 200 by default; writes a participant_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the participant_lookup record reports truncated: true.
fn sync()
Sync participant state from Twilio

Resources

state— Participant resource state
phone_number_inbound.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
report_idstringPath scope for the phone number inbound: report_id
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List phone number inbounds and record each as a data artifact (capped at 200 by default; writes a phone_number_inbound_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the phone_number_inbound_lookup record reports truncated: true.

Resources

state— Phone number inbound resource state
phone_number_outbound.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
report_idstringPath scope for the phone number outbound: report_id
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn lookup(max_items?: number)
List phone number outbounds and record each as a data artifact (capped at 200 by default; writes a phone_number_outbound_lookup record with the coverage of the walk)
ArgumentTypeDescription
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the phone_number_outbound_lookup record reports truncated: true.

Resources

state— Phone number outbound resource state
query.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
domain?stringThe business domain to execute the query against
query?objectStructured query definition that specifies what data to retrieve and how to filter, group, and order it
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn create()
Create a query
fn lookup(page_token?: string, max_items?: number)
List querys and record each as a data artifact (capped at 200 by default; writes a query_lookup record with the coverage of the walk)
ArgumentTypeDescription
page_token?stringPagination token
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the query_lookup record reports truncated: true.

Resources

state— Query resource state
report.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
time_range?objectOptional start and end date time for the report window. Defaults to the most recent 7 days when omitted.
filters?array
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn update()
Update report attributes
room.tsv2026.08.25.2

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a room
ArgumentTypeDescription
idstringThe sid of the room
fn lookup(room_type?: string, codec?: string, room_name?: string, created_after?: string, created_before?: string, max_items?: number)
List rooms and record each as a data artifact (capped at 200 by default; writes a room_lookup record with the coverage of the walk)
ArgumentTypeDescription
room_type?stringType of room. Can be `go`, `peer_to_peer`, `group`, or `group_small`.
codec?stringCodecs used by participants in the room. Can be `VP8`, `H264`, or `VP9`.
room_name?stringRoom friendly name.
created_after?stringOnly read rooms that started on or after this ISO 8601 timestamp.
created_before?stringOnly read rooms that started before this ISO 8601 timestamp.
max_items?numberStop after this many results (default 200, ceiling 1000000). Raise deliberately: Twilio's message and call logs are effectively endless, and every result becomes its own data artifact. When the walk stops here with rows still on offer, the room_lookup record reports truncated: true.
fn sync()
Sync room state from Twilio

Resources

state— Room resource state
setting.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
advanced_features?booleanA boolean flag to enable Advanced Features for Voice Insights.
voice_trace?booleanA boolean flag to enable Voice Trace.
subaccount_sid?stringThe unique SID identifier of the Subaccount.
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get()
Get a setting
fn update()
Update setting attributes
fn sync()
Sync setting state from Twilio
voice_call_summary.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
call_sidstringPath scope for the voice call summary: call_sid
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get()
Get a voice call summary
fn sync()
Sync voice call summary state from Twilio
voice_report.tsv2026.08.25.1

Global Arguments

ArgumentTypeDescription
account_sid?stringTwilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
report_idstringPath scope for the voice report: report_id
name?stringInstance name for this resource (used as the unique identifier in the factory pattern)
auth_token?stringTwilio auth token, used as the HTTP Basic password when no API key is set. Overrides TWILIO_AUTH_TOKEN. Wire with a vault.get(...) expression to source it from a vault.
api_key_sid?stringTwilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?stringTwilio API key secret, paired with api_key_sid. Overrides TWILIO_API_KEY_SECRET. Wire with a vault.get(...) expression to source it from a vault.
fn get(id: string)
Get a voice report
ArgumentTypeDescription
idstringThe report_id of the voice report
fn sync()
Sync voice report state from Twilio
04Stats
B
85 / 100
Downloads
0
Archive size
62.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository0/2missing
05Platforms
06Labels
#twilio#insights#communications#saas