twilio

README

twilio

twilio implements the Twilio Programmable Voice API.

Documentation

Index

• type APIError
  • func (a *APIError) Error() string
• type Call
• type CallResource
• type Client
  • func New(client *http.Client, accountSid, authToken string) *Client
  • func (c *Client) Call(ctx context.Context, call *Call) (*CallResource, error)
  • func (c *Client) CallResource(ctx context.Context, callSid string) (*CallResource, error)
  • func (c *Client) ConferenceResource(ctx context.Context, conferenceSid string) (*ConferenceResource, error)
  • func (c *Client) DisconnectCall(ctx context.Context, callSid string) error
  • func (c *Client) ParticipantResources(ctx context.Context, conferenceSid string) ([]*ParticipantResource, error)
  • func (c *Client) SetMute(ctx context.Context, conferenceSid, callSid string, muted bool) error
• type ConferenceResource
• type ParticipantResource
• type SubresourceUris
• type TwilioTime
  • func (tt *TwilioTime) MarshalJSON() ([]byte, error)
  • func (tt *TwilioTime) UnmarshalJSON(b []byte) (err error)

Types

type APIError

type APIError struct {
	Code     int    `json:"code"`
	Message  string `json:"message"`
	MoreInfo string `json:"more_info"`
	Status   int    `json:"status"`
}

APIError holds the details of errors returned from twilio

func (*APIError) Error

func (a *APIError) Error() string

Error returns string representation of the error

type Call

type Call struct {
	AccountSid                         string `url:"AccountSid,omitempty"`
	ApplicationSid                     string `url:"ApplicationSid,omitempty"`
	AsyncAmd                           string `url:"AsyncAmd,omitempty"`
	AsyncAmdStatusCallback             string `url:"AsyncAmdStatusCallback,omitempty"`
	AsyncAmdStatusCallbackMethod       string `url:"AsyncAmdStatusCallbackMethod,omitempty"`
	Byoc                               string `url:"Byoc,omitempty"`
	CallerId                           string `url:"CallerId,omitempty"`
	CallReason                         string `url:"CallReason,omitempty"`
	FallbackMethod                     string `url:"FallbackMethod,omitempty"`
	FallbackUrl                        string `url:"FallbackUrl,omitempty"`
	From                               string `url:"From,omitempty"`
	MachineDetection                   string `url:"MachineDetection,omitempty"`
	MachineDetectionSilenceTimeout     int    `url:"MachineDetectionSilenceTimeout,omitempty"`
	MachineDetectionSpeechEndThreshold int    `url:"MachineDetectionSpeechEndThreshold,omitempty"`
	MachineDetectionSpeechThreshold    int    `url:"MachineDetectionSpeechThreshold,omitempty"`
	MachineDetectionTimeout            int    `url:"MachineDetectionTimeout,omitempty"`
	Method                             string `url:"Method,omitempty"`
	Record                             bool   `url:"Record,omitempty"`
	RecordingChannels                  string `url:"RecordingChannels,omitempty"`
	RecordingStatusCallback            string `url:"RecordingStatusCallback,omitempty"`
	RecordingStatusCallbackEvent       string `url:"RecordingStatusCallbackEvent,omitempty"`
	RecordingStatusCallbackMethod      string `url:"RecordingStatusCallbackMethod,omitempty"`
	SendDigits                         string `url:"SendDigits,omitempty"`
	SipAuthPassword                    string `url:"SipAuthPassword,omitempty"`
	SipAuthUsername                    string `url:"SipAuthUsername,omitempty"`
	StatusCallback                     string `url:"StatusCallback,omitempty"`
	StatusCallbackEvent                string `url:"StatusCallbackEvent,omitempty"`
	StatusCallbackMethod               string `url:"StatusCallbackMethod,omitempty"`
	Timeout                            int    `url:"Timeout,omitempty"`
	To                                 string `url:"To,omitempty"`
	Trim                               string `url:"Trim,omitempty"`
	Twiml                              string `url:"Twiml,omitempty"`
	URL                                string `url:"Url,omitempty"`
}

Call describes outgoing call settings

type CallResource

type CallResource struct {
	Sid             string          `json:"sid,omitempty"`
	AccountSid      string          `json:"account_sid,omitempty"`
	Annotation      string          `json:"annotation,omitempty"`
	AnsweredBy      string          `json:"answered_by,omitempty"`
	APIVersion      string          `json:"api_version,omitempty"`
	CallerName      string          `json:"caller_name,omitempty"`
	DateCreated     TwilioTime      `json:"date_created,omitempty"`
	DateUpdated     TwilioTime      `json:"date_updated,omitempty"`
	Direction       string          `json:"direction,omitempty"`
	Duration        string          `json:"duration,omitempty"`
	EndTime         string          `json:"end_time,omitempty"`
	ForwardedFrom   string          `json:"forwarded_from,omitempty"`
	From            string          `json:"from,omitempty"`
	FromFormatted   string          `json:"from_formatted,omitempty"`
	GroupSid        string          `json:"group_sid,omitempty"`
	ParentCallSid   string          `json:"parent_call_sid,omitempty"`
	PhoneNumberSid  string          `json:"phone_number_sid,omitempty"`
	Price           string          `json:"price,omitempty"`
	PriceUnit       string          `json:"price_unit,omitempty"`
	QueueTime       string          `json:"queue_time,omitempty"`
	StartTime       string          `json:"start_time,omitempty"`
	Status          string          `json:"status,omitempty"`
	SubresourceUris SubresourceUris `json:"subresource_uris,omitempty"`
	To              string          `json:"to,omitempty"`
	ToFormatted     string          `json:"to_formatted,omitempty"`
	TrunkSid        string          `json:"trunk_sid,omitempty"`
	URI             string          `json:"uri,omitempty"`
}

CallResource holds the details of a call resouce

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an http client that talks to Twilio's Rest API

func New

func New(client *http.Client, accountSid, authToken string) *Client

New returns a new Twillio Client

func (*Client) Call

func (c *Client) Call(ctx context.Context, call *Call) (*CallResource, error)

Call creates an outbound call returning the resulting CallResource

func (*Client) CallResource

func (c *Client) CallResource(ctx context.Context, callSid string) (*CallResource, error)

CallResource retrieves call details

func (*Client) ConferenceResource

func (c *Client) ConferenceResource(ctx context.Context, conferenceSid string) (*ConferenceResource, error)

ConferenceResource retrieves conference details

func (*Client) DisconnectCall

func (c *Client) DisconnectCall(ctx context.Context, callSid string) error

DisconnectCall will disconnect the Call associated with callSids

func (*Client) ParticipantResources

func (c *Client) ParticipantResources(ctx context.Context, conferenceSid string) ([]*ParticipantResource, error)

ParticipantResource retrieves participant details

func (*Client) SetMute

func (c *Client) SetMute(ctx context.Context, conferenceSid, callSid string, muted bool) error

SetMute will set the mute state for the Call associated with callSids

type ConferenceResource

type ConferenceResource struct {
	AccountSid              string            `json:"account_sid,omitempty"`
	DateCreated             TwilioTime        `json:"date_created,omitempty"`
	DateUpdated             TwilioTime        `json:"date_updated,omitempty"`
	ApiVersion              string            `json:"api_version,omitempty"`
	FriendlyName            string            `json:"friendly_name,omitempty"`
	Region                  string            `json:"region,omitempty"`
	Sid                     string            `json:"sid,omitempty"`
	Status                  string            `json:"status,omitempty"` // init, in-progress, or completed.
	Uri                     string            `json:"uri,omitempty"`
	SubresourceUris         map[string]string `json:"subresource_uris,omitempty"`
	ReasonConferenceEnded   string            `json:"reason_conference_ended,omitempty"` // conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left.
	CallSidEndingConference string            `json:"call_sid_ending_conference,omitempty"`
}

ConferenceResource holds the details of a conference

type ParticipantResource

type ParticipantResource struct {
	AccountSid             string     `json:"account_sid,omitempty"`
	CallSid                string     `json:"call_sid,omitempty"`
	CallSidToCoach         string     `json:"call_sid_to_coach,omitempty"`
	Coaching               bool       `json:"coaching,omitempty"`
	ConferenceSid          string     `json:"conference_sid,omitempty"`
	DateCreated            TwilioTime `json:"date_created,omitempty"`
	DateUpdated            TwilioTime `json:"date_updated,omitempty"`
	EndConferenceOnExit    bool       `json:"end_conference_on_exit,omitempty"`
	Muted                  bool       `json:"muted,omitempty"`
	Hold                   bool       `json:"hold,omitempty"`
	StartConferenceOnEnter bool       `json:"start_conference_on_enter,omitempty"`
	Status                 string     `json:"status,omitempty"` // queued, connecting, ringing, connected, complete, or failed
	Uri                    string     `json:"uri,omitempty"`
}

ParticipantResource holds the details of a participant

type SubresourceUris

type SubresourceUris struct {
	Notifications     string `json:"notifications,omitempty"`
	Recordings        string `json:"recordings,omitempty"`
	Feedback          string `json:"feedback,omitempty"`
	FeedbackSummaries string `json:"feedback_summaries,omitempty"`
	Payments          string `json:"payments,omitempty"`
}

SubresourceUris holds details for subresource uri's

type TwilioTime

type TwilioTime struct {
	time.Time
}

TwilioTime implements interfaces for json Marshalling and Unmarshalling

func (*TwilioTime) MarshalJSON

func (tt *TwilioTime) MarshalJSON() ([]byte, error)

MarshslJSON implements the Marshaler interface

func (*TwilioTime) UnmarshalJSON

func (tt *TwilioTime) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON implements the Unmarshaler interface