www.gusucode.com > baigo CMS PHP开源网站管理系统 v1.2.2源码程序 > baigocms_v1.2.2/bg_sso/core/lang/zh_CN/help/api/pm.php
<?php
return "<a name=\"top\"></a>
<ul class=\"list-inline\">
<li>
<a href=\"#send\">发送短信</a>
</li>
<li>
<a href=\"#check\">检查未读短信</a>
</li>
<li>
<a href=\"#list\">列出短信</a>
</li>
<li>
<a href=\"#read\">读取短信</a>
</li>
<li>
<a href=\"#status\">更改短信状态</a>
</li>
<li>
<a href=\"#rev\">撤回短信</a>
</li>
<li>
<a href=\"#del\">删除短信</a>
</li>
</ul>
<p> </p>
<a name=\"send\"></a>
<h3>发送短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于向指定用户发送站内短信。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>POST</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_post</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 send。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为发送者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_to</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接收者用户名，多个接收者请用 <kbd>|</kbd> 分隔。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_title</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>短信标题</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_content</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>短信内容</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<p>
本接口返回加密字符串，真正内容需要调用密文接口进行解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。
</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">code</td>
<td class=\"text-nowrap\">string</td>
<td>加密字符串，需要解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">key</td>
<td class=\"text-nowrap\">string</td>
<td>解密码，配合加密字符串使用，用于解码。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">解密后的结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">Base64</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">pm_id</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>短信 ID</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_to</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>接收者用户 ID</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"pm_id": "MTA=" //短信 ID
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"check\"></a>
<h3>检查未读短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于检查是否有未读短信</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>GET</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_get</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 check。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为接收者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_count</td>
<td class=\"text-nowrap\">int</td>
<td>未读短信数</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"pm_count": "MTA=" //未读短信数
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"list\"></a>
<h3>列出短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于列出当前用户的所有短信。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>GET</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_get</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 list。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为接收者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_type</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>短信类型，in（收件箱）、out（已发送）。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_status</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>短信状态，wait（未读）、read（已读）。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_ids</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">false</td>
<td>短信 ID，多个 ID 请用 <kbd>|</kbd> 分隔。</td>
</tr>
<tr>
<td class=\"text-nowrap\">per_page</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">false</td>
<td>每页列出短信数。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<p>
本接口返回加密字符串，真正内容需要调用密文接口进行解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。
</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">code</td>
<td class=\"text-nowrap\">string</td>
<td>加密字符串，需要解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">key</td>
<td class=\"text-nowrap\">string</td>
<td>解密码，配合加密字符串使用，用于解码。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">解密后的结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">键名</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">说明</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">pmRows</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">短信列表</td>
<td>符合搜索条件的所有短信。详情请查看 <a href=\"#read\">读取短信返回结果</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pageRow</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">分页参数</td>
<td>详情请查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=page\" target=\"_blank\">分页参数</a>。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"read\"></a>
<h3>读取短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于读取已注册用户的信息。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>GET</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_get</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 read。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为发送者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>短信 ID</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<p>
本接口返回加密字符串，真正内容需要调用密文接口进行解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。
</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">code</td>
<td class=\"text-nowrap\">string</td>
<td>加密字符串，需要解密。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">key</td>
<td class=\"text-nowrap\">string</td>
<td>解密码，配合加密字符串使用，用于解码。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=code#decode\">密文接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">解密后的结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">Base64</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">pm_id</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>短信 ID</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_send_id</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>已发送短信 ID，此字段只有已发送短信具备，用来定义发出的短信 ID。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_title</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">string</td>
<td>标题</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_content</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">string</td>
<td>内容</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_from</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>发送者用户 ID</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_to</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>接收者用户 ID</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_status</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">string</td>
<td>短信状态，可能的值为 wait（未读）、read（已读）。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_time</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">int</td>
<td>发送时间，UNIX 时间戳。</td>
</tr>
<tr>
<td class=\"text-nowrap\">fromUser</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">array</td>
<td>发送者用户信息，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=user#read\">用户接口</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">toUser</td>
<td class=\"text-nowrap\">true</td>
<td class=\"text-nowrap\">array</td>
<td>接收者用户信息，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=user#read\">用户接口</a>。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"pm_id": "MTA=", //短信 ID
"pm_title": "Zm9uZQ==", //标题
"pm_content": "Zm9uZUBiYWlnby5uZXQ=", //内容
"pm_from": "MTQ0NjUyNTM1MA==", //发送者用户 ID
"pm_to": "Zm9uZQ==", //接收者用户 ID
"pm_status": "MTIxLjE5OS4xMS4xNjM=" //短信状态
"pm_time": "MTM5NDQxNzg3Mg==", //发送时间
"fromUser": { //发送者用户信息
"user_id": "MTA="
"user_name": "MTA="
},
"toUser": { //接收者用户信息
"user_id": "MTA="
"user_name": "MTA="
},
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"status\"></a>
<h3>更改短信状态</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于更改短信的阅读状态。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>POST</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_post</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 status。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为接收者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_ids</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">true</td>
<td>准备更改状态的短信 ID 数组</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_status</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>准备更改的短信状态，wait（未读）、read（已读）。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"alert": "y110103" //返回代码
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"rev\"></a>
<h3>撤回短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于修改已注册用户的邮箱，根据系统的设置，可能需要通过邮件进行验证，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#send\">注册设置</a>。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>POST</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_post</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 rev。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为接收者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_ids</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">true</td>
<td>准备撤回的短信 ID 数组，此处的短信 ID 可从已发送短信的 pm_send_id 字段获得。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"alert": "y110104" //返回代码
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>
<hr>
<p> </p>
<a name=\"del\"></a>
<h3>删除短信</h3>
<p class=\"text-success\">接口说明</p>
<p>本接口用于删除已注册用户。</p>
<p class=\"text-success\">URL</p>
<p><span class=\"text-primary\">http://www.domain.com/api/api.php?mod=pm</span></p>
<p class=\"text-success\">HTTP 请求方式</p>
<p>POST</p>
<p class=\"text-success\">返回格式</p>
<p>JSON</p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">接口参数</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th class=\"text-nowrap\">必须</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">act_post</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>接口调用动作，值只能为 del。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP ID，后台创建应用时生成的 ID。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">app_key</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>应用的 APP KEY，后台创建应用时生成的 KEY。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=app#show\">查看应用</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_id</td>
<td class=\"text-nowrap\">int</td>
<td class=\"text-nowrap\"> </td>
<td rowspan=\"3\">
<p>user_id、user_name、user_mail 三选一，优先级按顺序排列（作为接收者）</p>
<p>其中是否允许邮箱登录，视注册设置情况而定。详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=admin&act_get=opt#reg\">注册设置</a>。</p>
</td>
</tr>
<tr>
<td class=\"text-nowrap\">user_name</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_mail</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\"> </td>
</tr>
<tr>
<td class=\"text-nowrap\">user_access_token</td>
<td class=\"text-nowrap\">string</td>
<td class=\"text-nowrap\">true</td>
<td>访问口令，必须用 <mark>MD5</mark> 加密后传输。</td>
</tr>
<tr>
<td class=\"text-nowrap\">pm_ids</td>
<td class=\"text-nowrap\">array</td>
<td class=\"text-nowrap\">true</td>
<td>准备删除的短信 ID 数组。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<div class=\"panel panel-default\">
<div class=\"panel-heading\">返回结果</div>
<div class=\"table-responsive\">
<table class=\"table table-bordered\">
<thead>
<tr>
<th class=\"text-nowrap\">名称</th>
<th class=\"text-nowrap\">类型</th>
<th>具体描述</th>
</tr>
</thead>
<tbody>
<tr>
<td class=\"text-nowrap\">alert</td>
<td class=\"text-nowrap\">string</td>
<td>返回代码，详情查看 <a href=\"{BG_URL_HELP}ctl.php?mod=api&act_get=alert\">返回代码</a>。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_ver</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本号。</td>
</tr>
<tr>
<td class=\"text-nowrap\">prd_sso_pub</td>
<td class=\"text-nowrap\">string</td>
<td>baigo SSO 版本发布时间，格式为年月日。</td>
</tr>
</tbody>
</table>
</div>
</div>
<p> </p>
<h4>返回结果示例</h4>
<p>
<pre><code class=\"language-javascript\">{
"alert": "y110104" //返回代码
}</code></pre>
</p>
<p> </p>
<div class=\"text-right\">
<a href=\"#top\">
<span class=\"glyphicon glyphicon-chevron-up\"></span>
top
</a>
</div>";