【顺丰快递管家】通用接口文档


统一通知平台接口(新)

<h3>功能描述</h3> <ul> <li>该接口用于:通过短信(邮箱)、电话给用户发送消息。</li> </ul> <h3>接口定义</h3> <table> <thead> <tr> <th style="text-align: center;">服务名称</th> <th style="text-align: center;">批量交易</th> <th style="text-align: center;">接口类型</th> <th style="text-align: center;">接口uri(同确认接口)</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">统一通知平台接口</td> <td style="text-align: center;">支持</td> <td style="text-align: center;">接入/POST</td> <td style="text-align: center;">/public/unp/v2/sendPhoneAndEmailAndCallMessage</td> </tr> </tbody> </table> <h3>元素&lt;请求&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">默认值</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">companyId</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">公司ID</td> <td style="text-align: left;">分配客户sendAppId。</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">channelName</td> <td style="text-align: center;">Number(1)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">渠道名称:1:短信或邮件,3:电话外呼。</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">userId</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">短信接收人</td> <td style="text-align: left;">手机号码或者邮箱,并使用3des加密,《接入前必看-3.3Des加解密密工具类》</td> </tr> <tr> <td style="text-align: center;">4</td> <td style="text-align: center;">templateCode</td> <td style="text-align: center;">String(100)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">短信模板编号</td> <td style="text-align: left;">见附件说明</td> </tr> <tr> <td style="text-align: center;">5</td> <td style="text-align: center;">templateParam</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">模板参数</td> <td style="text-align: left;">具体见附件</td> </tr> </tbody> </table> <h3>元素&lt;响应&gt;</h3> <ul> <li><strong>主体</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">msg</td> <td style="text-align: center;">String(200)</td> <td style="text-align: center;">否</td> <td style="text-align: center;">信息</td> <td style="text-align: left;">提示信息</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">succ</td> <td style="text-align: center;">String(10)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码</td> <td style="text-align: left;">返回成功或失败信息(ok/fail)</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">result</td> <td style="text-align: center;">Object</td> <td style="text-align: center;">是</td> <td style="text-align: center;">返回详细信息</td> </tr> </tbody> </table> <ul> <li><strong>result 说明</strong></li> </ul> <table> <thead> <tr> <th style="text-align: center;">序号</th> <th style="text-align: center;">字段名</th> <th style="text-align: center;">类型(约束)</th> <th style="text-align: center;">必填</th> <th style="text-align: center;">字段说明</th> <th style="text-align: left;">描述</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">1</td> <td style="text-align: center;">success</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">状态码</td> <td style="text-align: left;">true-成功,false-失败</td> </tr> <tr> <td style="text-align: center;">2</td> <td style="text-align: center;">errorMessage</td> <td style="text-align: center;">String(1000)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">返回错误信息</td> </tr> <tr> <td style="text-align: center;">3</td> <td style="text-align: center;">date</td> <td style="text-align: center;">String(20)</td> <td style="text-align: center;">是</td> <td style="text-align: center;">发送时间</td> <td style="text-align: left;">格式是:&quot;yyyy-MM-dd HH:mm:ss&quot;</td> </tr> </tbody> </table> <h3>报文范例</h3> <ul> <li> <p><strong>请求报文</strong></p> <pre><code>{ &amp;quot;companyId&amp;quot;:201905140011898,     &amp;quot;channelName&amp;quot;: 3,     &amp;quot;userId&amp;quot;: &amp;quot;f4DjQbFxWexwkUiOus3S1Q==&amp;quot;,     &amp;quot;templateCode&amp;quot;: &amp;quot;FA-JIAN-TONG-ZHI-(-MIN-HANG-)&amp;quot;,     &amp;quot;templateParam&amp;quot;: {         &amp;quot;param&amp;quot;: &amp;quot;1234&amp;quot;     } }</code></pre> </li> <li><strong>响应报文</strong> <ul> <li>成功报文 <pre><code>{ &amp;quot;result&amp;quot;: {         &amp;quot;requestId&amp;quot;: &amp;quot;84450fc8e89643acaecb67215a01dfb3&amp;quot;,         &amp;quot;success&amp;quot;: true,         &amp;quot;errorCode&amp;quot;: null,         &amp;quot;errorMessage&amp;quot;: null,         &amp;quot;params&amp;quot;: null,         &amp;quot;date&amp;quot;: &amp;quot;2023-02-27 19:56:24&amp;quot;     },     &amp;quot;succ&amp;quot;: &amp;quot;ok&amp;quot;,     &amp;quot;msg&amp;quot;: &amp;quot;发送成功&amp;quot; }</code></pre></li> <li>失败报文-范例1 <pre><code>{ &amp;quot;result&amp;quot;: null,     &amp;quot;succ&amp;quot;: &amp;quot;fail&amp;quot;,     &amp;quot;msg&amp;quot;: &amp;quot;请先联系下管理员配置下通知模板!&amp;quot; }</code></pre></li> </ul></li> </ul>

页面列表

ITEM_HTML