Unofficial Africa's Talking Golang API Wrapper

The wrapper provides convenient access to the Africa's Talking API from applications written in server-side Golang. This is Work in Progress

Installing

You can install the package by running:

go get github.com/AndroidStudyOpenSource/africastalking-go/sms

go get github.com/AndroidStudyOpenSource/africastalking-go/airtime

go get github.com/AndroidStudyOpenSource/africastalking-go/account

go get github.com/AndroidStudyOpenSource/africastalking-go/payment

Demo

In order to run the demo, export the the following values to your environment. They can be found/generated at the Africa's Talking Dashboard.

export AT_APIKEY=Your-AfricasTalking-API-KEY
export AT_USERNAME=Your-AfricasTalking-APP-USERNAME
export AT_SHORTCODE=Your-AfricasTalking-APP-Shortcode

That's all's that required. Assuming its a sandbox app, here's to run the demo:

cd demo
go run main.go -e sandbox -m "Hello gopher!" -r "+254700000000"

Usage

The package needs to be configured with your app username and API key (which you can get from the dashboard). You can also declare if you are running in production or in sandbox.

const (
	apiKey = "YOUR_API_KEY"		    //Production or Sandbox API Key
	username = "YOUR_USERNAME"	    //Your Africa's Talking Username
	env = ""		                // Choose either Sandbox or Production
)

Creating the Gateway

We first need to create a Gateway using the constants declared above. We will use this Gateway to invoke Africa's Talking Services - SMS, Voice, Airtime, USSD.

This is how we create the Gateway in our code:

smsService := sms.NewService(username, apiKey, env)

SMS

When sending a message, you need to pass the following data:

• Recipient(s)
• Message

We invoke this function using the following code - You can declare recipient and message as variables for code neatness:

//Send SMS - REPLACE Recipient and Message with REAL Values
smsResponse, err := smsService.Send("Recipient", "Message To Send", "")
if err != nil {
	fmt.Println(err)
}

fmt.Println(smsResponse)

This is the complete sample code. Try to understand how this works first!!!

package main

import (
	"fmt"
	"log"

	"github.com/AndroidStudyOpenSource/africastalking-go/sms"
)

const (
	username = "" //Your Africa's Talking Username
	apiKey   = "" //Production or Sandbox API Key
	env   = "" // Choose either Sandbox or Production
)

func main() {
	//Call the Gateway, and pass the constants here!
	smsService := sms.NewService(username, apiKey, env)

	//Send SMS - REPLACE Recipient and Message with REAL Values
	recipients, err := smsService.Send("Recipient", "Message To Send", "ShortCode" //Leave blank, "", if you don't have one)
	if err != nil {
		fmt.Println(err)
	}

	fmt.Println(smsResponse)
}

You can easily test this using Postman or Insomnia Clients!

Contributing and Issues

Please feel free to contribute or open issues, if any and we will be happy to help out!