https://github.com/messente/messente-api-node

Messente API library: https://www.npmjs.com/package/messente_api
https://github.com/messente/messente-api-node

number-lookup omnichannel phonebook statistics

Last synced: 25 days ago
JSON representation

Messente API library: https://www.npmjs.com/package/messente_api

• Host: GitHub
• URL: https://github.com/messente/messente-api-node
• Owner: messente
• Created: 2019-03-01T11:18:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-05T08:14:40.000Z (3 months ago)
• Last Synced: 2024-11-28T17:07:52.728Z (29 days ago)
• Topics: number-lookup, omnichannel, phonebook, statistics
• Language: JavaScript
• Homepage:
• Size: 411 KB
• Stars: 1
• Watchers: 7
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Messente API Library

- Messente API version: 2.0.0

- NPM package version: 2.2.0

[Messente](https://messente.com) 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](https://messente.com/documentation) 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:

- Omnichannel ([external docs](https://messente.com/documentation/omnichannel-api)),

- Phonebook ([external docs](https://messente.com/documentation/phonebook-api)).

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

### BlacklistApi

1. Adds a phone number to the blacklist [`addToBlacklist`](docs/BlacklistApi.md#addtoblacklist)

1. Deletes a phone number from the blacklist [`deleteFromBlacklist`](docs/BlacklistApi.md#deletefromblacklist)

1. Returns all blacklisted phone numbers [`fetchBlacklist`](docs/BlacklistApi.md#fetchblacklist)

1. Checks if a phone number is blacklisted [`isBlacklisted`](docs/BlacklistApi.md#isblacklisted)

### BulkMessagingApi

1. Sends a bulk Omnimessage [`sendBulkOmnimessage`](docs/BulkMessagingApi.md#sendbulkomnimessage)

### ContactsApi

1. Adds a contact to a group [`addContactToGroup`](docs/ContactsApi.md#addcontacttogroup)

1. Creates a new contact [`createContact`](docs/ContactsApi.md#createcontact)

1. Deletes a contact [`deleteContact`](docs/ContactsApi.md#deletecontact)

1. Lists a contact [`fetchContact`](docs/ContactsApi.md#fetchcontact)

1. Lists groups of a contact [`fetchContactGroups`](docs/ContactsApi.md#fetchcontactgroups)

1. Returns all contacts [`fetchContacts`](docs/ContactsApi.md#fetchcontacts)

1. Removes a contact from a group [`removeContactFromGroup`](docs/ContactsApi.md#removecontactfromgroup)

1. Updates a contact [`updateContact`](docs/ContactsApi.md#updatecontact)

### DeliveryReportApi

1. Retrieves the delivery report for the Omnimessage [`retrieveDeliveryReport`](docs/DeliveryReportApi.md#retrievedeliveryreport)

### GroupsApi

1. Creates a new group with the provided name [`createGroup`](docs/GroupsApi.md#creategroup)

1. Deletes a group [`deleteGroup`](docs/GroupsApi.md#deletegroup)

1. Lists a group [`fetchGroup`](docs/GroupsApi.md#fetchgroup)

1. Returns all groups [`fetchGroups`](docs/GroupsApi.md#fetchgroups)

1. Updates a group with the provided name [`updateGroup`](docs/GroupsApi.md#updategroup)

### NumberLookupApi

1. Requests info about phone numbers [`fetchInfo`](docs/NumberLookupApi.md#fetchinfo)

### OmnimessageApi

1. Cancels a scheduled Omnimessage [`cancelScheduledMessage`](docs/OmnimessageApi.md#cancelscheduledmessage)

1. Sends an Omnimessage [`sendOmnimessage`](docs/OmnimessageApi.md#sendomnimessage)

### StatisticsApi

1. Requests statistics reports for each country [`createStatisticsReport`](docs/StatisticsApi.md#createstatisticsreport)

## Auth

**Type**: HTTP basic authentication

Read the [external getting-started article](https://messente.com/documentation/getting-started) which explains API keys and Sender ID logic.

## Getting started: sending an omnimessage

```js

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 whatsAppParameters = [MessenteApi.WhatsAppParameter.constructFromObject({type: 'text', text: 'hello whatsapp'})];

const whatsAppComponent = MessenteApi.WhatsAppComponent.constructFromObject({type: 'body', parameters: whatsAppParameters});

const whatsAppTemplate = MessenteApi.WhatsAppTemplate.constructFromObject({

  name: '',

  language: new MessenteApi.WhatsAppLanguage(code=''),

  components: [whatsAppComponent],

});

const whatsapp = MessenteApi.WhatsApp.constructFromObject({

  sender: "",

  template: whatsAppTemplate,

});

const omnimessage = MessenteApi.Omnimessage.constructFromObject({

  messages: [whatsapp, viber, sms],

  to: '',

});

api.sendOmnimessage(omnimessage, (error, data) => {

  if (error) {

    console.error(error);

  } else {

    console.log('API called successfully. Returned data: ', data);

  }

});

```

## License

[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0.html)

## Terms

[https://messente.com/terms-and-conditions](https://messente.com/terms-and-conditions)