twilio

Documentation

Index

• Constants
• Variables
• type Carrier
  • func (car *Carrier) Canonical() gophonenumbers.CarrierNumberInfo
• type Client
  • func NewClient(accountSid, authToken string) (*Client, error)
  • func (c *Client) Validate(number string, opts *Params) (NumberInfo, error)
• type MultiResults
  • func GetWriteValidationMulti(client *Client, requestNumbers, skipNumbers []string, filenameBase string, ...) MultiResults
  • func NewMultiResults() MultiResults
  • func NewMultiResultsFiles(dir string, rxPattern string) (MultiResults, error)
  • func (mr *MultiResults) AddResponses(resps map[string]*NumberInfo)
  • func (mr *MultiResults) Canonical() (gophonenumbers.NumberSet, error)
  • func (mr *MultiResults) GetNumberInfo(e164Number string) (*NumberInfo, error)
  • func (mr *MultiResults) Inflate()
  • func (mr *MultiResults) NumbersSuccess() []string
  • func (mr *MultiResults) Write(filename string) error
• type NumberInfo
  • func (num *NumberInfo) Canonical() (gophonenumbers.Number, error)
• type Params
  • func (p *Params) Encode() string

Constants

const (
	LookupEndpoint = "https://lookups.twilio.com/v1/PhoneNumbers/"
)

Variables

var (
	EnvTwilioAccountSid = "TWILIO_ACCOUNT_SID"
	EnvTwilioAuthToken  = "TWILIO_AUTH_TOKEN" // #nosec G101
)

var MultiLimit = 0 // test limit to gracefully exit process early.

Types

type Carrier

type Carrier struct {
	MobileCountryCode string `json:"mobile_country_code,omitempty"`
	MobileNetworkCode string `json:"mobile_network_code,omitempty"`
	Name              string `json:"name,omitempty"`
	Type              string `json:"type,omitempty"`
	ErrorCode         string `json:"error_code,omitempty"`
}

func (*Carrier) Canonical

func (car *Carrier) Canonical() gophonenumbers.CarrierNumberInfo

type Client

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

func NewClient

func NewClient(accountSid, authToken string) (*Client, error)

func (*Client) Validate

func (c *Client) Validate(number string, opts *Params) (NumberInfo, error)

type MultiResults

type MultiResults struct {
	CountsByStatusCode map[string]int
	Responses          map[string]*NumberInfo
}

MultiResults is designed to handle large volumes of requests.

func GetWriteValidationMulti

func GetWriteValidationMulti(client *Client, requestNumbers, skipNumbers []string, filenameBase string, logAt, fileAt uint) MultiResults

func NewMultiResults

func NewMultiResults() MultiResults

func NewMultiResultsFiles

func NewMultiResultsFiles(dir string, rxPattern string) (MultiResults, error)

func (*MultiResults) AddResponses

func (mr *MultiResults) AddResponses(resps map[string]*NumberInfo)

func (*MultiResults) Canonical

func (mr *MultiResults) Canonical() (gophonenumbers.NumberSet, error)

func (*MultiResults) GetNumberInfo

func (mr *MultiResults) GetNumberInfo(e164Number string) (*NumberInfo, error)

func (*MultiResults) Inflate

func (mr *MultiResults) Inflate()

func (*MultiResults) NumbersSuccess

func (mr *MultiResults) NumbersSuccess() []string

func (*MultiResults) Write

func (mr *MultiResults) Write(filename string) error

type NumberInfo

type NumberInfo struct {
	CallerName      map[string]string         `json:"caller_name,omitempty"`
	CountryCode     string                    `json:"country_code,omitempty"`
	PhoneNumber     string                    `json:"phone_number,omitempty"`
	NationalFormat  string                    `json:"national_format,omitempty"`
	URL             string                    `json:"url,omitempty"`
	Carrier         Carrier                   `json:"carrier,omitempty"`
	APIResponseInfo httputilmore.ResponseInfo `json:"api_response_info,omitempty"`
}

func (*NumberInfo) Canonical

func (num *NumberInfo) Canonical() (gophonenumbers.Number, error)

type Params

type Params struct {
	CountryCode string
	Type        string
}

Params represents optional parameters. Use "Type=carrier" for carrier info and "Type=caller-name" for caller name.

func (*Params) Encode

func (p *Params) Encode() string