Git Product home page Git Product logo

yuntongxun's Introduction

yuntongxun

Node.js SDK for yuntongxun RestAPI.

Build Status semantic-release

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

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.

yuntongxun's People

Contributors

meteormatt avatar soulwu avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.