https://github.com/messagemedia/conversations-nodejs-sdk
MessageMedia Node.js SDK for sending and receiving messages via OTT messaging services
https://github.com/messagemedia/conversations-nodejs-sdk
api conversations messaging nodejs ott
Last synced: 6 months ago
JSON representation
MessageMedia Node.js SDK for sending and receiving messages via OTT messaging services
- Host: GitHub
- URL: https://github.com/messagemedia/conversations-nodejs-sdk
- Owner: messagemedia
- License: apache-2.0
- Created: 2018-06-04T02:53:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-16T23:29:00.000Z (almost 7 years ago)
- Last Synced: 2025-02-07T17:38:29.158Z (8 months ago)
- Topics: api, conversations, messaging, nodejs, ott
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MessageMedia Conversations NodeJS SDK
[](https://travis-ci.org/messagemedia/conversations-nodejs-sdk)
[](https://badge.fury.io/js/messagemedia-conversations-sdk)
⚠️ **Please note the API documented is in beta and is subject to breaking changes in the short term.** ⚠️
The MessageMedia Conversations API allows users to communicate by sending and receiving messages via OTT messaging services. This feature is disabled by default. To enable it, you don't need to make any changes to your application, just an account configuration change by MessageMedia's support team (support@messagemedia.com).
## ⭐️ Installing via NPM
Now install messagemedia-messages-sdk via npm by using:
* `npm install messagemedia-conversations-sdk`
Alternatively, add the following to the dependencies section of your package.json:
* `"messagemedia-conversations-sdk": "^1.0.0"`
## 🎬 Get Started
It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below.
### 🚀 Configure an account
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.ConfigurationController;
var request = new lib.ConfigureAccountRequest({
"name": "Rainbow Serpent Festival",
"callback_url": "https://callback.url.com"
});
controller.createConfigureAccount(request, function(error, response, context) {
console.log(error);
});
```
### 🔐 Facebook Authorization
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.FacebookController;
controller.getFacebookAuthorisationURL(function(error, response, context) {
console.log(response);
});
```
### ⬇️ Get Facebook pages
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.FacebookController;
controller.getFacebookPages(function(error, response, context) {
console.log(response);
});
```
### ♻️ Integrate Facebook page
You can get the facebookPageId by looking at the response of the Get Facebook pages example.
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.FacebookController;
var facebookPageId = 'facebookPageId';
controller.createIntegrateFacebookPage(facebookPageId, function(error, response, context) {
console.log(response);
});
```
### 👤 Get users
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.AppUsersController;
controller.getAppUsers(function(error, response, context) {
console.log(response);
});
```
### 👤 Get user by id
You can get the appUserId from the response of the Get users example.
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.AppUsersController;
var appUserId = 'appUserId';
controller.getAppUserById(appUserId, function(error, response, context) {
console.log(response);
});
```
### 💬 Get user messages
You can get the appUserId from the response of the Get users example.
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.AppUsersController;
var appUserId = 'appUserId';
controller.getAppUserMessages(appUserId, function(error, response, context) {
console.log(response);
});
```
### ✉️ Send message to user
You can get the appUserId from the response of the Get users example.
```javascript
const lib = require('messagemedia-conversations-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
var controller = lib.AppUsersController;
var appUserId = 'appUserId';
var message = new BaseMessageDto({"key":"value"});
controller.createSendMessage(appUserId, message, function(error, response, context) {
console.log(response);
});
```
## 📕 Documentation
Check out the [full API documentation](DOCUMENTATION.md) for more detailed information.
## 😕 Need help?
Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
## 📃 License
Apache License. See the [LICENSE](LICENSE) file.