Back to Eliza

Twilio Plugin

packages/docs/plugin-registry/platform/twilio.md

2.0.13.4 KB
Original Source

The Twilio plugin connects Eliza agents to Twilio, enabling SMS messaging and voice interactions through Twilio phone numbers.

Package: @elizaos/plugin-twilio

Note: Twilio is categorized as a feature plugin in the registry, not a connector. It provides SMS and voice call capabilities via the Twilio API.

Installation

bash
eliza plugins install @elizaos/plugin-twilio

Setup

1. Get Your Twilio Credentials

  1. Sign up at twilio.com
  2. From the Twilio Console dashboard, copy your Account SID and Auth Token
  3. Purchase or configure a Twilio phone number

2. Configure Eliza

json
{
  "connectors": {
    "twilio": {
      "accountSid": "YOUR_ACCOUNT_SID",
      "authToken": "YOUR_AUTH_TOKEN",
      "phoneNumber": "YOUR_PHONE_NUMBER"
    }
  }
}

Or via environment variables:

bash
export TWILIO_ACCOUNT_SID=YOUR_ACCOUNT_SID
export TWILIO_AUTH_TOKEN=YOUR_AUTH_TOKEN
export TWILIO_PHONE_NUMBER=YOUR_PHONE_NUMBER

Configuration

FieldRequiredDescription
accountSidYesTwilio Account SID
authTokenYesTwilio Auth Token
phoneNumberNoTwilio phone number (E.164 format)
enabledNoSet false to disable (default: true)
webhookUrlNoWebhook URL for inbound messages
webhookPortNoPort for webhook listener

Voice Call Configuration

FieldRequiredDescription
voiceCallEnabledNoEnable voice call capabilities
voiceCallProviderNoVoice call provider selection
voiceCallFromNumberNoPhone number for outbound calls
voiceCallToNumberNoDefault destination phone number
voiceCallAllowFromNoComma-separated list of allowed caller numbers
voiceCallPublicUrlNoPublic URL for voice call webhooks
voiceCallInboundPolicyNoInbound call handling policy
voiceCallInboundGreetingNoGreeting message for inbound callers
voiceCallMaxConcurrentCallsNoMaximum number of concurrent calls
voiceCallMaxDurationSecondsNoMaximum call duration in seconds

Environment Variables

VariableRequiredDescription
TWILIO_ACCOUNT_SIDYesTwilio Account SID
TWILIO_AUTH_TOKENYesTwilio Auth Token (primary auto-enable trigger)
TWILIO_PHONE_NUMBERNoTwilio phone number
TWILIO_WEBHOOK_URLNoWebhook callback URL
TWILIO_WEBHOOK_PORTNoWebhook listener port
VOICE_CALL_ENABLEDNoEnable voice call functionality
VOICE_CALL_PROVIDERNoVoice call provider
VOICE_CALL_TO_NUMBERNoDefault outbound call number
VOICE_CALL_FROM_NUMBERNoOutbound caller ID number
VOICE_CALL_ALLOW_FROMNoAllowed inbound caller numbers
VOICE_CALL_PUBLIC_URLNoPublic URL for voice webhooks
VOICE_CALL_WEBHOOK_PATHNoVoice webhook endpoint path
VOICE_CALL_WEBHOOK_PORTNoVoice webhook listener port
VOICE_CALL_INBOUND_POLICYNoInbound call acceptance policy
VOICE_CALL_INBOUND_GREETINGNoGreeting message for inbound calls
VOICE_CALL_MAX_CONCURRENT_CALLSNoMaximum concurrent calls
VOICE_CALL_MAX_DURATION_SECONDSNoMaximum call duration in seconds