africastalking

README

africastalking

Minimal Go client for the Africa's Talking API

License

The Unlicense

Documentation

Index

• type AtClient
  • func New(apiKey string, username string, sandbox bool) *AtClient
  • func (at *AtClient) SendBulkSMS(ctx context.Context, input BulkSMSInput) (BulkSMSResponse, error)
  • func (at *AtClient) SetHTTPClient(httpClient *http.Client) *AtClient
• type BulkSMSInput
• type BulkSMSRecipient
• type BulkSMSResponse

Types

type AtClient

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

func New

func New(apiKey string, username string, sandbox bool) *AtClient

New returns an instance of an Africa's Talking client reusbale across different products.

func (*AtClient) SendBulkSMS

func (at *AtClient) SendBulkSMS(ctx context.Context, input BulkSMSInput) (BulkSMSResponse, error)

SendBulkSMS makes a POST request to send bulk SMS's the Africa's Talking and returns a response. It uses opinionated defaults.

func (*AtClient) SetHTTPClient

func (at *AtClient) SetHTTPClient(httpClient *http.Client) *AtClient

SetHTTPClient can be used to override the default client with a custom set one.

type BulkSMSInput

type BulkSMSInput struct {
	To      []string
	Message string
	From    string
}

BulkSMSInput is passed to SendBulkSMS as a parameter.

type BulkSMSRecipient

type BulkSMSRecipient struct {
	StatusCode uint   `json:"statusCode"`
	Number     string `json:"number"`
	Status     string `json:"status"`
	Cost       string `json:"cost"`
	MessageID  string `json:"messageId"`
}

BulkSMSRecipient is returned as part of the BulkSMSResponse.

type BulkSMSResponse

type BulkSMSResponse struct {
	SMSMessageData struct {
		Message    string             `json:"Message"`
		Recipients []BulkSMSRecipient `json:"Recipients"`
	} `json:"SMSMessageData"`
}

BulkSMSResponse is returned by SendBulkSMS as a response.