Skip to content

Latest commit

 

History

History
99 lines (79 loc) · 2.88 KB

README.md

File metadata and controls

99 lines (79 loc) · 2.88 KB
Raw

bulksmszw

A flutter or dart plugin for developers to use the bulksmsweb api services

Authentication details

  • register an account on bulksms website
  • if already have an account, login on bulksms web portal
  • Got to "My Account", then Click on "User Configuration", to obtain "Webservices token".
  • Use your webservices token as bulksmsWebKey and registered username as bulksmsWebName

Usage

Example

Screenshot

Demo App Sms inbox

To use bulksmszw package, add it to your project pubspec.yaml

dependencies:
  flutter:
    sdk: flutter

  bulksmszw: ^2.0.0-dev

How to use

First import the bulksmszw package in your dart file

import 'package:bulksmszw/bulksmszw.dart';

Create a BulkSmsZw() object passing in your api-key and api-username

final smsApi = BulkSmsZw(
      bulksmsWebKey: '<your-api-key>',
      bulksmsWebName: '<your-api-username>',
    );

Send (bulk) SMS

To send a message, pass your contacts in a list as a list string

List<String> contacts = [
    '263777777777',
    '#flutterDev',  // you can pass group names too
];

ApiResponse _response = await smsApi.send(
   message: 'Please be reminded that project deadline is today at 15:45pm',
  recipients: contacts,
);

// you can check response from ApiResponse -> _response
if(_response.statusresponse == SMSRESPONSE.SUCCESS)
{
    showSuccessToast();
}

Features

  • [✔] Send SMS
  • [✔] Customized api response
  • [❌] Schedule messages
  • [❌] Validate phone numbers

Api Changes

Api changes are available on CHANGELOG

Additionals

  • features and pr and contributions are welcome.
  • api docs for bulksmsweb at HTTP API INTEGRATION DOC
  • *unofficial bulksmsweb package

Getting Started

This project is a starting point for a Dart package, a library module containing code that can be shared easily across multiple Flutter or Dart projects.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.