短信API接口

短信API接口调用教程

调用短信接口
协议 HTTP POST
编码格式 UTF8
URL https://live.kewail.com/sms/v1/sendsinglesms
接口说明 给用户发短信验证码、短信通知,营销短信(内容长度不超过450字)。
注:accesskey请填写您在Kewail上申请到的,random请填成随机数。 2) 请求参数:
参数名称 参数类型 是否必填 说明
accesskey String 是 用户控制台中对应的accesskey
random int 是 随机整数 3) 请求包体:
参数名称 参数类型 是否必填 说明
sig String 是 签名,用于校验用户的合法性;签名用SHA加密,加密的参数顺序为(secretkey=%s&random=%d&time=%d&fromEmail=%s)
time long 是 unix时间
type int 是 0:普通短信;1:营销短信(强调:要按需填值,不然会影响到业务的正常使用)
nationcode int 是 国家码(例如:86)
mobile int 是 手机号码
msg String 是 需要匹配审核通过的模板内容
extend String 否 通道扩展码,可选字段,默认没有开通(需要填空)。
ext String 否 服务端原样返回的参数,可填空 4) 返回值:
名称 类型 返回值
result int 0表示成功(计费依据),非0表示失败错误码
errmsg string 错误的信息,如果是成功则为OK
fee int 短信计费的条数
sid string 标识本次发送id,标识一次短信下发记录
ext string 服务端原样返回的参数3 包体为json字符串及解析
包体为json字符串,参数如下:

"tel": { //如需使用国际电话号码通用格式,如:"+8613788888888" ,请使用sendisms接口见下注
    "nationcode": "86", //国家码
    "mobile": "13788888888" //手机号码
}, 
"type": 0, //0:通知短信;1:营销短信(强调:要按需填值,不然会影响到业务的正常使用)
"msg": "尊敬的客户:您本次的验证码为:123456", //utf8编码 
"sig": "30db206bfd3fea7ef0db929998642c8ea54cc7042a779c5a0d9897358f6e9505", //app凭证,具体计算方式见下注
"time": 1457336869, //unix时间戳,请求发起时间,如果和系统时间相差超过10分钟则会返回失败
"extend": "", //通道扩展码,可选字段,默认没有开通(需要填空)。
 //在短信回复场景中,Kewailserver会原样返回,开发者可依此区分是哪种类型的回复
"ext": "" //用户的session内容,Kewailserver回包中会原样返回,可选字段,不需要就填空。

注: 1、“msg"字段需要匹配审核通过的模板内容
如果您的模板是"尊敬的客户:你的验证码是{1}”,则"msg"字段可赋值为:“尊敬的客户:你的验证码是xxxx”。(其中"xxxx"为下发的验证码) 如果您有多个短信签名,请将需要的短信签名放在短信内容前面 例如您有"【Kewail科技】","【Kewail】“两个签名,但是想以”【Kewail】“签名发送短信, 则"msg"字段可赋值为:”【Kewail】尊敬的客户:你的验证码是xxxx"。(其中"xxxx"为下发的验证码)
2、“extend"字段的配置请联系Kewail短信技术支持
3、sendisms接口,“tel"字段为国际电话号码通用格式,如:”+8613788888888”
4、"sig"字段根据公式sha256(secretkey=KaTeX parse error: Expected 'EOF', got '&' at position 10: accesskey&̲random=random&time=KaTeX parse error: Expected 'EOF', got '&' at position 5: time&̲mobile=mobile)生成。

4 SDK

我们为开发者封装了多个平台的 API 供开发者直接使用,以节省开发时间,点击这里查看。
接入简单快速接入可以参考api文档https://www.kewail.com/doc/index.html#10001

猜你喜欢

转载自blog.csdn.net/weixin_44461088/article/details/86136798