Skip to main content

wigal-sms Adaptor developer README.md

Source: https://github.com/OpenFn/adaptors/tree/main/packages/wigal-sms

language-wigal-sms

An OpenFn adaptor for building integration jobs for use with the Wigal SMS API.

Documentation​

View the docs site for full technical documentation. Bulk SMS APIs are documented here.

Example​

sendSMS({
  senderid: 'Stevkky',
  destinations: [
    {
      destination: '0552825710',
    },
  ],
  message: 'This is a sample message for SMS sending via Wigal FROG API.',
  smstype: 'text',
});

Configuration​

View the configuration-schema for required and optional configuration properties.

Development​

Clone the adaptors monorepo. Follow the "Getting Started" guide inside to get set up.

Run tests using pnpm run test or pnpm run test:watch

Build the project using pnpm build.

To build only the docs run pnpm build docs.