Code Monkey home page Code Monkey logo

macrokiosk-sdk's Introduction

Macrokiosk (BOLD for SMS) unofficial SDK

This repository contains the open source Node.js client for Macrokiosk's API.

Installation

npm install @adlanarifzr/macrokiosk-sdk

Usage

Typescript with ES6 import (or .mjs with Node >= v13):

import Macrokiosk, { MessageType, SendMessageOptions, SendMessageResult } from '@adlanarifzr/macrokiosk-sdk';
const macrokiosk = new Macrokiosk('<USERNAME>', '<PASSWORD>', '<SENDER_ID>', '<SERVICE_ID>');

Send message:

// Options is optional
const options: SendMessageOptions = {
    type: MessageType.ASCII,
    showDetail: true,
};
const result: SendMessageResult = await macrokiosk.sendMessage(['<MOBILE_NUMBER>'], 'This is just a test', options);

// Result object:
{
  recipients: {
    '60123456789': {
      messageId: '24677783439',
      status: 200,
      description: 'Successful',
      currency: 'MYR',
      chargedAmount: 0.072
    }
  },
  remainingBalance: 0,
  totalRecipients: 1
}

Notes

Other than MessageType.ASCII, you would need to format/encode the message based on the documentation.

macrokiosk-sdk's People

Contributors

adlanarifzr avatar

Watchers

 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.