twilio

README

Twilio Go SDK

This SDK is designed to allow you to interact with Twilio API's using Golang.

⚠️ Disclaimer: This project is not an official Twilio project and is not supported or endorsed by Twilio in any way. It is maintained in my free time.

Getting Started

• Developing the SDK

NOTE: The default branch for this project is called main

Documentation

The code uses go doc style documentation with links to the relevant Twilio API documentation/ guides where appropriate.

Examples

Example code snippets for all of the supported services & resources can be found here

Initialising the Twilio Client

There are many ways to initialise and configure the Twilio Client. See below for examples:

With Credentials

creds, err := credentials.New(credentials.Account{
    Sid:       os.Getenv("TWILIO_ACCOUNT_SID"),
    AuthToken: os.Getenv("TWILIO_AUTH_TOKEN"),
})
if err != nil {
    log.Panicf("%s", err.Error())
}

twilioClient := twilio.NewWithCredentials(creds)

With Session

creds, err := credentials.New(credentials.Account{
    Sid:       os.Getenv("TWILIO_ACCOUNT_SID"),
    AuthToken: os.Getenv("TWILIO_AUTH_TOKEN"),
})
if err != nil {
    log.Panicf("%s", err.Error())
}

twilioClient := twilio.New(session.New(creds))

With Session & Config

The Twilio Client allows the user to supply configuration to alter the default behaviour of the SDK.

The SDK supports the following configuration:

• BackoffInterval - The time taken in milliseconds between retries
• DebugEnabled - This logs out the request and response details for each call to the Twilio API
• Edge - Specify a public edge or private interconnect to connect to Twilio via. See Global Infrastructure - Edge Locations for more information
• Region - Specify a public region or private interconnect region to connect to Twilio via. See Global Infrastructure - Legacy Regions for more information
• RetryAttempts - The number of retry attempts before an error is returned

Enabling debug mode

creds, err := credentials.New(credentials.Account{
    Sid:       os.Getenv("TWILIO_ACCOUNT_SID"),
    AuthToken: os.Getenv("TWILIO_AUTH_TOKEN"),
})
if err != nil {
    log.Panicf("%s", err.Error())
}

twilioClient := twilio.New(session.New(creds), &client.Config{
   DebugEnabled: true,
})

Specifying Edge & Region configuration

creds, err := credentials.New(credentials.Account{
    Sid:       os.Getenv("TWILIO_ACCOUNT_SID"),
    AuthToken: os.Getenv("TWILIO_AUTH_TOKEN"),
})
if err != nil {
    log.Panicf("%s", err.Error())
}

twilioClient := twilio.New(session.New(creds), &client.Config{
    Edge:       utils.String("dublin"),
    Region:     utils.String("ie1"),
})

Used By

• Twilio Terraform Provider

With Thanks

This project is very heavily inspired and influenced by other open-source projects including:

• Twilio Node SDK
• AWS Go V2 SDK
• Kevin Burke's Twilio Go SDK

Documentation

Index

• type Twilio
  • func New(sess *session.Session) *Twilio
  • func NewWithConfig(sess *session.Session, config *client.Config) *Twilio
  • func NewWithCredentials(creds *credentials.Credentials) *Twilio

Types

type Twilio

type Twilio struct {
	API           *api.API
	Autopilot     *autopilot.Autopilot
	Chat          *chat.Chat
	Conversations *conversations.Conversations
	Fax           *fax.Fax
	Flex          *flex.Flex
	Lookups       *lookups.Lookups
	Messaging     *messaging.Messaging
	Monitor       *monitor.Monitor
	Notify        *notify.Notify
	Proxy         *proxy.Proxy
	Serverless    *serverless.Serverless
	Studio        *studio.Studio
	Sync          *sync.Sync
	TaskRouter    *taskrouter.TaskRouter
	Trunking      *trunking.Trunking
	TwiML         *twiml.TwiML
	Verify        *verify.Verify
}

Twilio clients manage all the available Twilio services & resources within the SDK

func New

func New(sess *session.Session) *Twilio

New create a new instance of the client using session data

func NewWithConfig

func NewWithConfig(sess *session.Session, config *client.Config) *Twilio

NewWithConfig create a new instance of the client using session data and config

func NewWithCredentials

func NewWithCredentials(creds *credentials.Credentials) *Twilio

NewWithCredentials creates a new instance of the client with credentials