Twilio/api
@keeb/twilio/apiv2026.08.25.2
01README
Twilio api API models
02Release Notes
- Updated: account_notification, account_recording, account_transcription, account, add_on_result, address, all_time, application, assigned_add_on_extension, assigned_add_ons, auth_calls_credential_list_mapping, auth_calls_ip_access_control_list_mapping, auth_registrations_credential_list_mapping, authorized_connect_app, available_phone_number_country, available_phone_number_local, available_phone_number_mobile, available_phone_number_toll_free, call_notification, call_recording, call, conference_recording, conference, connect_app, credential_list_mapping, credential_list, credential, daily, dependent_phone_number, domain, event, incoming_phone_number_local, incoming_phone_number_mobile, incoming_phone_number_toll_free, incoming_phone_number, ip_access_control_list_mapping, ip_access_control_list, ip_address, key, last_month, machine_to_machine, media, member, message, monthly, national, outgoing_caller_ids, participant, payload, queue, record, recording_transcription, shared_cost, short_code, signing_key, this_month, today, trigger, voip, yearly, yesterday
03Models
account.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}` |
| status? | enum | The status of this account. Usually `active`, but can be `suspended` or `closed`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 account
fn get(id: string)
Get a account
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account |
fn lookup(friendly_name?: string, status?: enum, max_items?: number)
List accounts and record each as a data artifact (capped at 200 by default; writes a account_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| friendly_name? | string | Only return the Account resources with friendly names that exactly match this name. |
| status? | enum | Only return Account resources with the given status. Can be `closed`, `suspended` or `active`. |
| max_items? | number | Stop 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 account_lookup record reports truncated: true. |
fn update()
Update account attributes
fn sync()
Sync account state from Twilio
Resources
state— Account resource state
account_notification.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 account notification
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account notification |
fn lookup(log?: number, message_date?: string, message_date_before?: string, message_date_after?: string, max_items?: number)
List account notifications and record each as a data artifact (capped at 200 by default; writes a account_notification_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| log? | number | Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read. |
| message_date? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| message_date_before? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| message_date_after? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| max_items? | number | Stop 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 account_notification_lookup record reports truncated: true. |
fn sync()
Sync account notification state from Twilio
Resources
state— Account notification resource state
account_recording.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 account recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account recording |
fn lookup(date_created?: string, date_created_before?: string, date_created_after?: string, call_sid?: string, conference_sid?: string, include_soft_deleted?: boolean, max_items?: number)
List account recordings and record each as a data artifact (capped at 200 by default; writes a account_recording_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| date_created? | string | Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnig |
| date_created_before? | string | Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnig |
| date_created_after? | string | Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnig |
| call_sid? | string | The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. |
| conference_sid? | string | The Conference SID that identifies the conference associated with the recording to read. |
| include_soft_deleted? | boolean | A boolean parameter indicating whether to retrieve soft deleted recordings or not. Recordings metadata are kept after deletion for a retention period of 40 days. |
| max_items? | number | Stop 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 account_recording_lookup record reports truncated: true. |
fn delete(id: string)
Delete the account recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account recording |
fn sync()
Sync account recording state from Twilio
Resources
state— Account recording resource state
account_transcription.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 account transcription
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account transcription |
fn lookup(max_items?: number)
List account transcriptions and record each as a data artifact (capped at 200 by default; writes a account_transcription_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 account_transcription_lookup record reports truncated: true. |
fn delete(id: string)
Delete the account transcription
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the account transcription |
fn sync()
Sync account transcription state from Twilio
Resources
state— Account transcription resource state
add_on_result.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| reference_sid | string | Path scope for the add on result: reference_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 add on result
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the add on result |
fn lookup(max_items?: number)
List add on results and record each as a data artifact (capped at 200 by default; writes a add_on_result_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 add_on_result_lookup record reports truncated: true. |
fn delete(id: string)
Delete the add on result
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the add on result |
fn sync()
Sync add on result state from Twilio
Resources
state— Add on result resource state
address.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses. |
| customer_name | string | The name to associate with the new address. |
| street | string | The number and street address of the new address. |
| city | string | The city of the new address. |
| region | string | The state or region of the new address. |
| postal_code | string | The postal code of the new address. |
| emergency_enabled? | boolean | Whether to enable emergency calling on the new address. Can be: `true` or `false`. |
| auto_correct_address? | boolean | Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide. |
| street_secondary? | string | The additional number and street address of the address. |
| iso_country | string | The ISO country code of the new address. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 address
fn get(id: string)
Get a address
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the address |
fn lookup(customer_name?: string, friendly_name?: string, emergency_enabled?: boolean, iso_country?: string, max_items?: number)
List addresss and record each as a data artifact (capped at 200 by default; writes a address_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| customer_name? | string | The `customer_name` of the Address resources to read. |
| friendly_name? | string | The string that identifies the Address resources to read. |
| emergency_enabled? | boolean | Whether the address can be associated to a number for emergency calling. |
| iso_country? | string | The ISO country code of the Address resources to read. |
| max_items? | number | Stop 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 address_lookup record reports truncated: true. |
fn update()
Update address attributes
fn delete(id: string)
Delete the address
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the address |
fn sync()
Sync address state from Twilio
Resources
state— Address resource state
all_time.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List all times and record each as a data artifact (capped at 200 by default; writes a all_time_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 all_time_lookup record reports truncated: true. |
Resources
state— All time resource state
application.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you create to describe the new application. It can be up to 64 characters long. |
| api_version? | string | The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default API version. |
| voice_url? | string | The URL we should call when the phone number assigned to this application receives a call. |
| voice_method? | enum | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
| voice_fallback_method? | enum | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`. |
| voice_caller_id_lookup? | boolean | Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`. |
| sms_url? | string | The URL we should call when the phone number receives an incoming SMS message. |
| sms_method? | enum | The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. |
| sms_fallback_url? | string | The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`. |
| sms_fallback_method? | enum | The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. |
| sms_status_callback? | string | The URL we should call using a POST method to send status information about SMS messages sent by the application. |
| message_status_callback? | string | The URL we should call using a POST method to send message status information to your application. |
| public_application_connect_enabled? | boolean | Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 application
fn get(id: string)
Get a application
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the application |
fn lookup(friendly_name?: string, max_items?: number)
List applications and record each as a data artifact (capped at 200 by default; writes a application_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| friendly_name? | string | The string that identifies the Application resources to read. |
| max_items? | number | Stop 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 application_lookup record reports truncated: true. |
fn update()
Update application attributes
fn delete(id: string)
Delete the application
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the application |
fn sync()
Sync application state from Twilio
Resources
state— Application resource state
assigned_add_on_extension.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| resource_sid | string | Path scope for the assigned add on extension: resource_sid |
| assigned_add_on_sid | string | Path scope for the assigned add on extension: assigned_add_on_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 assigned add on extension
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the assigned add on extension |
fn lookup(max_items?: number)
List assigned add on extensions and record each as a data artifact (capped at 200 by default; writes a assigned_add_on_extension_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 assigned_add_on_extension_lookup record reports truncated: true. |
fn sync()
Sync assigned add on extension state from Twilio
Resources
state— Assigned add on extension resource state
assigned_add_ons.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| resource_sid | string | Path scope for the assigned add ons: resource_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| installed_add_on_sid | string | The SID that identifies the Add-on installation. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 assigned add ons
fn get(id: string)
Get a assigned add ons
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the assigned add ons |
fn lookup(max_items?: number)
List assigned add onss and record each as a data artifact (capped at 200 by default; writes a assigned_add_ons_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 assigned_add_ons_lookup record reports truncated: true. |
fn delete(id: string)
Delete the assigned add ons
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the assigned add ons |
fn sync()
Sync assigned add ons state from Twilio
Resources
state— Assigned add ons resource state
auth_calls_credential_list_mapping.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| domain_sid | string | Path scope for the auth calls credential list mapping: domain_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| credential_list_sid | string | The SID of the CredentialList resource to map to the SIP domain. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 auth calls credential list mapping
fn get(id: string)
Get a auth calls credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth calls credential list mapping |
fn lookup(max_items?: number)
List auth calls credential list mappings and record each as a data artifact (capped at 200 by default; writes a auth_calls_credential_list_mapping_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 auth_calls_credential_list_mapping_lookup record reports truncated: true. |
fn delete(id: string)
Delete the auth calls credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth calls credential list mapping |
fn sync()
Sync auth calls credential list mapping state from Twilio
Resources
state— Auth calls credential list mapping resource state
auth_calls_ip_access_control_list_mapping.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| domain_sid | string | Path scope for the auth calls ip access control list mapping: domain_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ip_access_control_list_sid | string | The SID of the IpAccessControlList resource to map to the SIP domain. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 auth calls ip access control list mapping
fn get(id: string)
Get a auth calls ip access control list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth calls ip access control list mapping |
fn lookup(max_items?: number)
List auth calls ip access control list mappings and record each as a data artifact (capped at 200 by default; writes a auth_calls_ip_access_control_list_mapping_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 auth_calls_ip_access_control_list_mapping_lookup record reports truncated: true. |
fn delete(id: string)
Delete the auth calls ip access control list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth calls ip access control list mapping |
fn sync()
Sync auth calls ip access control list mapping state from Twilio
Resources
state— Auth calls ip access control list mapping resource state
auth_registrations_credential_list_mapping.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| domain_sid | string | Path scope for the auth registrations credential list mapping: domain_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| credential_list_sid | string | The SID of the CredentialList resource to map to the SIP domain. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 auth registrations credential list mapping
fn get(id: string)
Get a auth registrations credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth registrations credential list mapping |
fn lookup(max_items?: number)
List auth registrations credential list mappings and record each as a data artifact (capped at 200 by default; writes a auth_registrations_credential_list_mapping_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 auth_registrations_credential_list_mapping_lookup record reports truncated: true. |
fn delete(id: string)
Delete the auth registrations credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the auth registrations credential list mapping |
fn sync()
Sync auth registrations credential list mapping state from Twilio
Resources
state— Auth registrations credential list mapping resource state
authorized_connect_app.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 authorized connect app
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the authorized connect app |
fn lookup(max_items?: number)
List authorized connect apps and record each as a data artifact (capped at 200 by default; writes a authorized_connect_app_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 authorized_connect_app_lookup record reports truncated: true. |
fn sync()
Sync authorized connect app state from Twilio
Resources
state— Authorized connect app resource state
available_phone_number_country.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 available phone number country
| Argument | Type | Description |
|---|---|---|
| id | string | The country_code of the available phone number country |
fn lookup(max_items?: number)
List available phone number countrys and record each as a data artifact (capped at 200 by default; writes a available_phone_number_country_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 available_phone_number_country_lookup record reports truncated: true. |
fn sync()
Sync available phone number country state from Twilio
Resources
state— Available phone number country resource state
available_phone_number_local.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the available phone number local: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List available phone number locals and record each as a data artifact (capped at 200 by default; writes a available_phone_number_local_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 available_phone_number_local_lookup record reports truncated: true. |
Resources
state— Available phone number local resource state
available_phone_number_mobile.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the available phone number mobile: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List available phone number mobiles and record each as a data artifact (capped at 200 by default; writes a available_phone_number_mobile_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 available_phone_number_mobile_lookup record reports truncated: true. |
Resources
state— Available phone number mobile resource state
available_phone_number_toll_free.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the available phone number toll free: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List available phone number toll frees and record each as a data artifact (capped at 200 by default; writes a available_phone_number_toll_free_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 available_phone_number_toll_free_lookup record reports truncated: true. |
Resources
state— Available phone number toll free resource state
balance.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 balance
fn sync()
Sync balance state from Twilio
call.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| url? | string | The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/doc |
| method? | enum | The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. |
| status? | enum | |
| fallback_url? | string | The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored. |
| fallback_method? | enum | The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (unde |
| status_callback_method? | enum | The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored. |
| twiml? | string | TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored. Max 4000 characters. |
| time_limit? | number | The maximum duration of the call in seconds. Constraints depend on account and configuration. |
| to | string | The phone number, SIP address, or client identifier to call. |
| from | string | The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone numb |
| status_callback_event? | array | The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. Se |
| send_digits? | string | The string of keys to dial after connecting to the number, with a maximum length of 32 digits. Valid digits in the string include any digit (`0`-`9`), '`A`', '`B`', '`C`', '`D`', '`#`', and '`*`'. You can also use '`w`' to insert a half-second pause and '`W`' to insert a one-second pause. For exampl |
| timeout? | number | The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds c |
| record? | boolean | Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL. |
| recording_channels? | string | The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains |
| recording_status_callback? | string | The URL that we call when the recording is available to be accessed. |
| recording_status_callback_method? | enum | The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. |
| recording_configuration_id? | string | The identifier of the configuration to be used when creating and processing the recording |
| sip_auth_username? | string | The username used to authenticate the caller making a SIP call. |
| sip_auth_password? | string | The password required to authenticate the user account specified in `sip_auth_username`. |
| machine_detection? | string | Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering mac |
| machine_detection_timeout? | number | The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. |
| recording_status_callback_event? | array | The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space. |
| trim? | string | Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`. |
| caller_id? | string | The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. |
| machine_detection_speech_threshold? | number | The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. |
| machine_detection_speech_end_threshold? | number | The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. |
| machine_detection_silence_timeout? | number | The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000. |
| async_amd? | string | Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`. |
| async_amd_status_callback? | string | The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. |
| async_amd_status_callback_method? | enum | The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. |
| passports? | string | The STIR/SHAKEN passport for this call, provided as a base64 encoded string. Multiple passports (at max 5) are comma separated and provided as base64 encoded string |
| byoc? | string | The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) |
| call_reason? | string | The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) |
| call_token? | string | A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the |
| recording_track? | string | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio. |
| client_notification_url? | string | The URL that we should use to deliver `push call notification`. |
| application_sid? | string | The SID of the Application resource that will handle the call, if the call will be handled by an application. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 call
fn get(id: string)
Get a call
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the call |
fn lookup(to?: string, from?: string, parent_call_sid?: string, status?: enum, start_time?: string, start_time_before?: string, start_time_after?: string, end_time?: string, end_time_before?: string, end_time_after?: string, max_items?: number)
List calls and record each as a data artifact (capped at 200 by default; writes a call_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| to? | string | Only show calls made to this phone number, SIP address, Client identifier or SIM SID. |
| from? | string | Only include calls from this phone number, SIP address, Client identifier or SIM SID. |
| parent_call_sid? | string | Only include calls spawned by calls with this SID. |
| status? | enum | The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`. |
| start_time? | string | Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on this date. |
| start_time_before? | string | Only include calls that started before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started before this date. |
| start_time_after? | string | Only include calls that started on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that started on or after this date. |
| end_time? | string | Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on this date. |
| end_time_before? | string | Only include calls that ended before this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended before this date. |
| end_time_after? | string | Only include calls that ended on or after this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only calls that ended on or after this date. |
| max_items? | number | Stop 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 call_lookup record reports truncated: true. |
fn update()
Update call attributes
fn delete(id: string)
Delete the call
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the call |
fn sync()
Sync call state from Twilio
Resources
state— Call resource state
call_notification.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the call notification: call_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 notification
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the call notification |
fn lookup(log?: number, message_date?: string, message_date_before?: string, message_date_after?: string, max_items?: number)
List call notifications and record each as a data artifact (capped at 200 by default; writes a call_notification_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| log? | number | Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read. |
| message_date? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| message_date_before? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| message_date_after? | string | Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. |
| max_items? | number | Stop 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 call_notification_lookup record reports truncated: true. |
fn sync()
Sync call notification state from Twilio
Resources
state— Call notification resource state
call_recording.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the call recording: call_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| status? | enum | The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource). |
| pause_behavior? | string | Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `pau |
| recording_status_callback_event? | array | The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space. |
| recording_status_callback? | string | The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback). |
| recording_status_callback_method? | enum | The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`. |
| trim? | string | Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not. |
| recording_channels? | string | The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels. |
| recording_track? | string | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio. |
| recording_configuration_id? | string | The identifier of the configuration to be used when creating and processing the recording |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 call recording
fn get(id: string)
Get a call recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the call recording |
fn lookup(date_created?: string, date_created_before?: string, date_created_after?: string, max_items?: number)
List call recordings and record each as a data artifact (capped at 200 by default; writes a call_recording_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| date_created? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| date_created_before? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| date_created_after? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| max_items? | number | Stop 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 call_recording_lookup record reports truncated: true. |
fn update()
Update call recording attributes
fn delete(id: string)
Delete the call recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the call recording |
fn sync()
Sync call recording state from Twilio
Resources
state— Call recording resource state
call_transcription.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the call transcription: call_sid |
| status? | enum | |
| name? | string | The user-specified name of this Transcription, if one was given when the Transcription was created. This may be used to stop the Transcription. |
| track? | enum | One of `inbound_track`, `outbound_track`, `both_tracks`. |
| status_callback_url? | string | Absolute URL of the status callback. |
| status_callback_method? | enum | The http method for the status_callback (one of GET, POST). |
| inbound_track_label? | string | Friendly name given to the Inbound Track |
| outbound_track_label? | string | Friendly name given to the Outbound Track |
| partial_results? | boolean | Indicates if partial results are going to be sent to the customer |
| language_code? | string | Language code used by the transcription engine, specified in [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) format |
| transcription_engine? | string | Definition of the transcription engine to be used, among those supported by Twilio |
| profanity_filter? | boolean | indicates if the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks |
| speech_model? | string | Recognition model used by the transcription engine, among those supported by the provider |
| hints? | string | A Phrase contains words and phrase "hints" so that the speech recognition engine is more likely to recognize them. |
| enable_automatic_punctuation? | boolean | The provider will add punctuation to recognition result |
| intelligence_service? | string | The SID or unique name of the [Intelligence Service](https://www.twilio.com/docs/conversational-intelligence/api/service-resource) for persisting transcripts and running post-call Language Operators |
| conversation_configuration? | string | The ID of the Conversations Configuration for customizing conversation behavior in Intelligence Service |
| conversation_id? | string | The ID of the Conversation for associating this Transcription with an existing Conversation in Intelligence Service |
| transcription_configuration_id? | string | The ID of the RealTimeTranscription Configuration for configuring all the non-default behaviors in one go. |
| enable_provider_data? | boolean | Whether the callback includes raw provider data. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 call transcription
fn update()
Update call transcription attributes
conference.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| status? | enum | |
| announce_url? | string | The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. |
| announce_method? | enum | The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST` |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the conference |
fn lookup(date_created?: string, date_created_before?: string, date_created_after?: string, date_updated?: string, date_updated_before?: string, date_updated_after?: string, friendly_name?: string, status?: enum, 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)
| Argument | Type | Description |
|---|---|---|
| date_created? | string | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or befor |
| date_created_before? | string | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or befor |
| date_created_after? | string | Only include conferences that were created on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read conferences that were created on or befor |
| date_updated? | string | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last upda |
| date_updated_before? | string | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last upda |
| date_updated_after? | string | Only include conferences that were last updated on this date. Specify a date as `YYYY-MM-DD` in UTC, for example: `2009-07-06`, to read only conferences that were last updated on this date. You can also specify an inequality, such as `DateUpdated<=YYYY-MM-DD`, to read conferences that were last upda |
| friendly_name? | string | The string that identifies the Conference resources to read. |
| status? | enum | The status of the resources to read. Can be: `init`, `in-progress`, or `completed`. |
| max_items? | number | Stop 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 update()
Update conference attributes
fn sync()
Sync conference state from Twilio
Resources
state— Conference resource state
conference_recording.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| conference_sid | string | Path scope for the conference recording: conference_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| status | enum | The status of the recording. Can be: `processing`, `completed` and `absent`. For more detailed statuses on in-progress recordings, check out how to [Update a Recording Resource](https://www.twilio.com/docs/voice/api/recording#update-a-recording-resource). |
| pause_behavior? | string | Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `pau |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the conference recording |
fn lookup(date_created?: string, date_created_before?: string, date_created_after?: string, max_items?: number)
List conference recordings and record each as a data artifact (capped at 200 by default; writes a conference_recording_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| date_created? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| date_created_before? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| date_created_after? | string | The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date. |
| max_items? | number | Stop 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_recording_lookup record reports truncated: true. |
fn update()
Update conference recording attributes
fn delete(id: string)
Delete the conference recording
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the conference recording |
fn sync()
Sync conference recording state from Twilio
Resources
state— Conference recording resource state
connect_app.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| authorize_redirect_url? | string | The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App. |
| company_name? | string | The company name to set for the Connect App. |
| deauthorize_callback_method? | enum | The HTTP method to use when calling `deauthorize_callback_url`. |
| deauthorize_callback_url? | string | The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App. |
| description? | string | A description of the Connect App. |
| friendly_name? | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
| homepage_url? | string | A public URL where users can obtain more information about this Connect App. |
| permissions? | array | A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 connect app
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the connect app |
fn lookup(max_items?: number)
List connect apps and record each as a data artifact (capped at 200 by default; writes a connect_app_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 connect_app_lookup record reports truncated: true. |
fn update()
Update connect app attributes
fn delete(id: string)
Delete the connect app
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the connect app |
fn sync()
Sync connect app state from Twilio
Resources
state— Connect app resource state
credential.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| credential_list_sid | string | Path scope for the credential: credential_list_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| password | string | The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) |
| username | string | The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 credential
fn get(id: string)
Get a credential
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential |
fn lookup(max_items?: number)
List credentials and record each as a data artifact (capped at 200 by default; writes a credential_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 credential_lookup record reports truncated: true. |
fn update()
Update credential attributes
fn delete(id: string)
Delete the credential
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential |
fn sync()
Sync credential state from Twilio
Resources
state— Credential resource state
credential_list.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name | string | A human readable descriptive text that describes the CredentialList, up to 64 characters long. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 credential list
fn get(id: string)
Get a credential list
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential list |
fn lookup(max_items?: number)
List credential lists and record each as a data artifact (capped at 200 by default; writes a credential_list_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 credential_list_lookup record reports truncated: true. |
fn update()
Update credential list attributes
fn delete(id: string)
Delete the credential list
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential list |
fn sync()
Sync credential list state from Twilio
Resources
state— Credential list resource state
credential_list_mapping.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| domain_sid | string | Path scope for the credential list mapping: domain_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| credential_list_sid | string | A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 credential list mapping
fn get(id: string)
Get a credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential list mapping |
fn lookup(max_items?: number)
List credential list mappings and record each as a data artifact (capped at 200 by default; writes a credential_list_mapping_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 credential_list_mapping_lookup record reports truncated: true. |
fn delete(id: string)
Delete the credential list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the credential list mapping |
fn sync()
Sync credential list mapping state from Twilio
Resources
state— Credential list mapping resource state
daily.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List dailys and record each as a data artifact (capped at 200 by default; writes a daily_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 daily_lookup record reports truncated: true. |
Resources
state— Daily resource state
data.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| reference_sid | string | Path scope for the data: reference_sid |
| add_on_result_sid | string | Path scope for the data: add_on_result_sid |
| payload_sid | string | Path scope for the data: payload_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 data
fn sync()
Sync data state from Twilio
dependent_phone_number.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| address_sid | string | Path scope for the dependent phone number: address_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 dependent phone numbers and record each as a data artifact (capped at 200 by default; writes a dependent_phone_number_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 dependent_phone_number_lookup record reports truncated: true. |
Resources
state— Dependent phone number resource state
domain.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you created to describe the resource. It can be up to 64 characters long. |
| voice_fallback_method? | enum | The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`. |
| voice_method? | enum | The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. |
| voice_status_callback_method? | enum | The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`. |
| voice_status_callback_url? | string | The URL that we should call to pass status parameters (such as call ended) to your application. |
| voice_url? | string | The URL we should when the domain receives a call. |
| sip_registration? | boolean | Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not. |
| domain_name | string | The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-" and must end with `sip.twilio.com`. |
| emergency_calling_enabled? | boolean | Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. |
| secure? | boolean | Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain. |
| byoc_trunk_sid? | string | The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. |
| emergency_caller_sid? | string | Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 domain
fn get(id: string)
Get a domain
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the domain |
fn lookup(max_items?: number)
List domains and record each as a data artifact (capped at 200 by default; writes a domain_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 domain_lookup record reports truncated: true. |
fn update()
Update domain attributes
fn delete(id: string)
Delete the domain
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the domain |
fn sync()
Sync domain state from Twilio
Resources
state— Domain resource state
event.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the event: call_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 events and record each as a data artifact (capped at 200 by default; writes a event_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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
feedback.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| message_sid | string | Path scope for the feedback: message_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| outcome? | enum | Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: `unconfirmed` or `confirmed`. For more details see [How to Optimize Message Deliverability with Message Feedback](https://www.twilio.com/docs/messaging/guides/send-message-fe |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 feedback
incoming_phone_number.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| api_version? | string | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. |
| friendly_name? | string | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number. |
| sms_application_sid? | string | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. |
| sms_fallback_method? | enum | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_fallback_url? | string | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
| sms_method? | enum | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_url? | string | The URL we should call when the new phone number receives an incoming SMS message. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_application_sid? | string | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
| voice_caller_id_lookup? | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
| voice_fallback_method? | enum | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
| voice_method? | enum | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_url? | string | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |
| emergency_status? | enum | The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
| emergency_address_sid? | string | The SID of the emergency address configuration to use for emergency calling from the new phone number. |
| trunk_sid? | string | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
| voice_receive_mode? | enum | |
| identity_sid? | string | The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. |
| address_sid? | string | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. |
| bundle_sid? | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
| phone_number? | string | The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. |
| area_code? | string | The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only). |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 incoming phone number
fn get(id: string)
Get a incoming phone number
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the incoming phone number |
fn lookup(beta?: boolean, friendly_name?: string, phone_number?: string, origin?: string, max_items?: number)
List incoming phone numbers and record each as a data artifact (capped at 200 by default; writes a incoming_phone_number_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| beta? | boolean | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| friendly_name? | string | A string that identifies the IncomingPhoneNumber resources to read. |
| phone_number? | string | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. |
| origin? | string | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. |
| max_items? | number | Stop 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 incoming_phone_number_lookup record reports truncated: true. |
fn update()
Update incoming phone number attributes
fn delete(id: string)
Delete the incoming phone number
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the incoming phone number |
fn sync()
Sync incoming phone number state from Twilio
Resources
state— Incoming phone number resource state
incoming_phone_number_local.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| phone_number | string | The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. |
| api_version? | string | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. |
| friendly_name? | string | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. |
| sms_application_sid? | string | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. |
| sms_fallback_method? | enum | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_fallback_url? | string | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
| sms_method? | enum | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_url? | string | The URL we should call when the new phone number receives an incoming SMS message. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_application_sid? | string | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
| voice_caller_id_lookup? | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
| voice_fallback_method? | enum | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
| voice_method? | enum | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_url? | string | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |
| identity_sid? | string | The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. |
| address_sid? | string | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. |
| emergency_status? | enum | The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
| emergency_address_sid? | string | The SID of the emergency address configuration to use for emergency calling from the new phone number. |
| trunk_sid? | string | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
| voice_receive_mode? | enum | |
| bundle_sid? | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 incoming phone number local
fn lookup(beta?: boolean, friendly_name?: string, phone_number?: string, origin?: string, max_items?: number)
List incoming phone number locals and record each as a data artifact (capped at 200 by default; writes a incoming_phone_number_local_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| beta? | boolean | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| friendly_name? | string | A string that identifies the resources to read. |
| phone_number? | string | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. |
| origin? | string | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. |
| max_items? | number | Stop 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 incoming_phone_number_local_lookup record reports truncated: true. |
Resources
state— Incoming phone number local resource state
incoming_phone_number_mobile.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| phone_number | string | The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. |
| api_version? | string | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. |
| friendly_name? | string | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number. |
| sms_application_sid? | string | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application. |
| sms_fallback_method? | enum | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_fallback_url? | string | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
| sms_method? | enum | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_url? | string | The URL we should call when the new phone number receives an incoming SMS message. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_application_sid? | string | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
| voice_caller_id_lookup? | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
| voice_fallback_method? | enum | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
| voice_method? | enum | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_url? | string | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |
| identity_sid? | string | The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. |
| address_sid? | string | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. |
| emergency_status? | enum | The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
| emergency_address_sid? | string | The SID of the emergency address configuration to use for emergency calling from the new phone number. |
| trunk_sid? | string | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
| voice_receive_mode? | enum | |
| bundle_sid? | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 incoming phone number mobile
fn lookup(beta?: boolean, friendly_name?: string, phone_number?: string, origin?: string, max_items?: number)
List incoming phone number mobiles and record each as a data artifact (capped at 200 by default; writes a incoming_phone_number_mobile_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| beta? | boolean | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| friendly_name? | string | A string that identifies the resources to read. |
| phone_number? | string | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. |
| origin? | string | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. |
| max_items? | number | Stop 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 incoming_phone_number_mobile_lookup record reports truncated: true. |
Resources
state— Incoming phone number mobile resource state
incoming_phone_number_toll_free.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| phone_number | string | The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. |
| api_version? | string | The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. |
| friendly_name? | string | A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. |
| sms_application_sid? | string | The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application. |
| sms_fallback_method? | enum | The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_fallback_url? | string | The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. |
| sms_method? | enum | The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| sms_url? | string | The URL we should call when the new phone number receives an incoming SMS message. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_application_sid? | string | The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. |
| voice_caller_id_lookup? | boolean | Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`. |
| voice_fallback_method? | enum | The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_fallback_url? | string | The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. |
| voice_method? | enum | The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| voice_url? | string | The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. |
| identity_sid? | string | The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations. |
| address_sid? | string | The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. |
| emergency_status? | enum | The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. |
| emergency_address_sid? | string | The SID of the emergency address configuration to use for emergency calling from the new phone number. |
| trunk_sid? | string | The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. |
| voice_receive_mode? | enum | |
| bundle_sid? | string | The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 incoming phone number toll free
fn lookup(beta?: boolean, friendly_name?: string, phone_number?: string, origin?: string, max_items?: number)
List incoming phone number toll frees and record each as a data artifact (capped at 200 by default; writes a incoming_phone_number_toll_free_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| beta? | boolean | Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| friendly_name? | string | A string that identifies the resources to read. |
| phone_number? | string | The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. |
| origin? | string | Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included. |
| max_items? | number | Stop 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 incoming_phone_number_toll_free_lookup record reports truncated: true. |
Resources
state— Incoming phone number toll free resource state
ip_access_control_list.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name | string | A human readable descriptive text that describes the IpAccessControlList, up to 255 characters long. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 ip access control list
fn get(id: string)
Get a ip access control list
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip access control list |
fn lookup(max_items?: number)
List ip access control lists and record each as a data artifact (capped at 200 by default; writes a ip_access_control_list_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 ip_access_control_list_lookup record reports truncated: true. |
fn update()
Update ip access control list attributes
fn delete(id: string)
Delete the ip access control list
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip access control list |
fn sync()
Sync ip access control list state from Twilio
Resources
state— Ip access control list resource state
ip_access_control_list_mapping.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| domain_sid | string | Path scope for the ip access control list mapping: domain_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ip_access_control_list_sid | string | The unique id of the IP access control list to map to the SIP domain. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 ip access control list mapping
fn get(id: string)
Get a ip access control list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip access control list mapping |
fn lookup(max_items?: number)
List ip access control list mappings and record each as a data artifact (capped at 200 by default; writes a ip_access_control_list_mapping_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 ip_access_control_list_mapping_lookup record reports truncated: true. |
fn delete(id: string)
Delete the ip access control list mapping
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip access control list mapping |
fn sync()
Sync ip access control list mapping state from Twilio
Resources
state— Ip access control list mapping resource state
ip_address.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| ip_access_control_list_sid | string | Path scope for the ip address: ip_access_control_list_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ip_address | string | An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. |
| friendly_name | string | A human readable descriptive text for this resource, up to 255 characters long. |
| cidr_prefix_length? | number | An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 ip address
fn get(id: string)
Get a ip address
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip address |
fn lookup(max_items?: number)
List ip addresss and record each as a data artifact (capped at 200 by default; writes a ip_address_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 ip_address_lookup record reports truncated: true. |
fn update()
Update ip address attributes
fn delete(id: string)
Delete the ip address
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the ip address |
fn sync()
Sync ip address state from Twilio
Resources
state— Ip address resource state
key.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 key
fn get(id: string)
Get a key
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the key |
fn lookup(max_items?: number)
List keys and record each as a data artifact (capped at 200 by default; writes a key_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 key_lookup record reports truncated: true. |
fn update()
Update key attributes
fn delete(id: string)
Delete the key
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the key |
fn sync()
Sync key state from Twilio
Resources
state— Key resource state
last_month.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List last months and record each as a data artifact (capped at 200 by default; writes a last_month_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 last_month_lookup record reports truncated: true. |
Resources
state— Last month resource state
machine_to_machine.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the machine to machine: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List machine to machines and record each as a data artifact (capped at 200 by default; writes a machine_to_machine_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 machine_to_machine_lookup record reports truncated: true. |
Resources
state— Machine to machine resource state
media.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| message_sid | string | Path scope for the media: message_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 media
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the media |
fn lookup(date_created?: string, date_created_before?: string, date_created_after?: string, max_items?: number)
List medias and record each as a data artifact (capped at 200 by default; writes a media_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| date_created? | string | Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of t |
| date_created_before? | string | Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of t |
| date_created_after? | string | Only include Media resources that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read Media that were created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read Media that were created on or before midnight of t |
| max_items? | number | Stop 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 media_lookup record reports truncated: true. |
fn delete(id: string)
Delete the media
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the media |
fn sync()
Sync media state from Twilio
Resources
state— Media resource state
member.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| queue_sid | string | Path scope for the member: queue_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| url | string | The absolute URL of the Queue resource. |
| method? | enum | How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 member
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the member |
fn lookup(max_items?: number)
List members and record each as a data artifact (capped at 200 by default; writes a member_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 member_lookup record reports truncated: true. |
fn update()
Update member attributes
fn sync()
Sync member state from Twilio
Resources
state— Member resource state
message.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| body? | string | The text content of the outgoing message. Can be up to 1,600 characters in length. SMS only: If the `body` contains more than 160 [GSM-7](https://www.twilio.com/docs/glossary/what-is-gsm-7-character-encoding) characters (or 70 [UCS-2](https://www.twilio.com/docs/glossary/what-is-ucs-2-character-enco |
| status? | enum | |
| to | string | The recipient's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (for SMS/MMS) or [channel address](https://www.twilio.com/docs/messaging/channels), e.g. `whatsapp:+15552229999`. |
| status_callback? | string | The URL of the endpoint to which Twilio sends [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url). URL must contain a valid hostname and underscores are not allowed. If you include this parameter with the `messaging_servi |
| application_sid? | string | The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL. Note that t |
| max_price? | number | [OBSOLETE] This parameter will no longer have any effect as of 2024-06-03. |
| provide_feedback? | boolean | Boolean indicating whether or not you intend to provide delivery confirmation feedback to Twilio (used in conjunction with the [Message Feedback subresource](https://www.twilio.com/docs/sms/api/message-feedback-resource)). Default value is `false`. |
| attempt? | number | Total number of attempts made (including this request) to send the message regardless of the provider used |
| validity_period? | number | The maximum length in seconds that the Message can remain in Twilio's outgoing message queue. If a queued Message exceeds the `validity_period`, the Message is not sent. Accepted values are integers from `1` to `36000`. Default value is `36000`. A `validity_period` greater than `5` is recommended. [ |
| force_delivery? | boolean | Reserved |
| content_retention? | enum | Determines if the message content can be stored or redacted based on privacy settings |
| address_retention? | enum | Determines if the address can be stored or obfuscated based on privacy settings |
| smart_encoded? | boolean | Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`. |
| persistent_action? | array | Rich actions for non-SMS/MMS channels. Used for [sending location in WhatsApp messages](https://www.twilio.com/docs/whatsapp/message-features#location-messages-with-whatsapp). |
| traffic_type? | enum | |
| shorten_urls? | boolean | For Messaging Services with [Link Shortening configured](https://www.twilio.com/docs/messaging/features/link-shortening) only: A Boolean indicating whether or not Twilio should shorten links in the `body` of the Message. Default value is `false`. If `true`, the `messaging_service_sid` parameter must |
| schedule_type? | enum | For Messaging Services only: Include this parameter with a value of `fixed` in conjuction with the `send_time` parameter in order to [schedule a Message](https://www.twilio.com/docs/messaging/features/message-scheduling). |
| send_at? | string | The time that Twilio will send the message. Must be in ISO 8601 format. |
| send_as_mms? | boolean | If set to `true`, Twilio delivers the message as a single MMS message, regardless of the presence of media. |
| content_variables? | string | For [Content Editor/API](https://www.twilio.com/docs/content) only: Key-value pairs of [Template variables](https://www.twilio.com/docs/content/using-variables-with-content-api) and their substitution values. `content_sid` parameter must also be provided. If values are not defined in the `content_va |
| risk_check? | enum | Include this parameter with a value of `disable` to skip any kind of risk check on the respective message request. |
| from? | string | The sender's Twilio phone number (in [E.164](https://en.wikipedia.org/wiki/E.164) format), [alphanumeric sender ID](https://www.twilio.com/docs/sms/quickstart), [Wireless SIM](https://www.twilio.com/docs/iot/wireless/programmable-wireless-send-machine-machine-sms-commands), [short code](https://www. |
| fallback_from? | string | A fallback SMS sender to use when the recipient cannot be reached over RCS. This parameter may only be used when also providing a [Messaging Service](https://twilio.com/docs/messaging/services) containing an RCS sender. The fallback SMS sender must be either a Twilio phone number (in [E.164](https:/ |
| messaging_service_sid? | string | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) you want to associate with the Message. When this parameter is provided and the `from` parameter is omitted, Twilio selects the optimal sender from the Messaging Service's Sender Pool. You may also provide a `from` pa |
| media_url? | array | The URL of media to include in the Message content. `jpeg`, `jpg`, `gif`, and `png` file types are fully supported by Twilio and content is formatted for delivery on destination devices. The media size limit is 5 MB for supported file types (`jpeg`, `jpg`, `png`, `gif`) and 500 KB for [other types]( |
| content_sid? | string | For [Content Editor/API](https://www.twilio.com/docs/content) only: The SID of the Content Template to be used with the Message, e.g., `HXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`. If this parameter is not provided, a Content Template is not used. Find the SID in the Console on the Content Editor page. For Cont |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 message
fn get(id: string)
Get a message
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the message |
fn lookup(to?: string, from?: string, date_sent?: string, date_sent_before?: string, date_sent_after?: string, max_items?: number)
List messages and record each as a data artifact (capped at 200 by default; writes a message_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| to? | string | Filter by recipient. For example: Set this parameter to `+15558881111` to retrieve a list of Message resources sent to `+15558881111`. |
| from? | string | Filter by sender. For example: Set this parameter to `+15552229999` to retrieve a list of Message resources sent by `+15552229999`. |
| date_sent? | string | Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific da |
| date_sent_before? | string | Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific da |
| date_sent_after? | string | Filter by Message `sent_date`. Accepts GMT dates in the following formats: `YYYY-MM-DD` (to find Messages with a specific `sent_date`), `<=YYYY-MM-DD` (to find Messages with `sent_date`s on and before a specific date), and `>=YYYY-MM-DD` (to find Messages with `sent_dates` on and after a specific da |
| max_items? | number | Stop 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 message_lookup record reports truncated: true. |
fn update()
Update message attributes
fn delete(id: string)
Delete the message
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the message |
fn sync()
Sync message state from Twilio
Resources
state— Message resource state
monthly.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List monthlys and record each as a data artifact (capped at 200 by default; writes a monthly_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 monthly_lookup record reports truncated: true. |
Resources
state— Monthly resource state
national.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the national: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List nationals and record each as a data artifact (capped at 200 by default; writes a national_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 national_lookup record reports truncated: true. |
Resources
state— National resource state
outgoing_caller_ids.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number. |
| phone_number | string | The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. |
| call_delay? | number | The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`. |
| extension? | string | The digits to dial after connecting the verification call. |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information about the verification process to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 outgoing caller ids
fn get(id: string)
Get a outgoing caller ids
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the outgoing caller ids |
fn lookup(phone_number?: string, friendly_name?: string, max_items?: number)
List outgoing caller idss and record each as a data artifact (capped at 200 by default; writes a outgoing_caller_ids_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| phone_number? | string | The phone number of the OutgoingCallerId resources to read. |
| friendly_name? | string | The string that identifies the OutgoingCallerId resources to read. |
| max_items? | number | Stop 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 outgoing_caller_ids_lookup record reports truncated: true. |
fn update()
Update outgoing caller ids attributes
fn delete(id: string)
Delete the outgoing caller ids
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the outgoing caller ids |
fn sync()
Sync outgoing caller ids state from Twilio
Resources
state— Outgoing caller ids resource state
participant.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| conference_sid | string | Path scope for the participant: conference_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| muted? | boolean | Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`. |
| hold? | boolean | Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference. |
| hold_url? | string | The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. |
| hold_method? | enum | The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`. |
| announce_url? | string | The URL we call using the `announce_method` for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. |
| announce_method? | enum | The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`. |
| wait_url? | string | The URL that Twilio calls using the `wait_method` before the conference has started. The URL may return an MP3 file, a WAV file, or a TwiML document. The default value is the URL of our standard hold music. If you do not want anything to play while waiting for the conference to start, specify an emp |
| wait_method? | enum | The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. |
| beep_on_exit? | boolean | Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`. |
| end_conference_on_exit? | boolean | Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`. |
| coaching? | boolean | Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined. |
| call_sid_to_coach? | string | The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. |
| from | string | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number o |
| to | string | The phone number, SIP address, Client, TwiML App identifier that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `sip:name@company.com`. Client identifiers are formatted `client:name`. TwiML |
| status_callback? | string | The URL we should call using the `status_callback_method` to send status information to your application. |
| status_callback_method? | enum | The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`. |
| status_callback_event? | array | The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`. |
| label? | string | A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant. |
| timeout? | number | The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer |
| record? | boolean | Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`. |
| beep? | string | Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`. |
| start_conference_on_enter? | boolean | Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference. |
| early_media? | boolean | Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`. |
| max_participants? | number | The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`. |
| conference_record? | string | Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`. |
| conference_trim? | string | Whether to trim leading and trailing silence from the conference recording. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`. |
| conference_status_callback? | string | The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored. |
| conference_status_callback_method? | enum | The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| conference_status_callback_event? | array | The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`. |
| recording_channels? | string | The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`. |
| recording_status_callback? | string | The URL that we should call using the `recording_status_callback_method` when the recording status changes. |
| recording_status_callback_method? | enum | The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| sip_auth_username? | string | The SIP username used for authentication. |
| sip_auth_password? | string | The SIP password for authentication. |
| region? | string | The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `us2`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. |
| conference_recording_status_callback? | string | The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available. |
| conference_recording_status_callback_method? | enum | The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`. |
| recording_status_callback_event? | array | The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'`. |
| conference_recording_status_callback_event? | array | The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `'in-progress completed failed'` |
| jitter_buffer_size? | string | Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`. |
| byoc? | string | The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) |
| caller_id? | string | The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number o |
| call_reason? | string | The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) |
| recording_track? | string | The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio. |
| recording_configuration_id? | string | The identifier of the configuration to be used when creating and processing the recording |
| time_limit? | number | The maximum duration of the call in seconds. Constraints depend on account and configuration. |
| machine_detection? | string | Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering mac |
| machine_detection_timeout? | number | The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. |
| machine_detection_speech_threshold? | number | The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400. |
| machine_detection_speech_end_threshold? | number | The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200. |
| machine_detection_silence_timeout? | number | The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000. |
| amd_status_callback? | string | The URL that we should call using the `amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. |
| amd_status_callback_method? | enum | The HTTP method we should use when calling the `amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. |
| trim? | string | Whether to trim any leading and trailing silence from the participant recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`. |
| call_token? | string | A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the |
| passports? | string | The STIR/SHAKEN passport for this call, provided as a base64 encoded string. Multiple passports (at max 5) are comma separated and provided as base64 encoded string |
| client_notification_url? | string | The URL that we should use to deliver `push call notification`. |
| caller_display_name? | string | The name that populates the display name in the From header. Must be between 2 and 255 characters. Only applicable for calls to sip address. |
| emergency_caller_position? | string | The emergency caller\'s GPS coordinates in decimal degrees format. Format: "latitude longitude" (space-separated) - Latitude: decimal degrees, range -90.0 to +90.0 (negative for South, positive for North) - Longitude: decimal degrees, range -180.0 to +180.0 (negative for West, positive for East) - Pr |
| emergency_caller_location? | string | The emergency caller's physical location description within a building or facility. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| emergency_name? | string | The emergency caller's organization or entity name. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| emergency_address? | string | The emergency caller's street address including street number and street name. Note: If the value exceeds 60 characters, only the first 60 characters will be used. |
| emergency_zip_code? | string | The emergency caller's postal code or ZIP code. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| emergency_city? | string | The emergency caller's city or municipality name. Should be the official city name as recognized by local authorities. Used in combination with state and country for emergency call routing. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| emergency_state? | string | The emergency caller's state or province. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| emergency_country? | string | The emergency caller's country. Currently supported US and CA only. Note: If the value exceeds 20 characters, only the first 20 characters will be used. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 participant
fn get(id: string)
Get a participant
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the participant |
fn lookup(muted?: boolean, hold?: boolean, coaching?: boolean, 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)
| Argument | Type | Description |
|---|---|---|
| muted? | boolean | Whether to return only participants that are muted. Can be: `true` or `false`. |
| hold? | boolean | Whether to return only participants that are on hold. Can be: `true` or `false`. |
| coaching? | boolean | Whether to return only participants who are coaching another call. Can be: `true` or `false`. |
| max_items? | number | Stop 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 update()
Update participant attributes
fn delete(id: string)
Delete the participant
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the participant |
fn sync()
Sync participant state from Twilio
Resources
state— Participant resource state
payload.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| reference_sid | string | Path scope for the payload: reference_sid |
| add_on_result_sid | string | Path scope for the payload: add_on_result_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 payload
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the payload |
fn lookup(max_items?: number)
List payloads and record each as a data artifact (capped at 200 by default; writes a payload_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 payload_lookup record reports truncated: true. |
fn delete(id: string)
Delete the payload
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the payload |
fn sync()
Sync payload state from Twilio
Resources
state— Payload resource state
payment.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the payment: call_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| idempotency_key | string | A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated. |
| status_callback | string | Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback) |
| capture? | enum | The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, `bank-account-number`, or their `-matcher` variants for input confirmation when `RequireMatchingInputs` is enabled. |
| status? | enum | Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected Pay Connector for processing. |
| bank_account_type? | enum | Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`. |
| charge_amount? | number | A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize. |
| currency? | string | The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted. |
| description? | string | The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions. |
| input? | string | A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs. |
| min_postal_code_length? | number | A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits. |
| parameter? | string | A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the <Pay> Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors). |
| payment_connector? | string | This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`. |
| payment_method? | enum | Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`. |
| postal_code? | boolean | Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`. |
| security_code? | boolean | Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`. |
| timeout? | number | The number of seconds that <Pay> should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`. |
| token_type? | enum | Indicates whether the payment method should be tokenized as a `one-time`, `reusable`, or `payment-method` token. The default value is `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized. |
| valid_card_types? | string | Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex` |
| require_matching_inputs? | string | A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`. |
| confirmation? | enum | Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 payment
fn update()
Update payment attributes
queue.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name | string | A descriptive string that you created to describe this resource. It can be up to 64 characters long. |
| max_size? | number | The maximum number of calls allowed to be in the queue. The default is 1000. The maximum is 5000. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 queue
fn get(id: string)
Get a queue
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the queue |
fn lookup(max_items?: number)
List queues and record each as a data artifact (capped at 200 by default; writes a queue_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 queue_lookup record reports truncated: true. |
fn update()
Update queue attributes
fn delete(id: string)
Delete the queue
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the queue |
fn sync()
Sync queue state from Twilio
Resources
state— Queue resource state
record.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List records and record each as a data artifact (capped at 200 by default; writes a record_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 record_lookup record reports truncated: true. |
Resources
state— Record resource state
recording_transcription.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| recording_sid | string | Path scope for the recording transcription: recording_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 recording transcription
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the recording transcription |
fn lookup(max_items?: number)
List recording transcriptions and record each as a data artifact (capped at 200 by default; writes a recording_transcription_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 recording_transcription_lookup record reports truncated: true. |
fn delete(id: string)
Delete the recording transcription
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the recording transcription |
fn sync()
Sync recording transcription state from Twilio
Resources
state— Recording transcription resource state
shared_cost.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the shared cost: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List shared costs and record each as a data artifact (capped at 200 by default; writes a shared_cost_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 shared_cost_lookup record reports truncated: true. |
Resources
state— Shared cost resource state
short_code.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code. |
| api_version? | string | The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. |
| sms_url? | string | The URL we should call when receiving an incoming SMS message to this short code. |
| sms_method? | enum | The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`. |
| sms_fallback_url? | string | The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`. |
| sms_fallback_method? | enum | The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 short code
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the short code |
fn lookup(friendly_name?: string, short_code?: string, max_items?: number)
List short codes and record each as a data artifact (capped at 200 by default; writes a short_code_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| friendly_name? | string | The string that identifies the ShortCode resources to read. |
| short_code? | string | Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. |
| max_items? | number | Stop 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 short_code_lookup record reports truncated: true. |
fn update()
Update short code attributes
fn sync()
Sync short code state from Twilio
Resources
state— Short code resource state
signing_key.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| friendly_name? | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 signing key
fn get(id: string)
Get a signing key
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the signing key |
fn lookup(max_items?: number)
List signing keys and record each as a data artifact (capped at 200 by default; writes a signing_key_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| max_items? | number | Stop 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 signing_key_lookup record reports truncated: true. |
fn update()
Update signing key attributes
fn delete(id: string)
Delete the signing key
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the signing key |
fn sync()
Sync signing key state from Twilio
Resources
state— Signing key resource state
siprec.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the siprec: call_sid |
| status? | enum | |
| name? | string | The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec. |
| connector_name? | string | Unique name used when configuring the connector via Marketplace Add-on. |
| track? | enum | One of `inbound_track`, `outbound_track`, `both_tracks`. |
| status_callback? | string | Absolute URL of the status callback. |
| status_callback_method? | enum | The http method for the status_callback (one of GET, POST). |
| parameter1_name? | string | Parameter name |
| parameter1_value? | string | Parameter value |
| parameter2_name? | string | Parameter name |
| parameter2_value? | string | Parameter value |
| parameter3_name? | string | Parameter name |
| parameter3_value? | string | Parameter value |
| parameter4_name? | string | Parameter name |
| parameter4_value? | string | Parameter value |
| parameter5_name? | string | Parameter name |
| parameter5_value? | string | Parameter value |
| parameter6_name? | string | Parameter name |
| parameter6_value? | string | Parameter value |
| parameter7_name? | string | Parameter name |
| parameter7_value? | string | Parameter value |
| parameter8_name? | string | Parameter name |
| parameter8_value? | string | Parameter value |
| parameter9_name? | string | Parameter name |
| parameter9_value? | string | Parameter value |
| parameter10_name? | string | Parameter name |
| parameter10_value? | string | Parameter value |
| parameter11_name? | string | Parameter name |
| parameter11_value? | string | Parameter value |
| parameter12_name? | string | Parameter name |
| parameter12_value? | string | Parameter value |
| parameter13_name? | string | Parameter name |
| parameter13_value? | string | Parameter value |
| parameter14_name? | string | Parameter name |
| parameter14_value? | string | Parameter value |
| parameter15_name? | string | Parameter name |
| parameter15_value? | string | Parameter value |
| parameter16_name? | string | Parameter name |
| parameter16_value? | string | Parameter value |
| parameter17_name? | string | Parameter name |
| parameter17_value? | string | Parameter value |
| parameter18_name? | string | Parameter name |
| parameter18_value? | string | Parameter value |
| parameter19_name? | string | Parameter name |
| parameter19_value? | string | Parameter value |
| parameter20_name? | string | Parameter name |
| parameter20_value? | string | Parameter value |
| parameter21_name? | string | Parameter name |
| parameter21_value? | string | Parameter value |
| parameter22_name? | string | Parameter name |
| parameter22_value? | string | Parameter value |
| parameter23_name? | string | Parameter name |
| parameter23_value? | string | Parameter value |
| parameter24_name? | string | Parameter name |
| parameter24_value? | string | Parameter value |
| parameter25_name? | string | Parameter name |
| parameter25_value? | string | Parameter value |
| parameter26_name? | string | Parameter name |
| parameter26_value? | string | Parameter value |
| parameter27_name? | string | Parameter name |
| parameter27_value? | string | Parameter value |
| parameter28_name? | string | Parameter name |
| parameter28_value? | string | Parameter value |
| parameter29_name? | string | Parameter name |
| parameter29_value? | string | Parameter value |
| parameter30_name? | string | Parameter name |
| parameter30_value? | string | Parameter value |
| parameter31_name? | string | Parameter name |
| parameter31_value? | string | Parameter value |
| parameter32_name? | string | Parameter name |
| parameter32_value? | string | Parameter value |
| parameter33_name? | string | Parameter name |
| parameter33_value? | string | Parameter value |
| parameter34_name? | string | Parameter name |
| parameter34_value? | string | Parameter value |
| parameter35_name? | string | Parameter name |
| parameter35_value? | string | Parameter value |
| parameter36_name? | string | Parameter name |
| parameter36_value? | string | Parameter value |
| parameter37_name? | string | Parameter name |
| parameter37_value? | string | Parameter value |
| parameter38_name? | string | Parameter name |
| parameter38_value? | string | Parameter value |
| parameter39_name? | string | Parameter name |
| parameter39_value? | string | Parameter value |
| parameter40_name? | string | Parameter name |
| parameter40_value? | string | Parameter value |
| parameter41_name? | string | Parameter name |
| parameter41_value? | string | Parameter value |
| parameter42_name? | string | Parameter name |
| parameter42_value? | string | Parameter value |
| parameter43_name? | string | Parameter name |
| parameter43_value? | string | Parameter value |
| parameter44_name? | string | Parameter name |
| parameter44_value? | string | Parameter value |
| parameter45_name? | string | Parameter name |
| parameter45_value? | string | Parameter value |
| parameter46_name? | string | Parameter name |
| parameter46_value? | string | Parameter value |
| parameter47_name? | string | Parameter name |
| parameter47_value? | string | Parameter value |
| parameter48_name? | string | Parameter name |
| parameter48_value? | string | Parameter value |
| parameter49_name? | string | Parameter name |
| parameter49_value? | string | Parameter value |
| parameter50_name? | string | Parameter name |
| parameter50_value? | string | Parameter value |
| parameter51_name? | string | Parameter name |
| parameter51_value? | string | Parameter value |
| parameter52_name? | string | Parameter name |
| parameter52_value? | string | Parameter value |
| parameter53_name? | string | Parameter name |
| parameter53_value? | string | Parameter value |
| parameter54_name? | string | Parameter name |
| parameter54_value? | string | Parameter value |
| parameter55_name? | string | Parameter name |
| parameter55_value? | string | Parameter value |
| parameter56_name? | string | Parameter name |
| parameter56_value? | string | Parameter value |
| parameter57_name? | string | Parameter name |
| parameter57_value? | string | Parameter value |
| parameter58_name? | string | Parameter name |
| parameter58_value? | string | Parameter value |
| parameter59_name? | string | Parameter name |
| parameter59_value? | string | Parameter value |
| parameter60_name? | string | Parameter name |
| parameter60_value? | string | Parameter value |
| parameter61_name? | string | Parameter name |
| parameter61_value? | string | Parameter value |
| parameter62_name? | string | Parameter name |
| parameter62_value? | string | Parameter value |
| parameter63_name? | string | Parameter name |
| parameter63_value? | string | Parameter value |
| parameter64_name? | string | Parameter name |
| parameter64_value? | string | Parameter value |
| parameter65_name? | string | Parameter name |
| parameter65_value? | string | Parameter value |
| parameter66_name? | string | Parameter name |
| parameter66_value? | string | Parameter value |
| parameter67_name? | string | Parameter name |
| parameter67_value? | string | Parameter value |
| parameter68_name? | string | Parameter name |
| parameter68_value? | string | Parameter value |
| parameter69_name? | string | Parameter name |
| parameter69_value? | string | Parameter value |
| parameter70_name? | string | Parameter name |
| parameter70_value? | string | Parameter value |
| parameter71_name? | string | Parameter name |
| parameter71_value? | string | Parameter value |
| parameter72_name? | string | Parameter name |
| parameter72_value? | string | Parameter value |
| parameter73_name? | string | Parameter name |
| parameter73_value? | string | Parameter value |
| parameter74_name? | string | Parameter name |
| parameter74_value? | string | Parameter value |
| parameter75_name? | string | Parameter name |
| parameter75_value? | string | Parameter value |
| parameter76_name? | string | Parameter name |
| parameter76_value? | string | Parameter value |
| parameter77_name? | string | Parameter name |
| parameter77_value? | string | Parameter value |
| parameter78_name? | string | Parameter name |
| parameter78_value? | string | Parameter value |
| parameter79_name? | string | Parameter name |
| parameter79_value? | string | Parameter value |
| parameter80_name? | string | Parameter name |
| parameter80_value? | string | Parameter value |
| parameter81_name? | string | Parameter name |
| parameter81_value? | string | Parameter value |
| parameter82_name? | string | Parameter name |
| parameter82_value? | string | Parameter value |
| parameter83_name? | string | Parameter name |
| parameter83_value? | string | Parameter value |
| parameter84_name? | string | Parameter name |
| parameter84_value? | string | Parameter value |
| parameter85_name? | string | Parameter name |
| parameter85_value? | string | Parameter value |
| parameter86_name? | string | Parameter name |
| parameter86_value? | string | Parameter value |
| parameter87_name? | string | Parameter name |
| parameter87_value? | string | Parameter value |
| parameter88_name? | string | Parameter name |
| parameter88_value? | string | Parameter value |
| parameter89_name? | string | Parameter name |
| parameter89_value? | string | Parameter value |
| parameter90_name? | string | Parameter name |
| parameter90_value? | string | Parameter value |
| parameter91_name? | string | Parameter name |
| parameter91_value? | string | Parameter value |
| parameter92_name? | string | Parameter name |
| parameter92_value? | string | Parameter value |
| parameter93_name? | string | Parameter name |
| parameter93_value? | string | Parameter value |
| parameter94_name? | string | Parameter name |
| parameter94_value? | string | Parameter value |
| parameter95_name? | string | Parameter name |
| parameter95_value? | string | Parameter value |
| parameter96_name? | string | Parameter name |
| parameter96_value? | string | Parameter value |
| parameter97_name? | string | Parameter name |
| parameter97_value? | string | Parameter value |
| parameter98_name? | string | Parameter name |
| parameter98_value? | string | Parameter value |
| parameter99_name? | string | Parameter name |
| parameter99_value? | string | Parameter value |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 siprec
fn update()
Update siprec attributes
stream.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the stream: call_sid |
| status? | enum | |
| url | string | Relative or absolute URL where WebSocket connection will be established. |
| name? | string | The user-specified name of this Stream, if one was given when the Stream was created. This can be used to stop the Stream. |
| track? | enum | The tracks to be included in the Stream. Possible values are `inbound_track`, `outbound_track`, `both_tracks`. Default value is `inbound_track`. |
| status_callback? | string | Absolute URL to which Twilio sends status callback HTTP requests. |
| status_callback_method? | enum | The HTTP method Twilio uses when sending `status_callback` requests. Possible values are `GET` and `POST`. Default is `POST`. |
| parameter1_name? | string | Parameter name |
| parameter1_value? | string | Parameter value |
| parameter2_name? | string | Parameter name |
| parameter2_value? | string | Parameter value |
| parameter3_name? | string | Parameter name |
| parameter3_value? | string | Parameter value |
| parameter4_name? | string | Parameter name |
| parameter4_value? | string | Parameter value |
| parameter5_name? | string | Parameter name |
| parameter5_value? | string | Parameter value |
| parameter6_name? | string | Parameter name |
| parameter6_value? | string | Parameter value |
| parameter7_name? | string | Parameter name |
| parameter7_value? | string | Parameter value |
| parameter8_name? | string | Parameter name |
| parameter8_value? | string | Parameter value |
| parameter9_name? | string | Parameter name |
| parameter9_value? | string | Parameter value |
| parameter10_name? | string | Parameter name |
| parameter10_value? | string | Parameter value |
| parameter11_name? | string | Parameter name |
| parameter11_value? | string | Parameter value |
| parameter12_name? | string | Parameter name |
| parameter12_value? | string | Parameter value |
| parameter13_name? | string | Parameter name |
| parameter13_value? | string | Parameter value |
| parameter14_name? | string | Parameter name |
| parameter14_value? | string | Parameter value |
| parameter15_name? | string | Parameter name |
| parameter15_value? | string | Parameter value |
| parameter16_name? | string | Parameter name |
| parameter16_value? | string | Parameter value |
| parameter17_name? | string | Parameter name |
| parameter17_value? | string | Parameter value |
| parameter18_name? | string | Parameter name |
| parameter18_value? | string | Parameter value |
| parameter19_name? | string | Parameter name |
| parameter19_value? | string | Parameter value |
| parameter20_name? | string | Parameter name |
| parameter20_value? | string | Parameter value |
| parameter21_name? | string | Parameter name |
| parameter21_value? | string | Parameter value |
| parameter22_name? | string | Parameter name |
| parameter22_value? | string | Parameter value |
| parameter23_name? | string | Parameter name |
| parameter23_value? | string | Parameter value |
| parameter24_name? | string | Parameter name |
| parameter24_value? | string | Parameter value |
| parameter25_name? | string | Parameter name |
| parameter25_value? | string | Parameter value |
| parameter26_name? | string | Parameter name |
| parameter26_value? | string | Parameter value |
| parameter27_name? | string | Parameter name |
| parameter27_value? | string | Parameter value |
| parameter28_name? | string | Parameter name |
| parameter28_value? | string | Parameter value |
| parameter29_name? | string | Parameter name |
| parameter29_value? | string | Parameter value |
| parameter30_name? | string | Parameter name |
| parameter30_value? | string | Parameter value |
| parameter31_name? | string | Parameter name |
| parameter31_value? | string | Parameter value |
| parameter32_name? | string | Parameter name |
| parameter32_value? | string | Parameter value |
| parameter33_name? | string | Parameter name |
| parameter33_value? | string | Parameter value |
| parameter34_name? | string | Parameter name |
| parameter34_value? | string | Parameter value |
| parameter35_name? | string | Parameter name |
| parameter35_value? | string | Parameter value |
| parameter36_name? | string | Parameter name |
| parameter36_value? | string | Parameter value |
| parameter37_name? | string | Parameter name |
| parameter37_value? | string | Parameter value |
| parameter38_name? | string | Parameter name |
| parameter38_value? | string | Parameter value |
| parameter39_name? | string | Parameter name |
| parameter39_value? | string | Parameter value |
| parameter40_name? | string | Parameter name |
| parameter40_value? | string | Parameter value |
| parameter41_name? | string | Parameter name |
| parameter41_value? | string | Parameter value |
| parameter42_name? | string | Parameter name |
| parameter42_value? | string | Parameter value |
| parameter43_name? | string | Parameter name |
| parameter43_value? | string | Parameter value |
| parameter44_name? | string | Parameter name |
| parameter44_value? | string | Parameter value |
| parameter45_name? | string | Parameter name |
| parameter45_value? | string | Parameter value |
| parameter46_name? | string | Parameter name |
| parameter46_value? | string | Parameter value |
| parameter47_name? | string | Parameter name |
| parameter47_value? | string | Parameter value |
| parameter48_name? | string | Parameter name |
| parameter48_value? | string | Parameter value |
| parameter49_name? | string | Parameter name |
| parameter49_value? | string | Parameter value |
| parameter50_name? | string | Parameter name |
| parameter50_value? | string | Parameter value |
| parameter51_name? | string | Parameter name |
| parameter51_value? | string | Parameter value |
| parameter52_name? | string | Parameter name |
| parameter52_value? | string | Parameter value |
| parameter53_name? | string | Parameter name |
| parameter53_value? | string | Parameter value |
| parameter54_name? | string | Parameter name |
| parameter54_value? | string | Parameter value |
| parameter55_name? | string | Parameter name |
| parameter55_value? | string | Parameter value |
| parameter56_name? | string | Parameter name |
| parameter56_value? | string | Parameter value |
| parameter57_name? | string | Parameter name |
| parameter57_value? | string | Parameter value |
| parameter58_name? | string | Parameter name |
| parameter58_value? | string | Parameter value |
| parameter59_name? | string | Parameter name |
| parameter59_value? | string | Parameter value |
| parameter60_name? | string | Parameter name |
| parameter60_value? | string | Parameter value |
| parameter61_name? | string | Parameter name |
| parameter61_value? | string | Parameter value |
| parameter62_name? | string | Parameter name |
| parameter62_value? | string | Parameter value |
| parameter63_name? | string | Parameter name |
| parameter63_value? | string | Parameter value |
| parameter64_name? | string | Parameter name |
| parameter64_value? | string | Parameter value |
| parameter65_name? | string | Parameter name |
| parameter65_value? | string | Parameter value |
| parameter66_name? | string | Parameter name |
| parameter66_value? | string | Parameter value |
| parameter67_name? | string | Parameter name |
| parameter67_value? | string | Parameter value |
| parameter68_name? | string | Parameter name |
| parameter68_value? | string | Parameter value |
| parameter69_name? | string | Parameter name |
| parameter69_value? | string | Parameter value |
| parameter70_name? | string | Parameter name |
| parameter70_value? | string | Parameter value |
| parameter71_name? | string | Parameter name |
| parameter71_value? | string | Parameter value |
| parameter72_name? | string | Parameter name |
| parameter72_value? | string | Parameter value |
| parameter73_name? | string | Parameter name |
| parameter73_value? | string | Parameter value |
| parameter74_name? | string | Parameter name |
| parameter74_value? | string | Parameter value |
| parameter75_name? | string | Parameter name |
| parameter75_value? | string | Parameter value |
| parameter76_name? | string | Parameter name |
| parameter76_value? | string | Parameter value |
| parameter77_name? | string | Parameter name |
| parameter77_value? | string | Parameter value |
| parameter78_name? | string | Parameter name |
| parameter78_value? | string | Parameter value |
| parameter79_name? | string | Parameter name |
| parameter79_value? | string | Parameter value |
| parameter80_name? | string | Parameter name |
| parameter80_value? | string | Parameter value |
| parameter81_name? | string | Parameter name |
| parameter81_value? | string | Parameter value |
| parameter82_name? | string | Parameter name |
| parameter82_value? | string | Parameter value |
| parameter83_name? | string | Parameter name |
| parameter83_value? | string | Parameter value |
| parameter84_name? | string | Parameter name |
| parameter84_value? | string | Parameter value |
| parameter85_name? | string | Parameter name |
| parameter85_value? | string | Parameter value |
| parameter86_name? | string | Parameter name |
| parameter86_value? | string | Parameter value |
| parameter87_name? | string | Parameter name |
| parameter87_value? | string | Parameter value |
| parameter88_name? | string | Parameter name |
| parameter88_value? | string | Parameter value |
| parameter89_name? | string | Parameter name |
| parameter89_value? | string | Parameter value |
| parameter90_name? | string | Parameter name |
| parameter90_value? | string | Parameter value |
| parameter91_name? | string | Parameter name |
| parameter91_value? | string | Parameter value |
| parameter92_name? | string | Parameter name |
| parameter92_value? | string | Parameter value |
| parameter93_name? | string | Parameter name |
| parameter93_value? | string | Parameter value |
| parameter94_name? | string | Parameter name |
| parameter94_value? | string | Parameter value |
| parameter95_name? | string | Parameter name |
| parameter95_value? | string | Parameter value |
| parameter96_name? | string | Parameter name |
| parameter96_value? | string | Parameter value |
| parameter97_name? | string | Parameter name |
| parameter97_value? | string | Parameter value |
| parameter98_name? | string | Parameter name |
| parameter98_value? | string | Parameter value |
| parameter99_name? | string | Parameter name |
| parameter99_value? | string | Parameter value |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 stream
fn update()
Update stream attributes
this_month.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List this months and record each as a data artifact (capped at 200 by default; writes a this_month_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 this_month_lookup record reports truncated: true. |
Resources
state— This month resource state
today.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List todays and record each as a data artifact (capped at 200 by default; writes a today_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 today_lookup record reports truncated: true. |
Resources
state— Today resource state
token.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ttl? | number | The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours). |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 token
trigger.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| callback_method? | enum | The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`. |
| callback_url | string | The URL we should call using `callback_method` when the trigger fires. |
| friendly_name? | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |
| trigger_value | string | The usage value at which the trigger should fire. For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`. |
| usage_category | string | The usage category that the trigger should watch. Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value. |
| recurring? | enum | The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT. |
| trigger_by? | enum | The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that fires the trigger. Can be: `count`, `usage`, or `price`, as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 trigger
fn get(id: string)
Get a trigger
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the trigger |
fn lookup(recurring?: enum, trigger_by?: enum, usage_category?: string, max_items?: number)
List triggers and record each as a data artifact (capped at 200 by default; writes a trigger_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| recurring? | enum | The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers. |
| trigger_by? | enum | The trigger field of the UsageTriggers to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). |
| usage_category? | string | The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). |
| max_items? | number | Stop 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 trigger_lookup record reports truncated: true. |
fn update()
Update trigger attributes
fn delete(id: string)
Delete the trigger
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the trigger |
fn sync()
Sync trigger state from Twilio
Resources
state— Trigger resource state
user_defined_message.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the user defined message: call_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| content | string | The User Defined Message in the form of URL-encoded JSON string. |
| idempotency_key? | string | A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 user defined message
user_defined_message_subscription.tsv2026.08.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| call_sid | string | Path scope for the user defined message subscription: call_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| callback | string | The URL we should call using the `method` to send user defined events to your application. URLs must contain a valid hostname (underscores are not permitted). |
| idempotency_key? | string | A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated. |
| method? | enum | The HTTP method Twilio will use when requesting the above `Url`. Either `GET` or `POST`. Default is `POST`. |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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 user defined message subscription
fn delete(id: string)
Delete the user defined message subscription
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the user defined message subscription |
voip.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| country_code | string | Path scope for the voip: country_code |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(area_code?: number, contains?: string, sms_enabled?: boolean, mms_enabled?: boolean, voice_enabled?: boolean, exclude_all_address_required?: boolean, exclude_local_address_required?: boolean, exclude_foreign_address_required?: boolean, beta?: boolean, near_number?: string, near_lat_long?: string, distance?: number, in_postal_code?: string, in_region?: string, in_rate_center?: string, in_lata?: string, in_locality?: string, fax_enabled?: boolean, max_items?: number)
List voips and record each as a data artifact (capped at 200 by default; writes a voip_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| area_code? | number | The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. |
| contains? | string | Matching pattern to identify phone numbers. This pattern can be between 2 and 16 characters long and allows all digits (0-9) and all non-diacritic latin alphabet letters (a-z, A-Z). It accepts four meta-characters: `*`, `%`, `+`, `$`. The `*` and `%` meta-characters can appear multiple times in the |
| sms_enabled? | boolean | Whether the phone numbers can receive text messages. Can be: `true` or `false`. |
| mms_enabled? | boolean | Whether the phone numbers can receive MMS messages. Can be: `true` or `false`. |
| voice_enabled? | boolean | Whether the phone numbers can receive calls. Can be: `true` or `false`. |
| exclude_all_address_required? | boolean | Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_local_address_required? | boolean | Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| exclude_foreign_address_required? | boolean | Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`. |
| beta? | boolean | Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`. |
| near_number? | string | Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. |
| near_lat_long? | string | Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. |
| distance? | number | The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. |
| in_postal_code? | string | Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. |
| in_region? | string | Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. |
| in_rate_center? | string | Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. |
| in_lata? | string | Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the |
| in_locality? | string | Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. |
| fax_enabled? | boolean | Whether the phone numbers can receive faxes. Can be: `true` or `false`. |
| max_items? | number | Stop 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 voip_lookup record reports truncated: true. |
Resources
state— Voip resource state
yearly.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List yearlys and record each as a data artifact (capped at 200 by default; writes a yearly_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 yearly_lookup record reports truncated: true. |
Resources
state— Yearly resource state
yesterday.tsv2026.08.25.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_sid? | string | Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable. |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| auth_token? | string | Twilio 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? | string | Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID. |
| api_key_secret? | string | Twilio 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(category?: string, start_date?: string, end_date?: string, include_subaccounts?: boolean, max_items?: number)
List yesterdays and record each as a data artifact (capped at 200 by default; writes a yesterday_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| category? | string | The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. |
| start_date? | string | Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date. |
| end_date? | string | Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date. |
| include_subaccounts? | boolean | Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account. |
| max_items? | number | Stop 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 yesterday_lookup record reports truncated: true. |
Resources
state— Yesterday resource state
04Stats
B
85 / 100
Downloads
14
Archive size
346.2 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