co-alidayu
Version:
阿里大鱼服务端Node库API，ES6版本
628 lines (469 loc) • 15.9 kB
HTML
<html>
<head>
<meta charset="utf-8" />
<title>co-alidayu Documentation</title>
<meta name="keywords" content="alidayu" />
<meta name="description" content="阿里大鱼服务端Node库API，ES6版本" />
<script src="assets/prettify.js"></script>
<script src="assets/jquery-1.8.2.min.js"></script>
<script src="assets/bootstrap/js/bootstrap.js"></script>
<link rel="stylesheet" type="text/css" href="assets/bootstrap/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="assets/base.css" />
</head>
<body>
<nav class="navbar navbar-inverse navbar-static-top top-navbar" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="./index.html">co-alidayu</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li>
<a href="./api.html">API Docs</a>
</li>
</ul>
</div><!-- /.navbar-collapse -->
</div>
</nav>
<header class="jumbotron subhead">
<div class="container">
<h1>co-alidayu <small>Version: 1.0.0 By @[object Object]</small></h1>
<p class="lead">
阿里大鱼服务端Node库API，ES6版本
</p>
</div>
</header>
<div class="container content">
<div class="row">
<div class="col-md-3 bs-docs-sidebar">
<ul class="nav nav-list bs-docs-sidenav affix">
<li>
<div class="accordion" id="api_common">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_api_common" class="api_side_link">api_common</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#api_common" href="#collapse_api_common">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_api_common">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#api_common__API">API</a>
</li>
<li>
<a href="#api_common__sign">sign</a>
</li>
<li>
<a href="#api_common__setOpts">setOpts</a>
</li>
<li>
<a href="#api_common_API_mixin">mixin</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
<li>
<div class="accordion" id="api_sms">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_api_sms" class="api_side_link">api_sms</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#api_sms" href="#collapse_api_sms">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_api_sms">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#api_sms_exports_send_sms">send_sms</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
<li>
<div class="accordion" id="api_tts_singlecall">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_api_tts_singlecall" class="api_side_link">api_tts_singlecall</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#api_tts_singlecall" href="#collapse_api_tts_singlecall">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_api_tts_singlecall">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#api_tts_singlecall_exports_tts_singlecall">tts_singlecall</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
<li>
<div class="accordion" id="api_voice_doublecall">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_api_voice_doublecall" class="api_side_link">api_voice_doublecall</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#api_voice_doublecall" href="#collapse_api_voice_doublecall">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_api_voice_doublecall">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#api_voice_doublecall_exports_voice_doublecall">voice_doublecall</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
<li>
<div class="accordion" id="api_voice_singlecall">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_api_voice_singlecall" class="api_side_link">api_voice_singlecall</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#api_voice_singlecall" href="#collapse_api_voice_singlecall">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_api_voice_singlecall">
<div class="accordion-inner">
<ul class="indexs">
<li>
<a href="#api_voice_singlecall_exports_voice_singlecall">voice_singlecall</a>
</li>
</ul>
</div>
</div>
</div>
</div>
</li>
<li>
<div class="accordion" id="util">
<div class="accordion-group">
<div class="accordion-heading">
<a href="#api_util" class="api_side_link">util</a>
<div class="accordion-marker">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-parent="#util" href="#collapse_util">
<span class="glyphicon glyphicon-chevron-right"></span>
</a>
</div>
</div>
<div class="accordion-body collapse" id="collapse_util">
<div class="accordion-inner">
<ul class="indexs">
</ul>
</div>
</div>
</div>
</div>
</li>
</ul>
</div>
<div class="col-md-9">
<section id="api_api_common" class="api">
<h2>api_common: API索引</h2>
<ul class="indexs">
<li>
<a href="#api_common__API">API</a>
</li>
<li>
<a href="#api_common__sign">sign</a>
</li>
<li>
<a href="#api_common__setOpts">setOpts</a>
</li>
<li>
<a href="#api_common_API_mixin">mixin</a>
</li>
</ul>
<hr />
<h3 data-id="api_common__API">
API
</h3>
<p>API构造函数<br />Examples:</p><pre><code>// 创建api实例
var api = new API("appkey", "appsecret", "use_https", "sandbox");
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>函数</td>
<td colspan="3">API()</td>
</tr>
<tr>
<td>参数</td>
<td>appKey(String)</td>
<td colspan="2"><p>应用的app key</p></td>
</tr>
<tr>
<td>参数</td>
<td>appSecret(String)</td>
<td colspan="2"><p>应用的app secret</p></td>
</tr>
<tr>
<td>参数</td>
<td>use_https(Boolean)</td>
<td colspan="2"><p>是否使用https通道</p></td>
</tr>
<tr>
<td>参数</td>
<td>sandbox(Boolean)</td>
<td colspan="2"><p>是否使用砂箱</p></td>
</tr>
</table>
<h3 data-id="api_common__sign">
sign
</h3>
<p>计算签名。单独使用可以用于验证各种回调接口的签名。<br />Examples:</p><pre><code>// 计算签名
var shasum = api.getSignature("nonce", "timestamp");
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">API.prototype.sign()</td>
</tr>
<tr>
<td>参数</td>
<td>nonce(String)</td>
<td colspan="2"></td>
</tr>
<tr>
<td>参数</td>
<td>timestamp(String)</td>
<td colspan="2"></td>
</tr>
</table>
<h3 data-id="api_common__setOpts">
setOpts
</h3>
<p>设置HTTP请求的参数<br />Examples:</p><pre><code>// 设定超时为15秒
var token = api.setOpts({
timeout: 15000
});
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">API.prototype.setOpts()</td>
</tr>
<tr>
<td>参数</td>
<td>obj(Object)</td>
<td colspan="2"><p>请求的配置参数</p></td>
</tr>
</table>
<h3 data-id="api_common_API_mixin">
mixin
</h3>
<p>用于支持对象合并。将对象合并到API.prototype上，使得能够支持扩展<br />Examples:</p><pre><code>// 加入发送短信的模块
API.mixin(require('./lib/api_sms'));
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">API.mixin()</td>
</tr>
<tr>
<td>参数</td>
<td>obj(Object)</td>
<td colspan="2"><p>要合并的对象</p></td>
</tr>
</table>
</section>
<section id="api_api_sms" class="api">
<h2>api_sms: API索引</h2>
<ul class="indexs">
<li>
<a href="#api_sms_exports_send_sms">send_sms</a>
</li>
</ul>
<hr />
<h3 data-id="api_sms_exports_send_sms">
send_sms
</h3>
<p>发送短信<br /><a href="http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.a90QvS&apiId=25450">http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.a90QvS&apiId=25450</a><br />举例:</p><pre><code>// 发送短信
var ret = yield api.send_sms(args);
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.send_sms()</td>
</tr>
<tr>
<td>参数</td>
<td>args(Object)</td>
<td colspan="2"><p>请求的参数（必填）</p></td>
</tr>
</table>
</section>
<section id="api_api_tts_singlecall" class="api">
<h2>api_tts_singlecall: API索引</h2>
<ul class="indexs">
<li>
<a href="#api_tts_singlecall_exports_tts_singlecall">tts_singlecall</a>
</li>
</ul>
<hr />
<h3 data-id="api_tts_singlecall_exports_tts_singlecall">
tts_singlecall
</h3>
<p>文本转语音通知<br /><a href="http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.F0x8qp&apiId=25444">http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.F0x8qp&apiId=25444</a><br />举例:</p><pre><code>// 文本转语音通知
var flag = yield api.tts_singlecall(args);
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.tts_singlecall()</td>
</tr>
<tr>
<td>参数</td>
<td>args(Object)</td>
<td colspan="2"><p>请求的参数（必填）</p></td>
</tr>
</table>
</section>
<section id="api_api_voice_doublecall" class="api">
<h2>api_voice_doublecall: API索引</h2>
<ul class="indexs">
<li>
<a href="#api_voice_doublecall_exports_voice_doublecall">voice_doublecall</a>
</li>
</ul>
<hr />
<h3 data-id="api_voice_doublecall_exports_voice_doublecall">
voice_doublecall
</h3>
<p>语音双呼<br /><a href="http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.56MDBW&apiId=25443">http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.56MDBW&apiId=25443</a><br />举例:</p><pre><code>// 语音双呼
var flag = yield api.voice_doublecall(args);
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.voice_doublecall()</td>
</tr>
<tr>
<td>参数</td>
<td>args(Object)</td>
<td colspan="2"><p>请求的参数（必填）</p></td>
</tr>
</table>
</section>
<section id="api_api_voice_singlecall" class="api">
<h2>api_voice_singlecall: API索引</h2>
<ul class="indexs">
<li>
<a href="#api_voice_singlecall_exports_voice_singlecall">voice_singlecall</a>
</li>
</ul>
<hr />
<h3 data-id="api_voice_singlecall_exports_voice_singlecall">
voice_singlecall
</h3>
<p>语音通知<br /><a href="http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.gZWjRM&apiId=25445">http://open.taobao.com/doc2/apiDetail?spm=0.0.0.0.gZWjRM&apiId=25445</a><br />举例:</p><pre><code>// 语音通知
var flag = yield api.voice_singlecall(args);
</code></pre>
<p>方法签名</p>
<table class="table table-striped table-bordered table-hover table-condensed">
<tr>
<td>方法</td>
<td colspan="3">exports.voice_singlecall()</td>
</tr>
<tr>
<td>参数</td>
<td>args(Object)</td>
<td colspan="2"><p>请求的参数（必填）</p></td>
</tr>
</table>
</section>
<section id="api_util" class="api">
<h2>util: API索引</h2>
<ul class="indexs">
</ul>
<hr />
</section>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>此文档通过doxmate生成。主题借鉴Bootstrap API文档风格，注解基于<a href="https://github.com/visionmedia/dox">Dox</a>。欢迎关注doxmate作者<a href="http://weibo.com/shyvo" target="_blank">@朴灵</a></p>
<ul class="footer-links">
<li><a href="https://github.com/visionmedia/dox">Dox主页</a></li>
<li><a href="http://html5ify.com/doxmate">Doxmate主页</a></li>
<li><a href="https://github.com/JacksonTian/doxmate">Doxmate源码</a></li>
<li><a href="https://github.com/JacksonTian/doxmate/issues?state=open">提交bug</a></li>
</ul>
</div>
</footer>
<script>
$(function() {
$('pre').addClass('prettyprint');
$('td pre').removeClass('prettyprint');
prettyPrint();
var $window = $(window);
var sidenav = $('.bs-docs-sidenav');
if (sidenav.height() < window.innerHeight) {
sidenav.affix({
offset: {
top: function () {
return $window.width() <= 980 ? 290 : 210
},
bottom: 200
}
});
} else {
sidenav.removeClass('affix');
}
$(".content").find('h1, h2, h3, h4, h5, h6').each(function () {
var node = $(this);
// 总是设置id
node.attr("id", node.data('id') || "index_" + node.text());
});
$('.bs-docs-sidenav .accordion-marker').on('click', function(event) {
var current = $(event.currentTarget);
current.find('.glyphicon').toggleClass('glyphicon-chevron-right glyphicon-chevron-down');
});
});
</script>
</body>
</html>