Git Product home page Git Product logo

actions-africastalking's Introduction

๐Ÿ“จ Africastalking SMS Action

A GitHub Action to send a text message to mobile number of choice using Africastalking Programmable SMS

Usage

  1. Create a .github/workflows/sms.yml file in your repository.
  2. Add the following content to the sms.yml file:
name: SMS Notification
on:
  pull_request:

jobs:
  smsNotification:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: alphaolomi/actions-africastalking@main
        with:
          fromPhoneNumber: 'INFO' # or secrets.fromPhoneNumber
          toPhoneNumber: ${{ secrets.toPhoneNumber }}
          message: 'Hello World'
        env:
          AT_API_KEY: ${{ secrets.AT_API_KEY }}
          AT_USERNAME: ${{ secrets.AT_USERNAME }}
  1. Add the following secrets to your repository:
  • AT_API_KEY - Your Africastalking API Key
  • AT_USERNAME - Your Africastalking Username

Inputs

  • AT_API_KEY Required. You can get this from the Africastalking's Dashboard.
  • AT_USERNAME Required. Use 'sandbox' as the value for development in the test environment
  • fromPhoneNumber Required. The name or number the message will appear to be sent from. This can be a valid phone number or an alphanumeric string. For example, INFO or +255711XXXYYY.
  • toPhoneNumber Required. The mobile number the message will be sent to. This should include the country code, without any leading zeros. For example, 255711XXXYYY for a Tanzanian number.
  • message Required. The text content of the message. The maximum characters allowed is 160 per message. If you exceed this limit, the message will be split into multiple messages, each of which will be charged separately.

Outputs

  • messageId - The ID of the message sent

Authors

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

If you like this project

Give a โญ๏ธ if this project helped you!

๐Ÿ“ License

This project is MIT licensed.

actions-africastalking's People

Contributors

alphaolomi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.