cmdotcom/text-sdk-javascript

Javascript SDK to send messages with CM.com

@cmdotcom/text-sdk: A helper library to send text messages.

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

Usage

Node.JS

First, run npm install @cmdotcom/text-sdk. Then, in your source file:

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

const result = myMessageApi.sendTextMessage(["00316012345678","003160000000"], "TestSender", "Hello world?!");

send rich messages using the message builder

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

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

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.

text-sdk-javascript's Issues

why WhatsApp interactive not implemented?

why WhatsApp interactive not implemented?

Calling sendTextMessage after sending MMS causes message to be incorrectly sent as MMS

Expected result:
Message should be sent as SMS anytime you call sendTextMessage. I'm seeing in the console that the message is being sent as an MMS.

I think the cause is that I previously sent an MMS and CM is somewhere remembering that my allowedChannels is ["MMS"].

I'll submit a pull request shortly.

Axios is vulnerable

Can you bump axios to fix this vulnerability? GHSA-wf5p-g6vw-rhxx

Telegram is not added as an available medium

Looking at this code: Array of channels

You can notice Telegram is missing while its added to other sdk's.

Support for newer Node.js versions, and moving away from request dependency

We've got a report, that in newer version of node.js, http doesn't contain the ClientResponse anymore.

See this issue for extra information:
request/request#678

Request is also used as dependency, which is out-of-service for a while now.

Customgrouping 1 is accidently used for SDK value

See https://github.com/cmdotcom/text-sdk-java/issues/25 for the same issue.

Throwing response instead of error

The SDK is throwing the response when a request fails, while an error is expected.

const send = async () => {
  try {
    const client = new CM.MessageApiClient('token')

    const result = await client.createMessage().send()
  } catch (e) {
    console.log(e) // this is a http response

    throw new Error(e.body.messages[0].messageErrorCode, e.body.messages[0].messageDetails)
  }
}

request is deprecated and vulnerable

This package depends on request which

• has been deprecated request/request#3142
• has a vulnerability GHSA-p8p7-x288-28g6

request should be replaced by an alternative.

Generic test issue