发送实时提醒
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>给指定喵码发送实时送达的提醒通知。</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://miaotixing.com/trigger</code></li>
<li><code>https://miaotixing.com/trigger</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>GET </li>
<li>POST </li>
</ul>
<h5>参数</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
<th style="text-align: left;">示例</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>喵码。指定向哪个提醒单发出提醒，一个提醒单对应一个喵码。</td>
<td style="text-align: left;">tDS0Se9</td>
</tr>
<tr>
<td style="text-align: left;">text</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>动态内容。收到的提醒时，会在标题换行后显示该内容，默认为空。</td>
<td style="text-align: left;">程序故障，错误号404</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>返回内容格式，可选值<code>json</code>或<code>jsonp</code>。为json时返回json格式数据；为jsonp时返回jsonp格式数据；默认为空，即返回文字描述信息。</td>
<td style="text-align: left;">json</td>
</tr>
<tr>
<td style="text-align: left;">callback</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>当type为jsonp时，callback可指定回调函数名；默认为miaotixing_jsonpcallback。</td>
<td style="text-align: left;">mycallback</td>
</tr>
<tr>
<td style="text-align: left;">ts</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">uint</td>
<td>请求时的10位数时间戳，单位：秒。传入该参数时，喵提醒将检查当前时间与时间戳相差值，如果相差超过60秒则拒绝请求。不传该参数时不做时间检查。</td>
<td style="text-align: left;">1615865402</td>
</tr>
<tr>
<td style="text-align: left;">templ</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>套用定制模板参数。传入该值时，喵提醒将检查定制模板与参数格式是否匹配，匹配成功后将用定制模板内容取代原提醒内容，详见《定制模板使用方法》。不传该参数时不使用定制模板。</td>
<td style="text-align: left;">prvPe94,10,调试,无响应</td>
</tr>
<tr>
<td style="text-align: left;">app</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>外发产品id。传入该值时，系统将标记本次提醒关联的外发产品，并享受外发产品服务。默认为无关联的外发产品。</td>
<td style="text-align: left;">p123456</td>
</tr>
<tr>
<td style="text-align: left;">option</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>附加选项参数，多个参数之间用逗号隔开。支持以下参数：<br /><code>nosms</code>暂屏蔽短信通知<br /><code>nophonecall</code>暂屏蔽语音电话通知<br /><code>noemail</code>暂屏蔽电子邮件通知</td>
<td style="text-align: left;">nosms,nophonecall</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<p>type为空：</p>
<pre><code>成功</code></pre>
<p>type为<code>json</code>：</p>
<pre><code>{
&quot;code&quot;: 0,
&quot;data&quot;: {
&quot;users&quot;: 3,
&quot;success_sent&quot;: {
&quot;mptext&quot;: 3,
&quot;sms&quot;: 0,
&quot;phonecall&quot;: 0
}
},
&quot;msg&quot;: &quot;完成&quot;
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td style="text-align: left;">见错误码说明。</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">相关结果。</td>
</tr>
<tr>
<td style="text-align: left;">data.users</td>
<td style="text-align: left;">uint</td>
<td style="text-align: left;">成功发送提醒人数，如果提醒共享给了多人，该数字将大于1。</td>
</tr>
<tr>
<td style="text-align: left;">data.success_sent</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">按提醒通知方式统计发送量：<br /><code>mptext</code>公众号提醒数；<br /><code>sms</code>短信提醒数；<br /><code>phonecall</code>语音电话提醒数</td>
</tr>
<tr>
<td style="text-align: left;">data.remaining</td>
<td style="text-align: left;">uint</td>
<td style="text-align: left;">若提醒还在冷却时间内，该参数返回至少需要等多少秒才能发送下一次提醒。</td>
</tr>
<tr>
<td style="text-align: left;">data.warning</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">若提醒过程出现异常，但不影响发出，该参数返回警告信息。</td>
</tr>
<tr>
<td style="text-align: left;">data.warning.templ</td>
<td style="text-align: left;">object</td>
<td style="text-align: left;">若提醒模板使用异常，该参数返回相关警告信息：<br /><code>code</code>错误码，见错误码说明；<br /><code>msg</code>异常描述。</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">执行结果描述。</td>
</tr>
</tbody>
</table>
<h5>错误码说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">错误码</th>
<th style="text-align: left;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">-1</td>
<td style="text-align: left;">提醒失败（未指定原因）。</td>
</tr>
<tr>
<td style="text-align: left;">0</td>
<td style="text-align: left;">提醒成功。</td>
</tr>
<tr>
<td style="text-align: left;">101</td>
<td style="text-align: left;">参数格式有误。</td>
</tr>
<tr>
<td style="text-align: left;">102</td>
<td style="text-align: left;">提醒过于频繁，未过冷却时间，可在返回json的<code>data.remaining</code>获取还需要等多少秒。</td>
</tr>
<tr>
<td style="text-align: left;">103</td>
<td style="text-align: left;">找不到提醒，请检查喵码是否正确。</td>
</tr>
<tr>
<td style="text-align: left;">104</td>
<td style="text-align: left;">提醒已被喵主禁用。</td>
</tr>
<tr>
<td style="text-align: left;">105</td>
<td style="text-align: left;">该提醒的喵主未关注公众号。</td>
</tr>
<tr>
<td style="text-align: left;">106</td>
<td style="text-align: left;">该提醒的喵主账户暂时无法使用。</td>
</tr>
<tr>
<td style="text-align: left;">107</td>
<td style="text-align: left;">未能找到该提醒的喵主。</td>
</tr>
<tr>
<td style="text-align: left;">108</td>
<td style="text-align: left;">该提醒的喵主未完成账号注册。</td>
</tr>
<tr>
<td style="text-align: left;">109</td>
<td style="text-align: left;">同102，但提醒内容会保存到提醒缓冲池服务，1分钟内补发。[VIP]</td>
</tr>
<tr>
<td style="text-align: left;">110</td>
<td style="text-align: left;">时间戳已过期（使用了<code>ts</code>参数并且过期）。</td>
</tr>
<tr>
<td style="text-align: left;">201</td>
<td style="text-align: left;">未能找到提醒模板。</td>
</tr>
<tr>
<td style="text-align: left;">202</td>
<td style="text-align: left;">内容与提醒模板格式不匹配。</td>
</tr>
<tr>
<td style="text-align: left;">203</td>
<td style="text-align: left;">该提醒模板暂停使用。</td>
</tr>
</tbody>
</table>
<h5>注意事项</h5>
<ul>
<li>若喵码所属用户为Lite账号（即未用手机号注册），提醒时<code>text</code>参数会被忽略，但如果使用了定制模板，定制模板生成的内容能正常收到。</li>
</ul>