运之盟开放平台-内部


发送短信

<p><strong>简要描述:</strong> </p> <ul> <li>短信-发送短信</li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>API地址: <a href="https://open-beta.56yzm.com:8443">https://open-beta.56yzm.com:8443</a> (不同的环境,不同的API地址)</li> <li>请求地址:/open-api/message/sendSms</li> </ul> <p><strong>请求头数据 </strong></p> <ul> <li>Content-Type : application/json;charset=UTF-8 </li> <li>Authorization: Bearer {your_access_token} </li> </ul> <p><strong>入参参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>租户appid</td> <td>8879981</td> </tr> <tr> <td style="text-align: left;">scenesCode</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>场景代码</td> <td>YZM_SMS_CONTRACT_SIGN</td> </tr> <tr> <td style="text-align: left;">userId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>用户编号</td> <td>7e51c7b95fe2f70330b111df8d0ac04e</td> </tr> <tr> <td style="text-align: left;">msgInfos</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Object</td> <td>短信对象</td> <td>/</td> </tr> </tbody> </table> <p><strong>入参参数msgInfos说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>手机号</td> <td>15966661234</td> </tr> <tr> <td style="text-align: left;">contentParam</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Array&lt;String&gt;</td> <td>发送内容</td> <td><a href="https://img.56yzm.com/freight/contract/tenant/qhy/index-dev-new.html?contractNum=F5A728BB301B5102">https://img.56yzm.com/freight/contract/tenant/qhy/index-dev-new.html?contractNum=F5A728BB301B5102</a></td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>发送内容</td> <td>短信内容</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>短信签名</td> <td>湖北我家物流服务有限公司</td> </tr> <tr> <td style="text-align: left;">isRecord</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>是否需要入库(1是,0否)</td> <td>0</td> </tr> <tr> <td style="text-align: left;">isHiddenCode</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>入库隐藏验证码(1是,0否)</td> <td>0</td> </tr> <tr> <td style="text-align: left;">envId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>农机短信回执标识</td> <td>农机短信回执标识</td> </tr> </tbody> </table> <p><strong>入参示例</strong></p> <pre><code>{ &amp;quot;appId&amp;quot;: &amp;quot;44549625&amp;quot;, &amp;quot;msgInfos&amp;quot;: [ { &amp;quot;contentParam&amp;quot;: [ &amp;quot;https://img.56yzm.com/freight/contract/tenant/qhy/index-dev-new.html?contractNum=F5A728BB301B5102&amp;quot; ], &amp;quot;isRecord&amp;quot;: 0, &amp;quot;mobile&amp;quot;: &amp;quot;15966661234&amp;quot;, &amp;quot;title&amp;quot;: &amp;quot;湖北我家物流服务有限公司&amp;quot; } ], &amp;quot;scenesCode&amp;quot;: &amp;quot;YZM_SMS_CONTRACT_SIGN&amp;quot;, &amp;quot;userId&amp;quot;: &amp;quot;7e51c7b95fe2f70330b349df8d0ac04e&amp;quot; }</code></pre> <p><strong>返回参数说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">smsRecordDomainList</td> <td style="text-align: left;">Array&lt;Object&gt;</td> <td>发送记录</td> <td>/</td> </tr> <tr> <td style="text-align: left;">successCount</td> <td style="text-align: left;">Integer</td> <td>成功条数</td> <td>100</td> </tr> </tbody> </table> <p><strong>返回参数SmsRecordDomain说明</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> <th>示例</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">phone</td> <td style="text-align: left;">String</td> <td>手机号</td> <td>15966661234</td> </tr> <tr> <td style="text-align: left;">sendId</td> <td style="text-align: left;">String</td> <td>短信发送成功id</td> <td>9001254</td> </tr> <tr> <td style="text-align: left;">envId</td> <td style="text-align: left;">String</td> <td>唯一码</td> <td>813F1Z4482</td> </tr> </tbody> </table> <p><strong>出参示例</strong></p> <pre><code>{ &amp;quot;smsRecordDomainList&amp;quot;: [ { &amp;quot;envId&amp;quot;: &amp;quot;813F1Z4482&amp;quot;, &amp;quot;phone&amp;quot;: &amp;quot;15966661234&amp;quot;, &amp;quot;sendId&amp;quot;: &amp;quot;9001254&amp;quot; } ], &amp;quot;successCount&amp;quot;: 2 }</code></pre>

页面列表

ITEM_HTML