短信业务 ——HTTP接口文档(上海财焱网络科技有限公司)

短信业务 ——HTTP接口文档(上海财焱网络科技有限公司)

1. 用户提交

请求地址:http://sms.51yixun.com:8200/sms/sendBatch

1.1 接口公共参数说明

参数名称 参数类型 是否必须 参数描述
appId String 用户Appid
timestamp String 14位-当前时间戳 格式:yyyyMMddHHmmss
sign String 32位-签名 格式:md5(appId+ secretKey +timestamp)
mobiles String 手机号(多个,用逗号分隔,最多1000个)
content String 短信内容采用utf-8URLEncoder.encode(content, "UTF-8")
schTime String 定时发送时间(选填,定时时间在90天内)格式:yyyyMMddHHmmss 14位 如果不填,则为即时发送
batchId String 自定义消息ID(最长64位)
addserial String 扩展码,最长支持12位,如果超过,则会截取。根据我司建议位数提交

请求示例

http://ip:port/sms/sendBatch?appId=LHW-SMS-2XG&sign=e0be54f095fc72ee82a70dae644e7a0&mobiles=13000000000,15000000000&content=%E3%80%90%E9%B8%BF%E8%81%94%E4%B9%9D%E4%BA%94%E3%80%91%E6%82%A8%E5%A5%BD%EF%BC%8C%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%81%E6%98%AF252111&timestamp=20190409153345&schTime=&batchId=101&addserial=3

1.2 接口通用返回值说明

1.2.1 返回参数

参数名称 参数类型 参数描述 示例值
code String 值为 SUCCESS 时说明提交成功 详细见响应示例
data String 结果内容 json格式

响应示例

{
   "code": "SUCCESS",
   "data": ""
}

2.个性(批量)短信提交

2.1 用户

2.1.1 用户批量提交

接口说明

如需要大批量发送个性短信,减少HTTP请求次数,时间,可用此接口进行发送。可定时发送,定时本批提交的所有的个性短信的发送时间

URL

http://sms.51yixun.com:8200/sms/send

请求方式

get

参数请求格式

url

请求参数

参数名称 参数类型 是否必须 参数描述
appId String 用户Appid
sign String 签名格式:md5(appId+ secretKey + timestamp) 32位
【手机号与内容】 String 手机号=内容(必填)【可多个】,每次提交最多1000个以手机号为参数名,内容为参数值传输 如:18001000000=端午节快乐
schTime String 定时发送时间(选填,定时时间在90天之内)格式:yyyyMMddHHmmss 14位 如果不填,则为即时发送
batchId String 自定义消息ID(最长64位)
addserial String 扩展码,最长支持12位,如果最终号码长度超长,会截取扩展码,请根据我司建议位数提交

请求示例

http://ip:port/sms/send?appId=LHW-SMS-1LL&timestamp=20190409170903&sign=5063d9ecad6559113a8a385dda985d4&batchId=121121&addserial=001&13000000000=%E3%80%90%E8%81%94%E5%90%88%E3%80%91%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%

返回参数

参数名称 参数类型 参数描述 示例值
code String 值为 SUCCESS 时说明提交成功 详细见响应示例
data String 结果内容 json格式

响应示例

{
   "code": "SUCCESS",
   "data": ""
}

异常示例

{
   "code": "SUCCESS",
   "data": ""
}

返回码说明

返回码 返回码明细 返回码描述

详细参考附录中全局返回码

备注

2.1.2 获取状态报告

接口说明

用于用户批量提交

URL

http://sms.51yixun.com:8200/sms/report

请求方式

get

参数请求格式

url

请求参数

参数名称 参数类型 是否必须 参数描述
appId String 用户appId
timestamp String 时间戳 格式:yyyyMMddHHmmss
sign String 签名 格式: md5(appId+ secretKey+ timestamp) 32位
number int 获取数量 最多500个,默认是500个

请求示例

http://ip:port/sms/report?appId=LHW-SMS-2FG&sign=e0be54f095fc72ebea70dae644e7a0&timestamp=20190409153345

返回参数

参数名称 参数类型 参数描述 示例值
code String 值为 SUCCESS 时说明提交成功 详细见响应示例
data String 结果内容 json格式

响应示例:请求后有可返回的状态报告时:

{
   "code": "SUCCESS",
   "data": [
       {"batchId":"101",
        "state":"DELIVRD",
        "desc":"成功",
        "mobile":"15000000000",
        "receiveTime":"2019-04-09 15:34:01",
        "submitTime":"2019-04-09 15:32:30",
        "addserial":"3"},
       {"batchId":"101",
        "state":"DELIVRD",
        "desc":"成功",
        "mobile":"13000000000",
        "receiveTime":"2019-04-09 15:34:01",
        "submitTime":"2019-04-09 15:32:30",
        "addserial":"3"}]
}

异常示例:请求后没有可返回的状态报告

{
   "code": "SUCCESS",
   "data": ""
}

返回码说明

返回码 返回码描述
batchId 用户自定义消息批次id,用于匹配状态报告
state 短信状态值,DELIVRD、0是成功
desc 注释
mobile 手机号
receiveTime 接收时间
submitTime 用户提交时间
addserial 用户提交的扩展码

详细参考附录中全局返回码

备注

2.1.3 获取上行信息

接口说明

用于用户获取上行

URL

http://sms.51yixun.com:8200/sms/mo

请求方式

get

参数请求格式

url

请求参数

参数名称 参数类型 是否必须 参数描述
appId String 用户Appid
timestamp String 时间戳 格式:yyyyMMddHHmmss 14位
sign String 签名 格式:md5(appId+ secretKey+ timestamp) 32位
number int 获取数量,最多500个,默认500

请求示例

http://ip:port/sms/mo?appId=LHW-SMS-2XG&sign=e0be54f095fc72ebe82a70dae44e7a0&timestamp=20190409153345

返回参数

参数名称 参数类型 参数描述 示例值
code String 值为 SUCCESS 时说明提交成功 详细见响应示例
data String 结果内容 json格式

响应示例:请求后有可返回的上行信息时

{
   "code": "SUCCESS",
   "data": [{                   
               "mobile":"18313086061",
                "addserial":"3",
                "content":"收到,谢谢",
                "moTime":"2019-04-09 15:34:01"
            }]
}

异常示例:请求后没有可返回的上行信息时:

{
   "code": "SUCCESS",
   "data": ""
}

返回码说明

返回码 返回码描述
mobile 手机号
addserial 用户扩展码
content 上行短信内容
moTime 上行时间

详细参考附录中全局返回码

备注

2.1.4 获取余额

接口说明

用于用户获取余额

URL

http://sms.51yixun.com:8200/sms/balance

请求方式

get

参数请求格式

url

请求参数

参数名称 参数类型 是否必须 参数描述
appId String 用户Appid
timestamp String 时间戳 格式:yyyyMMddHHmmss 14位
sign String 签名 格式:md5(appId+ secretKey+ timestamp) 32位

请求示例

http://ip:port/sms/balance?appId=LHW-SMS-2XG&sign=e0be54f095febe82a70dae644e7a0&timestamp=20190409153345

返回参数

参数名称 参数类型 参数描述 示例值
code String 值为 SUCCESS 时说明提交成功 详细见响应示例
data String 结果内容 json格式

响应示例

{
   "code": "SUCCESS",
   "data": 
         {
            "balance":999
          }
}

返回码说明

返回码 返回码描述
balance 账号剩余余额,短信条数

详细参考附录中全局返回码

备注

3. 附录

3.1 提交响应错误码

参数名称 描述
SUCCESS 成功
APPID_ERROR 请求APPID错误
PARAMS_ERROR 请求参数错误
IP_ERROR 不识别的IP
SPEED_ERROR 请求超速
MOBILE_ERROR 手机号为空、号码数量过多、手机号码错误
CONTENT_ERROR 短信内容错误,空或过长
SCHTIME_ERROR 定时时间过早或过久
BATCHID_ERROR 缺少自定义消息id、自定义消息ID过长
EXTCODE_ERROR 扩展码错误
BALANCE_ERROR 余额不足
TIMESTAMP_ERROR 时间戳错误
SIGN_ERROR 签名错误

3.2 状态报告错误码

返回码 返回码明细
DELIVRD 成功
TIMEOUT 运营商状态报告超时
FAIL_BALANCE 余额不足
FAIL_MOBILE 手机号错误、手机号不支持
FAIL_MOBILE_EM 手机号重复
FAIL_AUDIT 审核拒绝
FAIL_BLACK 黑名单失败
FAIL_KEYWORD 关键字失败
FAIL_TD 用户退订
FAIL_WHITE 白名单失败
FAIL_REJECTD 拦截失败
FAIL_SIGN 签名错误
FAIL_SPEED 发送频率过快
FAIL_RESPONSE 运营商响应失败
FAIL_UNKNOW 未知失败
阅读 521

推荐阅读