An open API service indexing awesome lists of open source software.

https://github.com/bugourmet/infobip-sender

Infobip outbound messaging library
https://github.com/bugourmet/infobip-sender

infobip infobip-api infobip-library infobip-sdk infobip-typescript library messaging sdk sms typescript viber whatsapp

Last synced: 3 months ago
JSON representation

Infobip outbound messaging library

Awesome Lists containing this project

README

          

Infobip Sender

Simple Infobip outbound messaging library written in typescript

[![GitHub stars](https://img.shields.io/github/stars/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/stargazers)
[![GitHub license](https://img.shields.io/github/license/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/blob/master/LICENSE)
[![GitHub forks](https://img.shields.io/github/forks/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/network/members)
[![GitHub issues](https://img.shields.io/github/issues/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/pulls)
[![GitHub last commit](https://img.shields.io/github/last-commit/runtimeterrorist/infobip-sender.svg)](https://github.com/runtimeterrorist/infobip-sender/commits/master)

Features 🚀

  • Supports sending all message types for SMS,WhatsApp and Viber channel.

  • Supports fetching purchased numbers for account and WhatsApp Templates for specified number with the capability.
  • Usage 💡

    install the package

    `npm install infobip-sender`

    Example:

    ```ts
    import { InfobipMessageService } from "infobip-sender";
    const config = { apiKey: "YourApiKey" };
    // Create an instance with your configuration
    const messagingService = new InfobipMessageService(config);

    //use sendSms() method to s end a single or bulk sms message
    const smsMessage = await messagingService.sms.sendSMS(
    "YourSenderNumberHere",
    "RecipientPhoneNumber",
    "Message"
    );

    const bulkSmsMessages = await messagingService.sms.sendSMS(
    "YourSenderNumberHere",
    ["RecipientPhoneNumber1", "RecipientPhoneNumber2"],
    "Message"
    );
    ```

    ...

    Messaging Service Configuration

    ```ts
    {
    apiKey: string;
    piIntegrator?: string;
    piPlatform?: string;
    baseUrl?: string;
    notifyUrl?: string;
    }
    ```

    ⚠️ IMPORTANT NOTE: The library does not include built-in logging nor error-handling mechanisms,responsibility for implementing such features remains on the end user.

    For more info refer to Infobip API Documentation

    TODO ✔️


  • implement Infobip Messaging API once it's out of Early Access

  • tests & improvements

  • add VOICE and RCS channels
  • Contributing 🤝


    Pull requests are welcome. If you have a suggestion open an issue with the tag "enhancement".

    License 📝

    MIT