预订宝/sendRegisterSMS
来自站长百科
sendRegisterSMS概述[ ]
- 接口地址:http://api.yudingbao.net/v1.0/generictools/mobileMessage.ashx?act=sendRegisterSMS
- 动作标识:sendRegisterSMS
- 参数:见参数说明
- 请求方式:GET
- 响应模式:JSON、JSONP、XML
注意:动作标识是大小写敏感的,请养成良好的编码习惯!
特别说明[ ]
本短信接口是完全免费的,且仅提供格式化短信的单条信息发送。要使用本接口必须首先申请实用工具授权,且必须通过官方的人工审核。
参数说明[ ]
参数名称 | 参数类型 | 说明 |
---|---|---|
mobileNumber | string | 接收短信的手机号码。 |
password | string | 要发送给用户的密码明文。密码不得小于6位。 |
title | string | 短信抬头。可以为空。 |
发出的短信实例:[旅易中国]恭喜您成为会员,您的密码是"XXXXXXXX",请妥善保管!
数据格式[ ]
- 响应头:
- Status:0为正常,非0表示处理请求时发生异常,通常是参数校验错误;
- Messages:当Status为非0时该字段肯定包含一条或多条消息文本;
- 响应体:
- ResponseBody:所发送的短信的完整内容。
对于数据格式的理解,请参考下列示例代码中的XML响应演示,其中每个字段都标注了数据类型(日期类型在XML响应中统一使用GMT格式,但被标注为string,请开发者注意)。
示例代码[ ]
以下示例代码是通过HTML表单实现了该接口的部分操作,您在开发过程中应当使用自己的平台语言来模拟这些操作以捕获响应体,然后对响应体做出相应的操作。
请求示例
<!--请求示例,该接口的访问类同于如下表单的提交,请留意URL中的"act"参数--> <form id="myForm" method="get" action="http://api.yudingbao.net/v1.0/generictools/mobileMessage.ashx" target="_blank"> <p> <input id="act" name="act" value="sendRegisterSMS" type="text" /> </p> <p> <input id="mobileNumber" name="mobileNumber" value="13000000000" type="text"> <input id="password" name="password" value="12345678" type="text"> <input id="title" name="title" value="[旅易中国]" type="text"> </p> <p> <!--指定响应格式为XML,这里以XML为例--> <input id="format" name="format" value="xml" type="text" /> <!--指定响应体应当是已格式化的,便于阅读代码,在生产环境中应当将该值设置为false--> <input id="indent" name="indent" value="true" type="text" /> <!--产品编号。在我的账户-分销产品的应用列表中可以找到该参数的值。--> <input id="aid" name="aid" value="78663" type="text" /> <!--接口密钥。在我的账户-分销产品的应用列表中可以找到该参数的值。--> <input id="key" name="key" value="f9308fe421092586ff7897bc26d9b88178e5607195c9a8df6c2a226c6589fa1b" type="text" /> <!--应用程序授权编号及公钥,这是可选的--> <input id="sid" name="sid" value="" type="text"> <input id="sKey" name="sKey" value="" type="text"> </p> <p> <input id="submit" name="submit" value="提交" type="submit"> </p> </form>
XML响应
<!--XML响应--> <!--XML响应--> <?xml version="1.0" encoding="utf-8"?> <HttpResponse> <Status type="number">0</Status> <Messages type="array"> <item type="string">发送成功!</item> </Messages> <ResponseBody>[旅易中国] 恭喜您成为会员,您的密码是"12345678",请妥善保管!</ResponseBody> </HttpResponse>
JSON响应
// Json响应 { "Status" : 0, "Messages" : ["发送成功!"], "ResponseBody" : "[旅易中国] 恭喜您成为会员,您的密码是\"12345678\",请妥善保管!" }
JSONP响应
// JsonP响应 jsoncallback({ "Status" : 0, "Messages" : ["发送成功!"], "ResponseBody" : "[旅易中国] 恭喜您成为会员,您的密码是\"12345678\",请妥善保管!" });