mns-node-sdk/README.md

unofficial sdk for Aliyun mns

# mns-nodejs-sdk

Documents: http://doxmate.cool/aliyun/mns-nodejs-sdk/api.html

## Installation

```bash
npm install mns-node-sdk
```

## API Spec

See: https://help.aliyun.com/document_detail/27475.html

## Usage

```ts
import { Client } from 'mns-node-sdk'

const client = new Client({
    accountId: '<account id>',
    region: '<region>',
    accessKeyId: '<access key id>',
    accessKeySecret: '<access key secret>',
    // optional & default
    secure: false, // use https or http
    internal: false, // use internal endpoint
    vpc: false, // use vpc endpoint
    keepAlive: true,
    retries: 3,
  }
);

(async function () {
  let res;

  // create queue
  res = await client.createQueue({
    QueueName: '<queue name>'
  });
  console.log(res);
  
  // list queue
  res = await client.listQueue();
  console.log(JSON.stringify(res, null, 2));
  
  // create topic
  res = await client.createTopic({
    TopicName: '<topic name>'
  });
  console.log(res);
  
  // get topic attributes
  res = await client.getTopicAttributes({
    TopicName: '<topic name>'
  });
  console.log(res);
  
  // publish message
  res = await client.publishMessage({
    TopicName: '<topic name>',
    Payloads: {
      MessageBody: 'content',
      MessageAttributes: {
        DirectSMS: JSON.stringify({
          FreeSignName: '',
          TemplateCode: '<template code>',
          Type: '<type>',
          Receiver: '<phone number>',
          SmsParams: JSON.stringify({
            code: '<code>',
            product: '<product>'
          })
        })
      }
    }
  });
  console.log(res);
})().then((data) => {
  console.log(data);
}, (err) => {
  console.log(err.stack);
});
```

## License

The [MIT][1] License

[1]:	LICENSE