numbers_pkg

Documentation

Index

• type NUMBERS
• type NUMBERS_IMPL
  • func NewNUMBERS(config configuration_pkg.CONFIGURATION) *NUMBERS_IMPL
  • func (me *NUMBERS_IMPL) EditNumberOptions(number string, format string, forwardEmail *string, forwardSms *string, ...) (interface{}, error)
  • func (me *NUMBERS_IMPL) GetNumber(number string, format string) (interface{}, error)
  • func (me *NUMBERS_IMPL) GetNumbers(filter string, format string, page *string, max *string) (interface{}, error)
  • func (me *NUMBERS_IMPL) LeaseNumber(number string, format string) (interface{}, error)

Types

type NUMBERS

type NUMBERS interface {
	LeaseNumber(string, string) (interface{}, error)

	EditNumberOptions(string, string, *string, *string, *string, *string, *string, *string) (interface{}, error)

	GetNumbers(string, string, *string, *string) (interface{}, error)

	GetNumber(string, string) (interface{}, error)
}

* Interface for the NUMBERS_IMPL

type NUMBERS_IMPL

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

* Client structure as interface implementation

func NewNUMBERS

func NewNUMBERS(config configuration_pkg.CONFIGURATION) *NUMBERS_IMPL

* Factory for the NUMBERS interaface returning NUMBERS_IMPL

func (*NUMBERS_IMPL) EditNumberOptions

func (me *NUMBERS_IMPL) EditNumberOptions(
	number string,
	format string,
	forwardEmail *string,
	forwardSms *string,
	forwardUrl *string,
	listId *string,
	welcomeMessage *string,
	membersMessage *string) (interface{}, error)

*

• Edit your dedicated virtual number options.
• @param string number parameter: Required
• @param string format parameter: Required
• @param *string forwardEmail parameter: Optional
• @param *string forwardSms parameter: Optional
• @param *string forwardUrl parameter: Optional
• @param *string listId parameter: Optional
• @param *string welcomeMessage parameter: Optional
• @param *string membersMessage parameter: Optional
• @return Returns the interface{} response from the API call

func (*NUMBERS_IMPL) GetNumber

func (me *NUMBERS_IMPL) GetNumber(
	number string,
	format string) (interface{}, error)

*

• Get detailed information about a response number you have leased.
• @param string number parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*NUMBERS_IMPL) GetNumbers

func (me *NUMBERS_IMPL) GetNumbers(
	filter string,
	format string,
	page *string,
	max *string) (interface{}, error)

*

• Get a list of numbers either leased by you or available to be leased.
• @param string filter parameter: Required
• @param string format parameter: Required
• @param *string page parameter: Optional
• @param *string max parameter: Optional
• @return Returns the interface{} response from the API call

func (*NUMBERS_IMPL) LeaseNumber

func (me *NUMBERS_IMPL) LeaseNumber(
	number string,
	format string) (interface{}, error)

*

• Lease a dedicated virtual number.
• @param string number parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call