Twilio/proxy

@keeb/twilio/proxyv2026.08.25.2· 16d agoMODELS

01README

Twilio proxy API models

02Release Notes

Updated: interaction, message_interaction, participant, phone_number, service, session

03Models6

@keeb/twilio/proxy/interactionv2026.08.25.2interaction.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the interaction: service_sid
session_sid	string	yes	Path scope for the interaction: session_sid
name?	string	no	Instance name for this resource (used as the unique identifier in the factory pattern)
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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 interaction

Argument	Type	Required	Description
id	string	yes	The sid of the interaction

fn lookup(max_items?: number)

List interactions and record each as a data artifact (capped at 200 by default; writes a interaction_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	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 interaction_lookup record reports truncated: true.

fn delete(id: string)

Delete the interaction

Argument	Type	Required	Description
id	string	yes	The sid of the interaction

fn sync()

Sync interaction state from Twilio

Resources

state(infinite)— Interaction resource state

interaction_lookup(infinite)— Interaction lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/proxy/message-interactionv2026.08.25.2message_interaction.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the message interaction: service_sid
session_sid	string	yes	Path scope for the message interaction: session_sid
participant_sid	string	yes	Path scope for the message interaction: participant_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
body?	string	no	The message to send to the participant
media_url?	array	no	Reserved. Not currently supported.
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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 interaction

fn get(id: string)

Get a message interaction

Argument	Type	Required	Description
id	string	yes	The sid of the message interaction

fn lookup(max_items?: number)

List message interactions and record each as a data artifact (capped at 200 by default; writes a message_interaction_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	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_interaction_lookup record reports truncated: true.

fn sync()

Sync message interaction state from Twilio

Resources

state(infinite)— Message interaction resource state

message_interaction_lookup(infinite)— Message interaction lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/proxy/participantv2026.08.25.2participant.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the participant: service_sid
session_sid	string	yes	Path scope for the participant: session_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
identifier	string	yes	The phone number of the Participant.
friendly_name?	string	no	The string that you assigned to describe the participant. This value must be 255 characters or fewer. This value should not have PII.
proxy_identifier?	string	no	The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.
proxy_identifier_sid?	string	no	The SID of the Proxy Identifier to assign to the Participant.
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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	Required	Description
id	string	yes	The sid of the participant

fn lookup(max_items?: number)

List participants and record each as a data artifact (capped at 200 by default; writes a participant_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	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 delete(id: string)

Delete the participant

Argument	Type	Required	Description
id	string	yes	The sid of the participant

fn sync()

Sync participant state from Twilio

Resources

state(infinite)— Participant resource state

participant_lookup(infinite)— Participant lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/proxy/phone-numberv2026.08.25.2phone_number.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the phone number: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
is_reserved?	boolean	no	Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
sid?	string	no	The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.
phone_number?	string	no	The phone number 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.
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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	Required	Description
id	string	yes	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	Required	Description
max_items?	number	no	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 update()

Update phone number attributes

fn delete(id: string)

Delete the phone number

Argument	Type	Required	Description
id	string	yes	The sid of the phone number

fn sync()

Sync phone number state from Twilio

Resources

state(infinite)— Phone number resource state

phone_number_lookup(infinite)— Phone number lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/proxy/servicev2026.08.25.2service.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
unique_name	string	yes	An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII.
default_ttl?	number	no	The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` v
callback_url?	string	no	The URL we should call when the interaction status changes.
geo_match_level?	enum	no	Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.
number_selection_behavior?	enum	no	The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will n
intercept_callback_url?	string	no	The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.
out_of_session_callback_url?	string	no	The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/en-us/serverless/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is
chat_instance_sid?	string	no	The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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	Required	Description
id	string	yes	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	Required	Description
max_items?	number	no	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	Required	Description
id	string	yes	The sid of the service

fn sync()

Sync service state from Twilio

Resources

state(infinite)— Service resource state

service_lookup(infinite)— Service lookup coverage — whether the page walk exhausted the collection

@keeb/twilio/proxy/sessionv2026.08.25.2session.ts

Global Arguments

Argument	Type	Required	Description
account_sid?	string	no	Twilio Account SID (starts with AC). Also substituted for {AccountSid} path parameters. Overrides the TWILIO_ACCOUNT_SID environment variable.
service_sid	string	yes	Path scope for the session: service_sid
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
date_expiry?	string	no	The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.
ttl?	number	no	The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.
status?	enum	no	The status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`.
unique_name?	string	no	An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. This value should not have PII.
mode?	enum	no	The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message`.
participants?	array	no	The Participant objects to include in the new session.
auth_token?	string	no	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	no	Twilio API key SID (starts with SK). Takes precedence over auth_token. Overrides TWILIO_API_KEY_SID.
api_key_secret?	string	no	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 session

fn get(id: string)

Get a session

Argument	Type	Required	Description
id	string	yes	The sid of the session

fn lookup(max_items?: number)

List sessions and record each as a data artifact (capped at 200 by default; writes a session_lookup record with the coverage of the walk)

Argument	Type	Required	Description
max_items?	number	no	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 session_lookup record reports truncated: true.

fn update()

Update session attributes

fn delete(id: string)

Delete the session

Argument	Type	Required	Description
id	string	yes	The sid of the session

fn sync()

Sync session state from Twilio

Resources

state(infinite)— Session resource state

session_lookup(infinite)— Session lookup coverage — whether the page walk exhausted the collection

04Stats

85 / 100

Downloads

Archive size

37.5 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

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#twilio #proxy #communications #saas