ochiengotieno304/africastalking-esp8266

The unofficial AfricasTalking API Wrapper for ESP8266

Africa's Talking ESP8266 Library

Provides convenient access to the Africa's Talking API from esp8266 module written in C++.

Installation

Download the zip package from here.

Manually install the library

Once you get the library, just 3 steps are required before you can use it:

1. Extract the archive.
2. Place the library folder in Arduino/libraries/.
3. Restart the Arduino IDE.

Install from the IDE

In you Arduino IDE got to Sketch > Include Library > Add .ZIP Library and browse to find your .zip archive. Alternatively, in the Arduino library manager search for AfricasTalking library

Usage

The library needs to be instantiated using your username and API key, which you can get from the dashboard.

You can use this library for either production or sandbox apps. For sandbox, the app username is ALWAYS sandbox.

Initialization

In your .ino file:

  #include <AfricasTalking.h>

  static const char *apiKey = "YOUR_API_KEY";
  static const char *username = "YOUR_USERNAME";

  AfricasTalking *AT;
  AT = new AfricasTalking(apiKey, username);

Application

  String appData = AT->applicationData();

Airtime

  String recipients[] = { "{ \"phoneNumber\":\"+254XXXXXXXXX\",\"currencyCode\":\"KES\",\"amount\":\"5\" }" };

  bool success = AT->airtime(recipients);

• recipients: string array with recipient info REQUIRED
  • phoneNumber: phone number that will be topped up REQUIRED
  • currencyCode: currency code REQUIRED
  • amount: value of airtime to send

SMS

  bool success = AT->sms(toNumber, fromNumber, message);

• toNumber: message recipient phone number, comma seperated for bulk send REQUIRED
• fromNumber: Africa's Talking provide short codeREQUIRED
• message: message to senderREQUIRED

Voice

Make Call

  bool success = AT->voice(fromNumber, toNumber);

• toNumber: call destination phone number REQUIRED
• fromNumber: Africa's Talking provide phone number REQUIRED

Payments

Note: Implementing

Development

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ochiengotieno304/africastalking-esp8266/issues.

License

The library is available as open source under the terms of the MIT License.

africastalking-esp8266's Issues

Sender number set as required despite being optional in th documentation

This is an amazing initiative @ochiengotieno304 . I have a small concern, getting shortcodes from africastalking isn't worthwhile for simple projects and in their sdks they have set short codes as optional however in your application its a requirement. Is it possible to send an SMS without having a shortcode