messagemedia-conversations-sdk
v1.0.0
Published
The Conversations API allows users to communicate by sending and receiving messages via Over-The-Top (OTT) messaging services. OTT application is an app or service that provides a product over the Internet and bypasses traditional distribution. Here's an
Downloads
4
Readme
MessageMedia Conversations NodeJS SDK
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 ([email protected]).
⭐️ 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 into the code snippet below.
🚀 Configure an account
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
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
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.
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
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.
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.
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.
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 for more detailed information.
😕 Need help?
Please contact developer support at [email protected] or check out the developer portal at developers.messagemedia.com
📃 License
Apache License. See the LICENSE file.