yuntongxun

Node.js SDK for yuntongxun RestAPI.

Examples

import Yuntongxun from 'yuntongxun-sdk';

const yuntongxun = new Yuntongxun({
  urlPrefix: 'https://app.cloopen.com:8883',
  version: '2013-12-26',
  accountSid: '<Your accountSid>',
  authToken: '<Your authToken>',
  appId: '<Your appId>'
});

yuntongxun.voiceVerify('13700000000', '123456').then((callSid) => {
  console.log(callSid);
}, (err) => {
  console.error(err);
});

Installation

$ npm install yuntongxun-sdk

Documents

Official Rest API document

Table of Contents

• Class: Yuntongxun
  • new Yuntongxun(options)
  • yuntongxun.voiceVerify(mobile, token[, displayNum, playTimes])
  • yuntongxun.callResult(callSid))
  • yuntongxun.templateSms(mobile, templateId[, datas])

Class: Yuntongxun

This class is a wrapper for yuntongxun Rest API

new Yuntongxun(options)

Construct a new yuntongxun object

options is an object with the following defaults:

{
  urlPrefix: 'https://app.cloopen.com:8883',
  version: '2013-12-26',
  useSubAccount: false,
  debug: false,
  logger: false
}

options's property list as below:

| Name | type | Description | Requirement | | ------------- | -------- | --------------------------------------- | ----------- | | urlPrefix | string | Base url without version | optional | | version | string | API version | optional | | accountSid | string | The accountSid or subAccountSid | required | | authToken | string | The account auth token | required | | appId | string | The app id | required | | useSubAccount | bool | Whether use subAccountSid or accountSid | optional | | debug | bool | Debug toggle | optional | | logger | function | A logger handler | optional | | proxy | string | Proxy for someone behind a firewall | optional | | timeout | integer | Timeout for request | optional |

logger function accept only one argument msg like

(msg) => {
  // do some thing...
}

| Name | type | Description | Requirement | | ---- | ------ | ----------- | ----------- | | msg | string | Log message | optional |

yuntongxun.voiceVerify(mobile, token[, displayNum, playTimes])

Send Voice Verify token to mobile with CID displayNum and repeat playTimes times

| Name | type | Description | Requirement | | ---------- | -------- | ------------------------------------- | ----------- | | mobile | string | User's mobile to receive voice verify | required | | token | string | Token played | required | | displayNum | string | CID | optional | | playTimes | integer | Repeat play times | optional |

yuntongxun.callResult(callSid)

Get call result callSid

| Name | type | Description | Requirement | | ---------- | -------- | ------------------------------------- | ----------- | | callSid | string | Call ID | required

yuntongxun.templateSms(mobile, templateId[, datas])

Send Template SMS identified by templateId to mobile with template data datas

| Name | type | Description | Requirement | | ---------- | -------- | -------------------------------------------------- | ----------- | | mobile | string | User's mobile to receive template SMS | required | | templateId | integer | Template ID applied from yuntongxun admin | required | | datas | array | Template data corresponding to template definition | optional |

Todo List

• [ ] To implement other Rest API interface.

License

MIT License. See the LICENSE file.