tyntec SMS GitHub Action

This action sends an SMS using tyntec SMS API.

Inputs

`fromPhoneNumber`

Required The identification of the party sending the SMS. It can either be a phone number in the international format or an alphanumeric identifier with up to 11 characters.

`toPhoneNumber`

Required The phone number to send the SMS to in the international phone format E.164.

`message`

Required The message you want to send.

Environment variables (secrets)

`TYNTEC_API_KEY`

Required Your tyntec API key.

Outputs

`requestId`

The unique identifier provided for each messaging request.

Example usage

uses: tyntec/github-action-sms@v1
with:
  fromPhoneNumber: tyntec
  toPhoneNumber: +123456789
  message: Hello world!
env:
  TYNTEC_API_KEY: ${{ secrets.TYNTEC_API_KEY }}

Development

Install the dependencies

$ npm install

Build the typescript and package it for distribution

$ npm run build && npm run package