Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cmdotcom/text-sdk-javascript
Javascript SDK to send messages with CM.com
https://github.com/cmdotcom/text-sdk-javascript
business-messaging chat conversational hacktoberfest messaging mms push rbm rcs sms telegram text viber wechat whatsapp
Last synced: 8 days ago
JSON representation
Javascript SDK to send messages with CM.com
- Host: GitHub
- URL: https://github.com/cmdotcom/text-sdk-javascript
- Owner: cmdotcom
- License: mit
- Created: 2018-09-19T13:41:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-13T12:59:43.000Z (5 months ago)
- Last Synced: 2024-09-21T06:43:20.038Z (about 2 months ago)
- Topics: business-messaging, chat, conversational, hacktoberfest, messaging, mms, push, rbm, rcs, sms, telegram, text, viber, wechat, whatsapp
- Language: TypeScript
- Homepage: https://www.cm.com/communications-platform/
- Size: 687 KB
- Stars: 7
- Watchers: 13
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## @cmdotcom/text-sdk: A helper library to send text messages.
[](https://www.npmjs.com/package/@cmdotcom/text-sdk)
[](https://codecov.io/gh/cmdotcom/text-sdk-javascript)
Want to send text-messages in your Node.js application? Then you are at the right place.
The package is currently limited in features compared to the CM gateway, but if you want to get all the functionalities, go to: [CM.com API Docs](https://developers.cm.com/messaging/docs)
### Usage
#### Node.JS
First, run `npm install @cmdotcom/text-sdk`. Then, in your source file:
```javascript
const messagingApi = require("@cmdotcom/text-sdk");
// Get your product token at CM.com.
const yourProductToken = "";
const myMessageApi = new messagingApi.MessageApiClient(yourProductToken);
const result = myMessageApi.sendTextMessage(["00316012345678"], "TestSender", "Hello world?!");
result.then((result) => {
console.log(result);
}).catch((error) => {
console.log(error);
});
```
or send multiple
```javascript
const result = myMessageApi.sendTextMessage(["00316012345678","003160000000"], "TestSender", "Hello world?!");
```
send rich messages using the message builder
```javascript
const richMessage = {
media: {
mediaName: "cm.com",
mediaUri: "https://avatars3.githubusercontent.com/u/8234794?s=200&v=4"
},
text: "Our logo!"
};
const suggestion = {
action: "openUrl",
label: "Click me",
url: "https://www.cm.com"
};
const response = client.createMessage()
.setMessage(["00316012345678"], "TestSender", "Hello world?!")
.setAllowedChannels(["Viber"])
.setConversation([richMessage])
.setSuggestion([suggestion])
.send();
response.then((result) => {
console.log(result);
}).catch((error) => {
console.log(error);
});
```
or send whatsapp template messages using the message builder
```javascript
const template = {
whatsapp: {
elementName: 'template-name',
language: {
code: 'en',
policy: 'deterministic'
},
namespace: 'the-namespace-of-template',
components: [{
type: 'body',
parameters: [{
type: 'text',
text: 'firstname'
}]
}]
}
};
const response = client.createMessage()
.setMessage(["00316012345678"], "TestSender", "Hello world?!")
.setAllowedChannels(["WhatsApp"])
.setTemplate(template)
.send();
response.then((result) => {
console.log(result);
}).catch((error) => {
console.log(error);
});
```
or send whatsapp interactive messages using the message builder
```javascript
const whatsAppInteractiveContent = {
type: 'list',
header: {
type: "text",
text: "your-header-content"
},
body: {
text: "your-text-message-content"
},
footer: {
text: "your-footer-content"
},
action: {
button: "cta-button-content",
sections: [{
title: "your-section-title1",
rows: [{
id: "unique-row-identifier1",
title: "row-title-content",
description: "row-description-content"
}]
},
{
title: "your-section-title2",
rows: [{
id: "unique-row-identifier2",
title: "row-title-content",
description: "row-description-content"
}]
}
]
}
};
const response = client.createMessage()
.setMessage(["00316012345678"], "TestSender", "Hello world?!")
.setAllowedChannels(["WhatsApp"])
.setInteractive(whatsAppInteractiveContent)
.send();
response.then((result) => {
console.log(result);
}).catch((error) => {
console.log(error);
});
```
### License
@cmdotcom/text-sdk is under the MIT license. See LICENSE file.