接口文档

API短信批量发送接口

1. 短信批量发送接口

1.1 调用地址

地址http://address:port/sms/api/sendMessage

请求方法:POST

1.2 请求包头定义

Accept: application/json

Content-Type: application/json;charset=utf-8

1.3 请求参数

参数名

类型

必填

说明

userName

String

帐号用户名

content

String

短信内容

phoneList

[Array]

发送手机号码,JSON数组格式。

最大数量不得超过10000个号码,系统将自动去除重复号码。

timestamp

Long

当前时间戳,精确到毫秒。

例如2020年8月1日12:00:00 时间戳为:1596254400000

sign

String

由以下参数值组合成字符串并计算MD5值,参考详细规则

计算:MD5(userName + content + timestamp + MD5(password))

sendTime

String

短信定时发送时间,格式:yyyy-MM-dd HH:mm:ss

定时时间限制15天以内。

extcode

String

可选,附带通道扩展码

callData

String

用户回传数据,最大长度64。

用户若传递此参数将在回执推送时回传给用户。

1.4响应结果

参数名

类型

说明

code

Integer

处理结果,0为成功,其他失败,详细参考响应状态码

message

String

处理结果描述

msgId

Long

当code=0时,系统返回唯一消息Id

 

1.5请求示例

批量发送请求:

POST http://address:port/sms/api/sendMessage

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

"userName""test",

"content""【签名】您的验证码是123456",

"phoneList": ["13500000001""13500000002""13500000003"],

"timestamp"1596254400000,

"sign""43fcac8cf3079f86f2f8409158c51ff6"

}

发送响应结果:

{

"code"0,

"message""处理成功",

"msgId"123456

}