短信接口

温馨提示：本文最后更新于2024年7月7日 20:03，若内容或图片失效，请在下方留言或联系博主。

请求方式/编码：GET / UTF-8

模板发信API接口：

请求地址：

https://console.smshui.com/sendTemplate

请求示例：

https://console.smshui.com/sendTemplate?channel=Channel_2023102610892&username=admin&key=22df05de3dc300f3e2bf783f6e8c5e96&phone=18888888888&template=Template_2023102610761&param={"name":"admin","code":"123455","goods":"鞋子","order":"20230101123"}&send_type=1&send_time=2024-05-20 13:14

参数名	参数值	是否必填	参数类型	描述说明
channel	Channel_2023102610892	否	String	指定通道ID（Channel开头的）（如果不填，则为系统设置的默认通道进行发信）
username	admin	是	String	您的用户名
key	22df05de3dc300f3e2bf783f6e8c5e96	是	String	用户密钥（Secret Key） MD5后的值(32位，不区分大小写)
phone	18888888888	是	String	手机号（多个手机号请用英文下的逗号（,）隔开，如：18888888888,17777777777）
template	Template_2023102610761	是	String	模板ID
param	{"name":"admin","code":"123455","goods":"鞋子","order":"20230101123"}	是	String	短信模板变量对应的实际值，支持传入多个参数（如：尊敬的用户：{name}，您的验证码：{code}，商品：{goods}，订单号：{order}，最终发出的则是尊敬的用户：admin，您的验证码：123455，商品：鞋子，订单号：20230101123 ）
send_type	1	是	String	发送方式 1立即发送 2定时发送不传默认为1
send_time	2024-05-20 13:14	是	String	发送时间格式：YYYY-MM-DD HH:mm

响应示例

成功 (1)

{
 "code": 1, //状态码 1为成功，0为失败
 "msg": "全部短信发送成功", //返回文字描述
 "success_data": [
 {
 "phone": "18888888888", //手机号
 "sms_code": "Sms_2023102615686" //短信ID
},
{
 "phone": "17777777777", //手机号
 "sms_code": "Sms_2023102615333" //短信ID
}
 ] //短信数据
}

参数名	参数值	是否必填	参数类型	描述说明
code	1	是	Integer	状态码 1为成功，0为失败
msg	全部短信发送成功	是	String	返回文字描述
success_data		是	Array	短信数据
success_data.phone	18888888888	是	String	手机号
success_data.sms_code	Sms_2023102615686	是	String	短信ID

失败 (0)

{
"code": 0, //状态码 1为成功，0为失败
"msg": "用户Secret Key错误" //返回文字描述
}

参数名	参数值	是否必填	参数类型	描述说明
code	0	是	String	状态码 1为成功，0为失败
msg	该平台账户不存在	是	String	返回文字描述

官方发信API接口：

请求地址：https://console.smshui.com/sendApi

请求示例：

https://console.smshui.com/sendApi?channel=Channel_2024042010563&username=admin&key=22df05de3dc300f3e2bf783f6e8c5e96&phone=13888888888&content=【短信汇】您的验证码是1234，请勿泄露&send_type=1&send_time=2024-04-20 20:38

请求参数：

参数名	参数值	是否必填	数据类型	描述说明
channel	Channel_2024042010563	否	String	通道ID(不填则使用默认通道)
username	admin	是	String	用户名
key	22df05de3dc300f3e2bf783f6e8c5e96	是	String	密钥（MD5后的值，32位，不区分大小写）
phone	13888888888	是	String	手机号（多个手机号用,隔开）
content	【短信汇】您的验证码是1234，请勿泄露	是	String	短信内容（需要带签名）
send_type	1	是	String	发信方式 1：立即发送，2：定时发送，默认1
send_time	2024-04-20 20:38	是	String	发送时间格式：YYYY-MM-DD HH:mm

响应示例：

成功(1)

{
    "code": 1, //状态码 1为成功，0为失败
    "msg": "全部短信发送成功", //返回文字描述
    "success_data": [
        {
          "phone": "18888888888", //手机号
           "sms_code": "Sms_2023102615686" //短信ID
             },
            {
          "phone": "17777777777", //手机号
          "sms_code": "Sms_2023102615333" //短信ID
              }
    ] //短信数据
}

参数名	参数值	是否必填	参数类型	描述说明
code	1	是	Integer	状态码 1为成功，0为失败
msg	全部短信发送成功	是	String	返回文字描述
success_data		是	Array	短信数据
success_data.phone	13888888888	是	String	手机号
success_data.sms_code	Sms_2023102615686	是	String	短信ID

失败(0)

{
"code": 0, //状态码 1为成功，0为失败
"msg": "用户Secret Key错误" //返回文字描述
}

参数名	参数值	是否必填	参数类型	描述说明
code	0	是	String	状态码 1为成功，0为失败
msg	该平台账户不存在	是	String	返回文字描述