mymobileapi

package module
v0.0.0-...-99e00b7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 21, 2021 License: MIT Imports: 8 Imported by: 0

README

mymobileapi-go

Go API Client to interact with the mymobileapi REST API.

The current implementation requires Go 1.14 and uses modules.

Install

import "github.com/breed808/mymobileapi-go"

Usage

client := mymobileapi.Client()
client, err := gandiapi.NewClient("Client ID", "supersecret", false)
if err != nil {
	log.Fatal("error")
}

// Query account balance
_, err := client.GetBalance()
if err != nil {
	log.Fatal(err)
}

// Send SMS message to recipient(s)
req := BulkMessageRequest{
    Messages: []Message{
        Message{
            Content:     "Hello World!",
            Destination: "0412345678",
        },
    },
}

resp, err := client.SendBulkMessages(req)
if err != nil {
	log.Fatal(err)
}

Note that when the client is initialised, the library automatically authenticates to mymobileapi and generates an authentication token. This token expires after 24 hours. Short-lived scripts/processes using this library need no be concerned of the expiry, but longer-running scripts/processes will need to re-authenticate every 24 hours.

// Reauthenticate if authentication token has expired
if time.Now().After(client.AuthTokenExpiry) {
    client.Authenticate()
}

// Query account balance
_, err := client.GetBalance()
if err != nil {
	log.Fatal(err)
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BulkMessageRequest 

type BulkMessageRequest struct {
	// A number of optional settings for a send
	SendOptions struct {
		// The sender ID (source address) to use when sending the messages specified. Maximum length is 11 characters.
		// Please note that a best effort is made to use the value specified but availability is ultimately
		// determined by the mobile network operator
		SenderId string `json:"senderId,omitempty"`
		// The type of duplication check to use (Defaults to 'None')
		DuplicateCheck string `json:"duplicateCheck,omitempty"`
		// The date and time in UTC when the messages should be sent.
		// Maximum date and time allowed is 3 months from the current date and time.
		// Value should be formatted according to ISO 8601 UTC format (yyyy-mm-ddThh:mm[:ss][Z])
		StartDeliveryUtc string `json:"startDeliveryUtc,omitempty"`
		// This value should be set in UTC if delivery should be staggered over a period of time.
		// Leave null if all messages should be sent as soon as possible.
		// Value, if set, must be greater than StartDeliveryUtc
		// and should be formatted according to ISO 8601 UTC format (yyyy-mm-ddThh:mm[:ss][Z])
		EndDeliveryUtc string `json:"endDeliveryUtc,omitempty"`
		// The name of the reply rule set that should be used for the send. Replies that are received as a result of
		// the send are then subject to rules configured in the reply rule set governing auto forwards and auto
		// responses
		ReplyRuleSetName string `json:"replyRuleSetName,omitempty"`
		// A user defined value for the name of the campaign associated with this send. Only used by the system for
		// reporting purposes. Maximum value is 100 characters
		CampaignName string `json:"campaignName,omitempty"`
		// A user defined value for the name of the cost center associated with this send. Only used by the system for
		// reporting purposes. Maximum value is 100 characters
		CostCentre string `json:"costCentre,omitempty"`
		// True if SMS messages should not be sent to mobile subscribers that have opted-out as a result of a previous
		// send; otherwise false
		CheckOptOuts bool `json:"checkOptOuts,omitempty"`
		// True if this send should try shorten and track urls otherwise false.
		ShortenUrls bool `json:"shortenUrls,omitempty"`
		// The amount of time in hours an SMS should remain valid.
		// The network will continue to try to deliver the SMS over the validity period.
		ValidityPeriod int `json:"validityPeriod,omitempty"`
		// Should the messages be sent or is this a test of the API?
		// If TestMode = true then it will return the result but won’t send the data, and won’t appear in any sent report.
		TestMode bool `json:"testMode,omitempty"`
		// The api name of the reply rule to use for this send
		RuleName string `json:"ruleName,omitempty"`
		// The specific reply rule version to use for this send (if null, the active version will be used).
		ReplyRuleVersion int `json:"replyRuleVersion,omitempty"`
		// Any Extra reply forward emails for this send.
		ExtraForwardEmails string `json:"extraForwardEmails,omitempty"`
	} `json:"sendOptions,omitempty"`
	Messages []Message
}

BulkMessageRequest is a request to send a batch of SMS messages

type BulkMessageResponse 

type BulkMessageResponse struct {
	// The total cost of the send excluding any VAT, GST or tax.
	Cost int `json:"cost"`
	// The remaining balance after the Cost has been deducted for the send.
	RemainingBalance int `json:"remainingBalance"`
	// The system generated ID for the send or batch of messages
	EventID int `json:"eventId"`
	// A sample message that was generated for the send. Purely informational.
	Sample string `json:"sample"`
	// The break down of the costs for the send grouped by mobile network and feature.
	CostBreakdown struct {
		Quantity int    `json:"quantity"`
		Cost     int    `json:"cost"`
		Network  string `json:"network"`
	} `json:"costBreakdown"`
	// The total number of messages that were successfully enqueued for delivery. Long messages may require
	// multiple SMS messages or parts to send a message and this is reflected in the Parts value.
	Messages int `json:"messages"`
	// The total number of SMS messages that were successfully enqueued for delivery.
	Parts       int `json:"parts"`
	ErrorReport struct {
		NoNetwork  int `json:"noNetwork"`
		Duplicates int `json:"duplicates"`
		OptedOuts  int `json:"optedOuts"`
		Faults     struct {
			RawDestination      string `json:"rawDestination"`
			ScrubbedDestination string `json:"scrubbedDestination"`
			CustomerID          string `json:"customerId"`
			ErrorMessage        string `json:"errorMessage"`
			Status              string `json:"status"`
		} `json:"faults"`
	} `json:"errorReport"`
}

BulkMessageResponse is returned by the API in response to a BulkMessageRequest

type Client 

type Client struct {
	AuthTokenExpiry time.Time
	// contains filtered or unexported fields
}

Client represents a client to the mymobile REST API.

func NewClient 

func NewClient(clientID, clientSecret string, debug bool) (*Client, error)

NewClient returns a client.

func (*Client) Authenticate 

func (c *Client) Authenticate() error

Authenticate to API, generating an Authentication token for use in future requests.

func (*Client) GetBalance 

func (c *Client) GetBalance() (int, error)

GetBalance returns the current balance of the account. Post Paid customers will always receive a balance of 1000000, as no credit deduction occurs on this account type.

func (*Client) SendBulkMessages 

func (c *Client) SendBulkMessages(data BulkMessageRequest) (resp BulkMessageResponse, err error)

SendBulkMessages sends SMS message(s) to a multiple recipients.

func (*Client) SendGroupMessages 

func (c *Client) SendGroupMessages(data GroupMessageRequest) (resp BulkMessageResponse, err error)

SendGroupMessages send SMS message(s) to one or more specified groups.

type GroupMessageRequest 

type GroupMessageRequest struct {
	// A number of optional settings for a send
	SendOptions struct {
		// The sender ID (source address) to use when sending the messages specified. Maximum length is 11 characters.
		// Please note that a best effort is made to use the value specified but availability is ultimately
		// determined by the mobile network operator
		SenderId string `json:"senderId,omitempty"`
		// The type of duplication check to use (Defaults to 'None')
		DuplicateCheck string `json:"duplicateCheck,omitempty"`
		// The date and time in UTC when the messages should be sent.
		// Maximum date and time allowed is 3 months from the current date and time.
		// Value should be formatted according to ISO 8601 UTC format (yyyy-mm-ddThh:mm[:ss][Z])
		StartDeliveryUtc string `json:"startDeliveryUtc,omitempty"`
		// This value should be set in UTC if delivery should be staggered over a period of time.
		// Leave null if all messages should be sent as soon as possible.
		// Value, if set, must be greater than StartDeliveryUtc
		// and should be formatted according to ISO 8601 UTC format (yyyy-mm-ddThh:mm[:ss][Z])
		EndDeliveryUtc string `json:"endDeliveryUtc,omitempty"`
		// The name of the reply rule set that should be used for the send. Replies that are received as a result of
		// the send are then subject to rules configured in the reply rule set governing auto forwards and auto
		// responses
		ReplyRuleSetName string `json:"replyRuleSetName,omitempty"`
		// A user defined value for the name of the campaign associated with this send. Only used by the system for
		// reporting purposes. Maximum value is 100 characters
		CampaignName string `json:"campaignName,omitempty"`
		// A user defined value for the name of the cost center associated with this send. Only used by the system for
		// reporting purposes. Maximum value is 100 characters
		CostCentre string `json:"costCentre,omitempty"`
		// True if SMS messages should not be sent to mobile subscribers that have opted-out as a result of a previous
		// send; otherwise false
		CheckOptOuts bool `json:"checkOptOuts,omitempty"`
		// True if this send should try shorten and track urls otherwise false.
		ShortenUrls bool `json:"shortenUrls,omitempty"`
		// The amount of time in hours an SMS should remain valid.
		// The network will continue to try to deliver the SMS over the validity period.
		ValidityPeriod int `json:"validityPeriod,omitempty"`
		// Should the messages be sent or is this a test of the API?
		// If TestMode = true then it will return the result but won’t send the data, and won’t appear in any sent report.
		TestMode bool `json:"testMode,omitempty"`
		// The api name of the reply rule to use for this send
		RuleName string `json:"ruleName,omitempty"`
		// The specific reply rule version to use for this send (if null, the active version will be used).
		ReplyRuleVersion int `json:"replyRuleVersion,omitempty"`
		// Any Extra reply forward emails for this send.
		ExtraForwardEmails string `json:"extraForwardEmails,omitempty"`
	} `json:"sendOptions,omitempty"`
	Message Message
	// The names of the groups that contacts should belong to. These contacts will be the recipients of
	// the SMS message. Should contain at least one group name.
	Groups []string
}

BulkMessageRequest is a request to send a batch of SMS messages

type Message 

type Message struct {
	// The textual content of the SMS message
	Content string `json:"content"`
	// The MSISDN (mobile number) to whom the messages is intended
	Destination string `json:"destination"`
	// A user defined ID which can be used to correlate messages sent to the API and receipts or replies
	// received for that message. Maximum length 100 characters
	CustomerId string `json:"customerId,omitempty"`
	// Variables related to the generation of a mobile document associated with a specific SMS message, and document template.
	Document struct {
		// The API template name related to the document template.
		Template string `json:"template,omitempty"`
		// The version of the document template to use. If not provided then the configured default (active) version is used.
		Version int `json:"version,omitempty"`
		// The authentication password for the document.
		// If not provided (Empty or Null) then the document will not require authentication.
		Password string `json:"password,omitempty"`
		// The values of the variables defined in the document template.
		Variables interface{} `json:"variables,omitempty"`
	} `json:"document,omitempty"`
}

The SMS message that should be sent. Must contain at least one message and at most 100 messages.

type StandardError 

type StandardError struct {
	Location    string `json:"location"`
	Name        string `json:"name"`
	Description string `json:"description"`
}

type StandardResponse 

type StandardResponse struct {
	Code    int             `json:"code,omitempty"`
	Message string          `json:"message,omitempty"`
	UUID    string          `json:"uuid,omitempty"`
	Object  string          `json:"object,omitempty"`
	Cause   string          `json:"cause,omitempty"`
	Status  string          `json:"status,omitempty"`
	Errors  []StandardError `json:"errors,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.