@paulchiu/messagemedia-messages-sdk
v2.0.5
Published
The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.
Downloads
2,807
Readme
MessageMedia Messages NodeJS SDK Patched Fork
[!IMPORTANT] The original MessageMedia SDK is no longer maintained upstream.
This repository is a fork of messagemedia/messages-nodejs-sdk (GitHub).
This fork exists to keep dependency and security fixes up to date.
If you are building a new integration, direct REST API usage is the recommended path: MessageMedia Messaging REST API Docs.
Installation
Install from npm:
npm install @paulchiu/messagemedia-messages-sdkOr add it to package.json:
"@paulchiu/messagemedia-messages-sdk": "^2.0.4"Using with Legacy Dependencies
If you have dependencies that still require the original messagemedia-messages-sdk package, you can force all packages to use this maintained fork with npm overrides.
In package.json, add or create overrides block:
{
"overrides": {
"messagemedia-messages-sdk": "npm:@paulchiu/messagemedia-messages-sdk@^2.0.4"
}
}This ensures any dependency requesting messagemedia-messages-sdk resolves to @paulchiu/messagemedia-messages-sdk.
Usage
Authentication uses API keys from the MessageMedia developer portal. Basic Auth uses:
basicAuthUserNamefor API keybasicAuthPasswordfor API secret
HMAC Auth uses:
hmacAuthUserNamefor API keyhmacAuthPasswordfor API secret
Send an SMS (Basic Auth)
const lib = require('@paulchiu/messagemedia-messages-sdk');
lib.Configuration.basicAuthUserName = 'YOUR_BASIC_API_KEY';
lib.Configuration.basicAuthPassword = 'YOUR_BASIC_SECRET_KEY';
var controller = lib.MessagesController;
let body = new lib.SendMessagesRequest();
body.messages = [];
body.messages[0] = new lib.Message();
body.messages[0].content = 'Hello world!';
body.messages[0].destinationNumber = '+61491570156'; // E.164 format
controller.sendMessages(body, function(error, response, context) {
if (error) {
console.log(error);
} else {
console.log(response);
}
});HMAC configuration
const lib = require('@paulchiu/messagemedia-messages-sdk');
lib.Configuration.hmacAuthUserName = 'YOUR_HMAC_API_KEY';
lib.Configuration.hmacAuthPassword = 'YOUR_HMAC_SECRET_KEY';Examples
Example scripts are in /examples:
examples/sendMessage.jsexamples/checkCredits.jsexamples/checkDeliveryReports.jsexamples/checkReplies.jsexamples/2fa.js
Replace placeholder credentials first, then run:
node examples/sendMessage.js