317 lines
11 KiB
HTML
Executable File
317 lines
11 KiB
HTML
Executable File
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8" />
|
||
<meta name="robots" content="index, follow, all" />
|
||
<title>Qcloud\Sms\SmsSingleSender | API</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
|
||
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
|
||
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
|
||
<script src="../../js/jquery-1.11.1.min.js"></script>
|
||
<script src="../../js/bootstrap.min.js"></script>
|
||
<script src="../../js/typeahead.min.js"></script>
|
||
<script src="../../sami.js"></script>
|
||
<meta name="MobileOptimized" content="width">
|
||
<meta name="HandheldFriendly" content="true">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
|
||
|
||
|
||
</head>
|
||
|
||
<body id="class" data-name="class:Qcloud_Sms_SmsSingleSender" data-root-path="../../">
|
||
<div id="content">
|
||
<div id="left-column">
|
||
<div id="control-panel">
|
||
<script>
|
||
$('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
|
||
</script>
|
||
<form id="search-form" action="../../search.html" method="GET">
|
||
<span class="glyphicon glyphicon-search"></span>
|
||
<input name="search"
|
||
class="typeahead form-control"
|
||
type="search"
|
||
placeholder="Search">
|
||
</form>
|
||
</div>
|
||
|
||
<div id="api-tree"></div>
|
||
|
||
</div>
|
||
<div id="right-column">
|
||
<nav id="site-nav" class="navbar navbar-default" role="navigation">
|
||
<div class="container-fluid">
|
||
<div class="navbar-header">
|
||
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
|
||
<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">API</a>
|
||
</div>
|
||
<div class="collapse navbar-collapse" id="navbar-elements">
|
||
<ul class="nav navbar-nav">
|
||
<li><a href="../../classes.html">Classes</a></li>
|
||
<li><a href="../../namespaces.html">Namespaces</a></li>
|
||
<li><a href="../../interfaces.html">Interfaces</a></li>
|
||
<li><a href="../../traits.html">Traits</a></li>
|
||
<li><a href="../../doc-index.html">Index</a></li>
|
||
<li><a href="../../search.html">Search</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div class="namespace-breadcrumbs">
|
||
<ol class="breadcrumb">
|
||
<li><span class="label label-default">class</span></li>
|
||
<li><a href="../../Qcloud.html">Qcloud</a></li><li class="backslash">\</li><li><a href="../../Qcloud/Sms.html">Sms</a></li><li class="backslash">\</li><li>SmsSingleSender</li>
|
||
</ol>
|
||
</div>
|
||
<div id="page-content">
|
||
|
||
<div class="page-header">
|
||
<h1>
|
||
SmsSingleSender
|
||
|
||
</h1>
|
||
</div>
|
||
|
||
<p> class
|
||
<strong>SmsSingleSender</strong>
|
||
</p>
|
||
|
||
|
||
|
||
|
||
<div class="description">
|
||
<p>单发短信类</p> </div>
|
||
|
||
|
||
|
||
|
||
<h2>Methods</h2>
|
||
|
||
<div class="container-fluid underlined">
|
||
<div class="row">
|
||
<div class="col-md-2 type">
|
||
|
||
</div>
|
||
<div class="col-md-8 type">
|
||
<a href="#method___construct">__construct</a>(string $appid, string $appkey)
|
||
|
||
<p>构造函数</p> </div>
|
||
<div class="col-md-2"></div>
|
||
</div>
|
||
<div class="row">
|
||
<div class="col-md-2 type">
|
||
string
|
||
</div>
|
||
<div class="col-md-8 type">
|
||
<a href="#method_send">send</a>(int $type, string $nationCode, string $phoneNumber, string $msg, string $extend = "", string $ext = "")
|
||
|
||
<p>普通单发</p> </div>
|
||
<div class="col-md-2"></div>
|
||
</div>
|
||
<div class="row">
|
||
<div class="col-md-2 type">
|
||
string
|
||
</div>
|
||
<div class="col-md-8 type">
|
||
<a href="#method_sendWithParam">sendWithParam</a>(string $nationCode, string $phoneNumber, int $templId = 0, array $params, string $sign = "", string $extend = "", string $ext = "")
|
||
|
||
<p>指定模板单发</p> </div>
|
||
<div class="col-md-2"></div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<h2>Details</h2>
|
||
|
||
<div id="method-details">
|
||
<div class="method-item">
|
||
<h3 id="method___construct">
|
||
<div class="location">at line 24</div>
|
||
<code>
|
||
<strong>__construct</strong>(string $appid, string $appkey)
|
||
</code>
|
||
</h3>
|
||
<div class="details">
|
||
|
||
|
||
|
||
<div class="method-description">
|
||
<p>构造函数</p> </div>
|
||
<div class="tags">
|
||
<h4>Parameters</h4>
|
||
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$appid</td>
|
||
<td>sdkappid</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$appkey</td>
|
||
<td>sdkappid对应的appkey</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="method-item">
|
||
<h3 id="method_send">
|
||
<div class="location">at line 45</div>
|
||
<code> string
|
||
<strong>send</strong>(int $type, string $nationCode, string $phoneNumber, string $msg, string $extend = "", string $ext = "")
|
||
</code>
|
||
</h3>
|
||
<div class="details">
|
||
|
||
|
||
|
||
<div class="method-description">
|
||
<p>普通单发</p> <p>普通单发需明确指定内容，如果有多个签名，请在内容中以【】的方式添加到信息内容中，否则系统将使用默认签名。</p> </div>
|
||
<div class="tags">
|
||
<h4>Parameters</h4>
|
||
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<td>int</td>
|
||
<td>$type</td>
|
||
<td>短信类型，0 为普通短信，1 营销短信</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$nationCode</td>
|
||
<td>国家码，如 86 为中国</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$phoneNumber</td>
|
||
<td>不带国家码的手机号</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$msg</td>
|
||
<td>信息内容，必须与申请的模板格式一致，否则将返回错误</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$extend</td>
|
||
<td>扩展码，可填空串</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$ext</td>
|
||
<td>服务端原样返回的参数，可填空串</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Return Value</h4>
|
||
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>应答json字符串，详细内容参见腾讯云协议文档</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="method-item">
|
||
<h3 id="method_sendWithParam">
|
||
<div class="location">at line 82</div>
|
||
<code> string
|
||
<strong>sendWithParam</strong>(string $nationCode, string $phoneNumber, int $templId = 0, array $params, string $sign = "", string $extend = "", string $ext = "")
|
||
</code>
|
||
</h3>
|
||
<div class="details">
|
||
|
||
|
||
|
||
<div class="method-description">
|
||
<p>指定模板单发</p> </div>
|
||
<div class="tags">
|
||
<h4>Parameters</h4>
|
||
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$nationCode</td>
|
||
<td>国家码，如 86 为中国</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$phoneNumber</td>
|
||
<td>不带国家码的手机号</td>
|
||
</tr>
|
||
<tr>
|
||
<td>int</td>
|
||
<td>$templId</td>
|
||
<td>模板 id</td>
|
||
</tr>
|
||
<tr>
|
||
<td>array</td>
|
||
<td>$params</td>
|
||
<td>模板参数列表，如模板 {1}...{2}...{3}，那么需要带三个参数</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$sign</td>
|
||
<td>签名，如果填空串，系统会使用默认签名</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$extend</td>
|
||
<td>扩展码，可填空串</td>
|
||
</tr>
|
||
<tr>
|
||
<td>string</td>
|
||
<td>$ext</td>
|
||
<td>服务端原样返回的参数，可填空串</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h4>Return Value</h4>
|
||
|
||
<table class="table table-condensed">
|
||
<tr>
|
||
<td>string</td>
|
||
<td>应答json字符串，详细内容参见腾讯云协议文档</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div id="footer">
|
||
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</body>
|
||
|
||
</html>
|