Twilio/messaging
@keeb/twilio/messagingv2026.08.25.2
01README
Twilio messaging API models
02Release Notes
- Updated: alpha_sender, brand_registration, brand_vetting, channel_sender, channels_sender, destination_alpha_sender, phone_number, service, short_code, tollfree_verification, us_app_to_person_usecase, us_app_to_person, usecase
03Models
alpha_sender.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. |
| service_sid | string | Path scope for the alpha sender: service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| alpha_sender | string | The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers. |
| 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 alpha sender
fn get(id: string)
Get a alpha sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the alpha sender |
fn lookup(max_items?: number)
List alpha senders and record each as a data artifact (capped at 200 by default; writes a alpha_sender_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 alpha_sender_lookup record reports truncated: true. |
fn delete(id: string)
Delete the alpha sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the alpha sender |
fn sync()
Sync alpha sender state from Twilio
Resources
state— Alpha sender resource state
brand_registration.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) |
| customer_profile_bundle_sid | string | Customer Profile Bundle Sid. |
| a2_p_profile_bundle_sid | string | A2P Messaging Profile Bundle Sid. |
| brand_type? | string | Type of brand being created. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases. |
| mock? | boolean | A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided. |
| skip_automatic_sec_vet? | boolean | A flag to disable automatic secondary vetting for brands which it would otherwise be done. |
| 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 brand registration
fn get(id: string)
Get a brand registration
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the brand registration |
fn lookup(max_items?: number)
List brand registrations and record each as a data artifact (capped at 200 by default; writes a brand_registration_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 brand_registration_lookup record reports truncated: true. |
fn update()
Update brand registration attributes
fn sync()
Sync brand registration state from Twilio
Resources
state— Brand registration resource state
brand_registration_otp.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. |
| brand_registration_sid | string | Path scope for the brand registration otp: brand_registration_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 create()
Create a brand registration otp
brand_vetting.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. |
| brand_sid | string | Path scope for the brand vetting: brand_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| vetting_provider | enum | The third-party provider that has conducted the vetting. One of “CampaignVerify” (Campaign Verify tokens) or “AEGIS” (Secondary Vetting). |
| vetting_id? | string | The unique ID of the vetting |
| 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 brand vetting
fn get(id: string)
Get a brand vetting
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the brand vetting |
fn lookup(vetting_provider?: enum, max_items?: number)
List brand vettings and record each as a data artifact (capped at 200 by default; writes a brand_vetting_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| vetting_provider? | enum | The third-party provider of the vettings 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 brand_vetting_lookup record reports truncated: true. |
fn sync()
Sync brand vetting state from Twilio
Resources
state— Brand vetting resource state
channel_sender.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. |
| messaging_service_sid | string | Path scope for the channel sender: messaging_service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| sid | string | The SID of the Channel Sender being added to the Service. |
| 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 channel sender
fn get(id: string)
Get a channel sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the channel sender |
fn lookup(max_items?: number)
List channel senders and record each as a data artifact (capped at 200 by default; writes a channel_sender_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 channel_sender_lookup record reports truncated: true. |
fn delete(id: string)
Delete the channel sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the channel sender |
fn sync()
Sync channel sender state from Twilio
Resources
state— Channel sender resource state
channels_sender.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 | Optional display label for the sender in the Twilio Console. |
| configuration? | object | The configuration settings for creating a sender. |
| webhook? | object | The configuration settings for webhooks. |
| profile? | object | The profile information for the sender. |
| sender_id | string | The ID of the sender in `whatsapp:<E.164_PHONE_NUMBER>` format. |
| 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 channels sender
fn get(id: string)
Get a channels sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the channels sender |
fn lookup(channel?: string, max_items?: number)
List channels senders and record each as a data artifact (capped at 200 by default; writes a channels_sender_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| channel? | string | |
| 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 channels_sender_lookup record reports truncated: true. |
fn update()
Update channels sender attributes
fn delete(id: string)
Delete the channels sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the channels sender |
fn sync()
Sync channels sender state from Twilio
Resources
state— Channels sender resource state
deactivation.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 deactivation
fn sync()
Sync deactivation state from Twilio
destination_alpha_sender.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. |
| service_sid | string | Path scope for the destination alpha sender: service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| alpha_sender | string | The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers. |
| iso_country_code? | string | The Optional Two Character ISO Country Code the Alphanumeric Sender ID will be used for. If the IsoCountryCode is not provided, a default Alpha Sender will be created that can be used across all countries. |
| 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 destination alpha sender
fn get(id: string)
Get a destination alpha sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the destination alpha sender |
fn lookup(iso_country_code?: string, max_items?: number)
List destination alpha senders and record each as a data artifact (capped at 200 by default; writes a destination_alpha_sender_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| iso_country_code? | string | Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code. |
| 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 destination_alpha_sender_lookup record reports truncated: true. |
fn delete(id: string)
Delete the destination alpha sender
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the destination alpha sender |
fn sync()
Sync destination alpha sender state from Twilio
Resources
state— Destination alpha sender resource state
domain_cert.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. |
| domain_sid | string | Path scope for the domain cert: domain_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| tls_cert | string | Contains the full TLS certificate and private for this domain in PEM format: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail. Twilio uses this information to process HTTPS traffic sent to your 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 get()
Get a domain cert
fn update()
Update domain cert attributes
fn delete()
Delete the domain cert
fn sync()
Sync domain cert state from Twilio
domain_config.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. |
| domain_sid | string | Path scope for the domain config: domain_sid |
| name? | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| fallback_url? | string | Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping. |
| callback_url? | string | URL to receive click events to your webhook whenever the recipients click on the shortened links |
| continue_on_failure? | boolean | Boolean field to set customer delivery preference when there is a failure in linkShortening service |
| disable_https? | boolean | Customer\'s choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified. |
| 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 domain config
fn update()
Update domain config attributes
fn sync()
Sync domain config state from Twilio
domain_config_messaging_service.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. |
| messaging_service_sid | string | Path scope for the domain config messaging service: messaging_service_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 domain config messaging service
fn sync()
Sync domain config messaging service state from Twilio
domain_validate_dns.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. |
| domain_sid | string | Path scope for the domain validate dns: domain_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 domain validate dns
fn sync()
Sync domain validate dns state from Twilio
external_campaign.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) |
| campaign_id | string | ID of the preregistered campaign. |
| messaging_service_sid | string | The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. |
| cnp_migration? | boolean | Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing re |
| 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 external campaign
indicator_typing_indicator.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) |
| channel | enum | The messaging channel. Must be "RCS". |
| message_id? | string | The SID of a recent inbound message from the recipient. Must be an SM or MM SID format. |
| from? | string | The RCS agent identifier of the sender (business). |
| to? | string | The RCS recipient identifier in E.164 format prefixed with "rcs:". |
| event? | enum | The type of typing event. Currently only "START" is supported for RCS, indicating the agent began typing. Defaults to "START". |
| 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 indicator typing indicator
link_shortening_domain_cert.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. |
| domain_sid | string | Path scope for the link shortening domain cert: domain_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 link shortening domain cert
fn sync()
Sync link shortening domain cert state from Twilio
linkshortening_messaging_service.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. |
| domain_sid | string | Path scope for the linkshortening messaging service: domain_sid |
| messaging_service_sid | string | Path scope for the linkshortening messaging service: messaging_service_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 update()
Update linkshortening messaging service attributes
fn delete(id: string)
Delete the linkshortening messaging service
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the linkshortening messaging service |
linkshortening_messaging_service_domain_association.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. |
| messaging_service_sid | string | Path scope for the linkshortening messaging service domain association: messaging_service_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 linkshortening messaging service domain association
fn sync()
Sync linkshortening messaging service domain association state from Twilio
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. |
| service_sid | string | Path scope for the phone number: service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| phone_number_sid | string | The SID of the Phone Number being added to the Service. |
| 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 phone number
fn get(id: string)
Get a phone number
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the phone number |
fn lookup(max_items?: number)
List phone numbers and record each as a data artifact (capped at 200 by default; writes a 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 phone_number_lookup record reports truncated: true. |
fn delete(id: string)
Delete the phone number
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the phone number |
fn sync()
Sync phone number state from Twilio
Resources
state— Phone number resource state
request_managed_cert.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. |
| domain_sid | string | Path scope for the request managed cert: domain_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 update()
Update request managed cert attributes
service.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. |
| inbound_request_url? | string | The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the |
| inbound_method? | enum | The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. |
| fallback_url? | string | The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Se |
| fallback_method? | enum | The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`. |
| status_callback? | string | The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. |
| sticky_sender? | boolean | Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. |
| mms_converter? | boolean | Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. |
| smart_encoding? | boolean | Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. |
| scan_message_content? | enum | Reserved. |
| fallback_to_long_code? | boolean | [OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures. |
| area_code_geomatch? | boolean | Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. |
| validity_period? | number | How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `36,000`. Default value is `36,000`. |
| synchronous_validation? | boolean | Reserved. |
| usecase? | string | A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. |
| use_inbound_webhook_on_number? | boolean | A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the ` |
| 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 service
fn get(id: string)
Get a service
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the service |
fn lookup(max_items?: number)
List services and record each as a data artifact (capped at 200 by default; writes a service_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 service_lookup record reports truncated: true. |
fn update()
Update service attributes
fn delete(id: string)
Delete the service
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the service |
fn sync()
Sync service state from Twilio
Resources
state— Service 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. |
| service_sid | string | Path scope for the short code: service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| short_code_sid | string | The SID of the ShortCode resource being added to the Service. |
| 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 short code
fn get(id: string)
Get a short code
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the short code |
fn lookup(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 |
|---|---|---|
| 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 delete(id: string)
Delete the short code
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the short code |
fn sync()
Sync short code state from Twilio
Resources
state— Short code resource state
tollfree_verification.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) |
| business_name | string | The name of the business or organization using the Tollfree number. |
| business_website | string | The website of the business or organization using the Tollfree number. |
| notification_email | string | The email address to receive the notification about the verification result. . |
| use_case_categories | array | The category of the use case for the Tollfree Number. List as many as are applicable. |
| use_case_summary | string | Use this to further explain how messaging is used by the business or organization. |
| production_message_sample | string | An example of message content, i.e. a sample message. |
| opt_in_image_urls | array | Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL. |
| opt_in_type | enum | Describe how a user opts-in to text messages. |
| message_volume | string | Estimate monthly volume of messages from the Tollfree Number. |
| business_street_address? | string | The address of the business or organization using the Tollfree number. |
| business_street_address2? | string | The address of the business or organization using the Tollfree number. |
| business_city? | string | The city of the business or organization using the Tollfree number. |
| business_state_province_region? | string | The state/province/region of the business or organization using the Tollfree number. |
| business_postal_code? | string | The postal code of the business or organization using the Tollfree number. |
| business_country? | string | The country of the business or organization using the Tollfree number. |
| additional_information? | string | Additional information to be provided for verification. |
| business_contact_first_name? | string | The first name of the contact for the business or organization using the Tollfree number. |
| business_contact_last_name? | string | The last name of the contact for the business or organization using the Tollfree number. |
| business_contact_email? | string | The email address of the contact for the business or organization using the Tollfree number. |
| business_contact_phone? | string | The E.164 formatted phone number of the contact for the business or organization using the Tollfree number. |
| edit_reason? | string | Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'. |
| business_registration_number? | string | A legally recognized business registration number. Required for all business types except SOLE_PROPRIETOR. |
| business_registration_authority? | enum | The organizational authority for business registrations. Required for all business types except SOLE_PROPRIETOR. |
| business_registration_country? | string | The country where the business is registered. Required for all business types except SOLE_PROPRIETOR. |
| business_type? | enum | The type of business, valid values are PRIVATE_PROFIT, PUBLIC_PROFIT, NON_PROFIT, SOLE_PROPRIETOR, GOVERNMENT. Required field. |
| business_registration_phone_number? | string | The E.164 formatted number associated with the business. |
| doing_business_as? | string | Trade name, sub entity, or downstream business name of business being submitted for verification |
| opt_in_confirmation_message? | string | The confirmation message sent to users when they opt in to receive messages. |
| help_message_sample? | string | A sample help message provided to users. |
| privacy_policy_url? | string | The URL to the privacy policy for the business or organization. |
| terms_and_conditions_url? | string | The URL to the terms and conditions for the business or organization. |
| age_gated_content? | boolean | Indicates if the content is age gated. |
| opt_in_keywords? | array | List of keywords that users can text in to opt in to receive messages. |
| vetting_provider? | enum | The third-party political vetting provider. |
| vetting_id? | string | The unique ID of the vetting |
| tollfree_phone_number_sid | string | The SID of the Phone Number associated with the Tollfree Verification. |
| customer_profile_sid? | string | Customer's Profile Bundle BundleSid. |
| external_reference_id? | string | An optional external reference ID supplied by customer and echoed back on status retrieval. |
| 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 tollfree verification
fn get(id: string)
Get a tollfree verification
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the tollfree verification |
fn lookup(tollfree_phone_number_sid?: string, status?: enum, external_reference_id?: string, include_sub_accounts?: boolean, trust_product_sid?: string, max_items?: number)
List tollfree verifications and record each as a data artifact (capped at 200 by default; writes a tollfree_verification_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| tollfree_phone_number_sid? | string | The SID of the Phone Number associated with the Tollfree Verification. |
| status? | enum | The compliance status of the Tollfree Verification record. |
| external_reference_id? | string | Customer supplied reference id for the Tollfree Verification record. |
| include_sub_accounts? | boolean | Whether to include Tollfree Verifications from sub accounts in list response. |
| trust_product_sid? | string | The trust product sids / tollfree bundle sids of tollfree verifications |
| 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 tollfree_verification_lookup record reports truncated: true. |
fn update()
Update tollfree verification attributes
fn delete(id: string)
Delete the tollfree verification
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the tollfree verification |
fn sync()
Sync tollfree verification state from Twilio
Resources
state— Tollfree verification resource state
typing_indicator.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) |
| channel | enum | Shared channel identifier |
| message_id | string | Message SID that identifies the conversation thread for the typing indicator. Must be a valid Twilio Message SID (SM*) or Media SID (MM*) from an existing WhatsApp conversation. |
| 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 typing indicator
us_app_to_person.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. |
| messaging_service_sid | string | Path scope for the us app to person: messaging_service_sid |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| has_embedded_links | boolean | Indicates that this SMS campaign will send messages that contain links. |
| has_embedded_phone | boolean | Indicates that this SMS campaign will send messages that contain phone numbers. |
| message_samples | array | An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars. |
| message_flow | string | Required for all Campaigns. Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum. |
| description | string | A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters. |
| age_gated? | boolean | A boolean that specifies whether campaign is age gated or not. |
| direct_lending? | boolean | A boolean that specifies whether campaign allows direct lending or not. |
| privacy_policy_url? | string | The URL of the privacy policy for the campaign. |
| terms_and_conditions_url? | string | The URL of the terms and conditions for the campaign. |
| brand_registration_sid | string | A2P Brand Registration SID |
| us_app_to_person_usecase | string | A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..] |
| opt_in_message? | string | If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear descript |
| opt_out_message? | string | Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include t |
| help_message? | string | When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default |
| opt_in_keywords? | array | If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum. |
| opt_out_keywords? | array | End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximu |
| help_keywords? | array | End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 char |
| subscriber_opt_in? | boolean | A boolean that specifies whether campaign has Subscriber Optin or not. |
| 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 us app to person
fn get(id: string)
Get a us app to person
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the us app to person |
fn lookup(max_items?: number)
List us app to persons and record each as a data artifact (capped at 200 by default; writes a us_app_to_person_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 us_app_to_person_lookup record reports truncated: true. |
fn update()
Update us app to person attributes
fn delete(id: string)
Delete the us app to person
| Argument | Type | Description |
|---|---|---|
| id | string | The sid of the us app to person |
fn sync()
Sync us app to person state from Twilio
Resources
state— Us app to person resource state
us_app_to_person_usecase.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. |
| messaging_service_sid | string | Path scope for the us app to person usecase: messaging_service_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(brand_registration_sid?: string, max_items?: number)
List us app to person usecases and record each as a data artifact (capped at 200 by default; writes a us_app_to_person_usecase_lookup record with the coverage of the walk)
| Argument | Type | Description |
|---|---|---|
| brand_registration_sid? | string | The unique string to identify the A2P brand. |
| 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 us_app_to_person_usecase_lookup record reports truncated: true. |
Resources
state— Us app to person usecase resource state
usecase.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(max_items?: number)
List usecases and record each as a data artifact (capped at 200 by default; writes a usecase_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 usecase_lookup record reports truncated: true. |
Resources
state— Usecase resource state
04Stats
B
85 / 100
Downloads
0
Archive size
97.8 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