sms_pkg

Documentation

Index

• type SMS
• type SMS_IMPL
  • func NewSMS(config configuration_pkg.CONFIGURATION) *SMS_IMPL
  • func (me *SMS_IMPL) CancelSMS(id string, format string) (interface{}, error)
  • func (me *SMS_IMPL) FormatNumber(msisdn string, countrycode string, format string) (interface{}, error)
  • func (me *SMS_IMPL) GetLinkHits(messageId string, format string) (interface{}, error)
  • func (me *SMS_IMPL) GetSMS(messageId string, format string) (interface{}, error)
  • func (me *SMS_IMPL) GetSMSDeliveryStatus(messageId string, msisdn string, format string) (interface{}, error)
  • func (me *SMS_IMPL) GetSMSResponses(format string, messageId *string, keywordId *string, keyword *string, ...) (interface{}, error)
  • func (me *SMS_IMPL) GetSMSSent(messageId string, format string, optouts *string, page *string, max *string, ...) (interface{}, error)
  • func (me *SMS_IMPL) GetSMSStats(messageId string, format string) (interface{}, error)
  • func (me *SMS_IMPL) GetUserSMSResponses(format string, start *string, end *string, page *string, max *string, ...) (interface{}, error)
  • func (me *SMS_IMPL) SendSMS(message string, format string, to *int64, from *string, sendAt *string, ...) (interface{}, error)

Types

type SMS

type SMS interface {
	SendSMS(string, string, *int64, *string, *string, *int64, *string, *string, *string, *string, *bool, *string, *string) (interface{}, error)

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

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

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

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

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

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

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

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

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

* Interface for the SMS_IMPL

type SMS_IMPL

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

* Client structure as interface implementation

func NewSMS

func NewSMS(config configuration_pkg.CONFIGURATION) *SMS_IMPL

* Factory for the SMS interaface returning SMS_IMPL

func (*SMS_IMPL) CancelSMS

func (me *SMS_IMPL) CancelSMS(
	id string,
	format string) (interface{}, error)

*

• Cancel a message you have scheduled to be sent in the future.
• @param string id parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) FormatNumber

func (me *SMS_IMPL) FormatNumber(
	msisdn string,
	countrycode string,
	format string) (interface{}, error)

*

• Format and validate a given number.
• @param string msisdn parameter: Required
• @param string countrycode parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetLinkHits

func (me *SMS_IMPL) GetLinkHits(
	messageId string,
	format string) (interface{}, error)

*

• Get the list of recipients who have clicked on your tracked link.
• @param string messageId parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetSMS

func (me *SMS_IMPL) GetSMS(
	messageId string,
	format string) (interface{}, error)

*

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

func (*SMS_IMPL) GetSMSDeliveryStatus

func (me *SMS_IMPL) GetSMSDeliveryStatus(
	messageId string,
	msisdn string,
	format string) (interface{}, error)

*

• Get the delivery time of a delivered message.
• @param string messageId parameter: Required
• @param string msisdn parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetSMSResponses

func (me *SMS_IMPL) GetSMSResponses(
	format string,
	messageId *string,
	keywordId *string,
	keyword *string,
	number *string,
	msisdn *string,
	page *string,
	max *string,
	includeOriginal *string) (interface{}, error)

*

• Pick up responses to messages you have sent. Filter by keyword or for just one phone number.
• @param string format parameter: Required
• @param *string messageId parameter: Optional
• @param *string keywordId parameter: Optional
• @param *string keyword parameter: Optional
• @param *string number parameter: Optional
• @param *string msisdn parameter: Optional
• @param *string page parameter: Optional
• @param *string max parameter: Optional
• @param *string includeOriginal parameter: Optional
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetSMSSent

func (me *SMS_IMPL) GetSMSSent(
	messageId string,
	format string,
	optouts *string,
	page *string,
	max *string,
	delivery *string) (interface{}, error)

*

• Get a list of recipients from a message send. Get up to date information such as opt-out status and delivery status.
• @param string messageId parameter: Required
• @param string format parameter: Required
• @param *string optouts parameter: Optional
• @param *string page parameter: Optional
• @param *string max parameter: Optional
• @param *string delivery parameter: Optional
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetSMSStats

func (me *SMS_IMPL) GetSMSStats(
	messageId string,
	format string) (interface{}, error)

*

• Get the status about a message you have sent.
• @param string messageId parameter: Required
• @param string format parameter: Required
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) GetUserSMSResponses

func (me *SMS_IMPL) GetUserSMSResponses(
	format string,
	start *string,
	end *string,
	page *string,
	max *string,
	keywords *string,
	includeOriginal *string) (interface{}, error)

*

• Pick up responses to messages you have sent. Instead of setting message ID, you should provide a time frame.
• @param string format parameter: Required
• @param *string start parameter: Optional
• @param *string end parameter: Optional
• @param *string page parameter: Optional
• @param *string max parameter: Optional
• @param *string keywords parameter: Optional
• @param *string includeOriginal parameter: Optional
• @return Returns the interface{} response from the API call

func (*SMS_IMPL) SendSMS

func (me *SMS_IMPL) SendSMS(
	message string,
	format string,
	to *int64,
	from *string,
	sendAt *string,
	listId *int64,
	dlrCallback *string,
	replyCallback *string,
	validity *string,
	repliesToEmail *string,
	fromShared *bool,
	countrycode *string,
	trackedLinkUrl *string) (interface{}, error)

*

• The Send-SMS call is the primary method of sending SMS.
• You can elect to pass us the recipient numbers from your database each time you make a call, or you can elect to store recipient data in a contact list and submit only the list_id to trigger the send. This is best for large databases. To add a list please refer to the add-list call.
• Cost data is returned in the major unit of your account currency, e.g. dollars or pounds
• NOTE: If you do not pass the 'from' parameter the messages will be sent from the shared number pool, unless you have a leased number on your account in which case it will be set as the Caller ID
• @param string message parameter: Required
• @param string format parameter: Required
• @param *int64 to parameter: Optional
• @param *string from parameter: Optional
• @param *string sendAt parameter: Optional
• @param *int64 listId parameter: Optional
• @param *string dlrCallback parameter: Optional
• @param *string replyCallback parameter: Optional
• @param *string validity parameter: Optional
• @param *string repliesToEmail parameter: Optional
• @param *bool fromShared parameter: Optional
• @param *string countrycode parameter: Optional
• @param *string trackedLinkUrl parameter: Optional
• @return Returns the interface{} response from the API call