__kindeditor_temp_url__短信接口（http协议）

一、单条短信发送（黑名单等拦截错误实时返回）

地址：http://124.220.173.171:9511/api/send-sms-single

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
mobile手机号176xxxxxxxxx(隐私计算版网关,支持传md5值)是
content短信内容【测试】验证码123是
signature签名（和密码二选一即可，点击查看签名算法）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
ext扩展号123否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
msg_id消息id，用来获取状态报告时候匹配是哪条消息，成功返回17
data失败有返回，详情见错误表WL:NMLJ

二、批量短信发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://124.220.173.171:9511/api/send-sms-batch

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
mobiles手机号176xxxxxxxxx,171xxxxxxxxx是
content短信内容【测试】验证码123是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
ext扩展号123否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
msg_id消息id，用来获取状态报告时候匹配是哪条消息，批量发送的时候msg_id和该批次中的手机号形成唯一标志，成功返回17
failed_data发送号码中失败的号码对应的错误码，全部成功则为空数组["15651453123":"WL:CWHM"]

三、变量短信发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://124.220.173.171:9511/api/send-variable

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
params变量参数，多条短信以英文;分割，多个变量之间以英文,分割，变量前带上手机号176xxxxxxxxx,822233;175xxxxxxxxx,656552是
content短信内容【测试】验证码${Text}是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
ext扩展号123否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
msg_id消息id，用来获取状态报告时候匹配是哪条消息，批量发送的时候msg_id和该批次中的手机号形成唯一标志，成功返回17
failed_data发送号码中失败的号码对应的错误码，全部成功则为空数组["15651453123":"WL:CWHM"]

四、一对一批量发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://124.220.173.171:9511//api/send-biunique

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
params一对一参数，json格式key是手机号，value是内容{"17655555555":"测试111","17666666666":"测试222"}是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
ext扩展号123否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
msg_id消息id，用来获取状态报告时候匹配是哪条消息，批量发送的时候msg_id和该批次中的手机号形成唯一标志，成功返回17
failed_data发送号码中失败的号码对应的错误码，全部成功则为空数组["17655555555":"WL:CWHM"]

五、获取状态报告(每条短信状态仅可获取一次)

地址：http://124.220.173.171:9511/api/report

请求方式：GET 返回值：JSON

运营商返回某条短信状态后，此接口就能拉取到，之后调用此接口将不会返回此条短信的状态，所以调用者拉到数据后需要根据 手机号+msg_id 将状态存在本地

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data扩展号,调用发送接口返回的msg_id,手机号,状态,时间,售价 字段以,分隔 多条记录以|分隔123,2,1762532xxxx,DELIVRD,2021-12-23 01:02:03,0.2|123,2,17862532xxxx,DELIVRD,2021-12-23 01:02:03,0.1

六、推送状态报告(每条短信仅推送一次)

注意事项：推送的是utf8原始字节流

推送格式：扩展号,调用发送接口返回的msg_id,手机号,状态,时间,售价 字段以,分隔 多条记录以|分隔

内容示范：123,2,1762532xxxx,DELIVRD,2021-12-23 01:02:03,0.2|123,2,17862532xxxx,DELIVRD,2021-12-23 01:02:03,0.1

七、获取用户上行回复(比如退订等，每条短信状态仅可获取一次)

地址：http://124.220.173.171:9511/api/get-reply

请求方式：GET 返回值：JSON

手机回复上行后，此接口就能拉取到上行数据，每个上行数据只能拉取到一次，所以调用者拉到上行后，需要将上行的内容存在本地，然后自行根据 msg_id,手机号 等信息匹配具体哪条短信产生的上行回复

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
dataurlencode后的内容,手机号,调用发送接口返回的msg_id,扩展号,时间 字段以,分隔多条记录以|分隔TD,158114xxxx,100000006,048842426601,20220325123304|退订,1891456xxxx,100000007,0615,20211115173903

八、推送用户上行回复(每条上行回复仅推送一次)

注意事项：推送的是utf8原始字节流

推送格式：urlencode后的内容,手机号,扩展号,时间 字段以,分隔多条记录以|分隔

内容示范：TD,158114xxxx,048842426601,20220325123304|退订,1891456xxxx,0615,20211115173903


九、获取余额

地址：http://124.220.173.171:9511/api/balance

请求方式：GET 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data余额{"balance": "99999.89"}

十、模板报备

地址：http://124.220.173.171:9511/api/add-template

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
template模板内容【测试】您的验证码是%不要告诉他人是

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data模板id{"temp_id":123456}

十一、获取模板审核状态

地址：http://124.220.173.171:9511/api/get-template-status

请求方式：GET 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
temp_id模板id123456是

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data"0"待审核 "1"审核通过 "2"被驳回{status: "1"}}

十二、签名报备

地址：http://124.220.173.171:9511/api/add-sign

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
sign签名内容【测试签名2】是

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data签名id{"sign_id": 285229}

十一、获取签名审核状态

地址：http://124.220.173.171:9511/api/get-sign-status

请求方式：GET 返回值：JSON

参数

参数名参数介绍示例必填
sp_id产品sp_id666666是
signature签名（和密码二选一即可）a92569901189f2574effc957c096c432e2d47635否
password密码（和签名二选一即可）,通过sp_id的密码进行md5处理666666否
sign_id签名id285229是

返回值

参数名参数介绍示例
code详情见错误表0
msg成功-success 错误-其他提示success
data是否通过审核 "0"待审核 "1"审核通过 "2"审核未通过{status: "1"}}


错误码（code）

错误码说明
10000服务出错，请稍后再试
10001参数错误，请确认
10008账号被锁定，请联系管理员确认
10011余额不足，请尽快充值
10100签名校验失败
10101您的ip不在白名单内，请确认
10102密码错误，请确认
10200产品sp_id必须填写
10201手机号必须填写
10202短信内容必须填写
10203发送时间格式必须为UNIX时间戳
10208短信进拦截，具体原因参考data字段
10209触发防刷，请调整配置

错误码（data）

错误码说明
WL:MBLJ短信内容匹配到了模板，并且此模板类型是拦截
WL:MBSH命中审核模板
WL:NMLJ短信内容没有匹配到模板，并且用户的模板审核方式是未匹配到就进拦截
WL:NMSH短信内容没有匹配到模板，并且用户的模板审核方式是未匹配到就进审核
WL:KHLJ命中空号，进拦截
WL:QHLJ命中用户签名黑名单，进拦截
WL:SHLJ命中用户SPID黑名单，进拦截
WL:CHLJ命中系统产品黑名单，进拦截
WL:CWHM错误号码
WL:QWBB签名未报备，进拦截
WL:MQM需要签名但没有，进拦截
WL:CS超过限速了
WL:ZJLJ不匹配任何模板，直接拦截
WL:CMT产品未配置相应通道，进拦截
WL:CDQC通道不支持该地区发送，进拦截
WL:CGMT产品通道池中没有相应通道，进拦截
WL:CNH所选的通道不健康，进拦截
WL:TCLJ不在发送时间段，进拦截
WL:TCSH不在发送时间段，进审核
WL:CPL超频限制

签名生成规则

第一步：准备QueryString
  1. 将所有参数（除了signature）按照key排序（顺序）
  2. 将排序好的参数key和值进行URLEncode，之后再增加三种字符替换：加号（+）替换成 %20、星号（*）替换成 %2A、%7E 替换回波浪号（~）
  3. 将格式化后的key和值按照key + "=" + 值进行拼接成字符串QueryString，多个参数间用&连接，例：”a=%E5%93%88%E5%93%88&b=haha”
  4. 在上一步得到的QueryString前拼接上请求方式，生成新的QueryString，HTTPMethod + "&" + URLEncode("/") + "&" + QueryString
第二步：准备signature
  1. 将上面得到的QueryString进行HmacSHA1算法进行编码，HMAC生成信息摘时需要用您的产品密码作为密钥。
  2. 之后将上面加编码后的字符串进行base64编码，得到签名signature
    注意：本文档的所有接口都不支持 curl的100 continue协议，如果接口响应过慢就关闭此协议，在Curl中加入curl_setopt($ch, CURLOPT_HTTPHEADER, array("Expect:"))即可
下载php demo
下载java demo

第三方短信接口请联系客服确认

开发者文档