messente_api

    1.4.0 • Public • Published

    Messente API Library

    • Messente API version: 1.4.0
    • NPM package version: 1.4.0

    Messente is a global provider of messaging and user verification services. * Send and receive SMS, Viber, WhatsApp and Telegram messages. * Manage contacts and groups. * Fetch detailed info about phone numbers. * Blacklist phone numbers to make sure you're not sending any unwanted messages. Messente builds tools to help organizations connect their services to people anywhere in the world.

    Installation

    Install Messente API library with npm install messente_api --save.

    Features

    Messente API has the following features:

    Messente API Library provides the operations described below to access the features.

    BlacklistApi

    1. Adds a phone number to the blacklist addToBlacklist
    2. Deletes a phone number from the blacklist deleteFromBlacklist
    3. Returns all blacklisted phone numbers fetchBlacklist
    4. Checks if a phone number is blacklisted isBlacklisted

    ContactsApi

    1. Adds a contact to a group addContactToGroup
    2. Creates a new contact createContact
    3. Deletes a contact deleteContact
    4. Lists a contact fetchContact
    5. Lists groups of a contact fetchContactGroups
    6. Returns all contacts fetchContacts
    7. Removes a contact from a group removeContactFromGroup
    8. Updates a contact updateContact

    DeliveryReportApi

    1. Retrieves the delivery report for the Omnimessage retrieveDeliveryReport

    GroupsApi

    1. Creates a new group with the provided name createGroup
    2. Deletes a group deleteGroup
    3. Lists a group fetchGroup
    4. Returns all groups fetchGroups
    5. Updates a group with the provided name updateGroup

    NumberLookupApi

    1. Requests info about phone numbers fetchInfo

    OmnimessageApi

    1. Cancels a scheduled Omnimessage cancelScheduledMessage
    2. Sends an Omnimessage sendOmnimessage

    StatisticsApi

    1. Requests statistics reports for each country createStatisticsReport

    Auth

    Type: HTTP basic authentication

    Read the external getting-started article which explains API keys and Sender ID logic.

    Getting started: sending an omnimessage

    const MessenteApi = require('messente_api');
     
    const defaultClient = MessenteApi.ApiClient.instance;
     
    // Configure HTTP basic authorization: basicAuth
    const basicAuth = defaultClient.authentications['basicAuth'];
    basicAuth.username = 'YOUR_MESSENTE_API_USERNAME';
    basicAuth.password = 'YOUR_MESSENTE_API_PASSWORD';
     
    const api = new MessenteApi.OmnimessageApi();
     
    const viber = MessenteApi.Viber.constructFromObject({
      text: 'Hello Viber!',
      sender: 'Messente',
    });
     
    const sms = MessenteApi.SMS.constructFromObject({
      text: 'Hello SMS!',
    });
     
    const whatsAppText = MessenteApi.WhatsAppText.constructFromObject({
      body: 'Hello WhatsApp!',
      preview_url: false,
    });
     
     
    const whatsapp = MessenteApi.WhatsApp.constructFromObject({
      text: whatsAppText,
    });
     
    const omnimessage = MessenteApi.Omnimessage.constructFromObject({
      messages: [whatsapp, viber, sms],
      to: '<phone number in e.164 format',
    });
     
    api.sendOmnimessage(omnimessage, (error, data) => {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ', data);
      }
    });
     

    License

    Apache-2.0

    Terms

    https://messente.com/terms-and-conditions

    Keywords

    none

    Install

    npm i messente_api

    DownloadsWeekly Downloads

    1,077

    Version

    1.4.0

    License

    Apache-2.0

    Unpacked Size

    316 kB

    Total Files

    125

    Last publish

    Collaborators

    • messente.developers