本协议基于HTTP服务，使用POST请求方式，请求和应答均为JSON格式数据.。
字段命名方式：驼峰法。
统一请求和响应编码：UTF-8
统一请求Header内容：Content-Type: application/json
请使用接口网关地址替换文档中的服务器地址：http://{address:port}/sms
sign参数计算规则：多个指定参数值组合成字符串后计算MD5 32位小写结果
要求：MD5(userName + timestamp + MD5(password))
假设：userName(帐号名)=test
password(帐号密码)=123
timestamp=1596254400000
计算：MD5(password)=202cb962ac59075b964b07152d234b70
组合字符串：test1596254400000202cb962ac59075b964b07152d234b70
sign结果：MD5(组合字符串)=e315cf297826abdeb2092cc57f29f0bf
地址：http://{address:port}/sms/api/sendMessageMass
请求方法：POST
Accept: application/json
Content-Type: application/json;charset=utf-8
|
参数名 |
类型 |
必填 |
说明 |
|
userName |
String |
是 |
帐号用户名 |
|
content |
String |
是 |
短信内容 |
|
phoneList |
[Array] |
是 |
发送手机号码，JSON数组格式。 最大数量不得超过10000个号码，系统将自动去除重复号码。 |
|
timestamp |
Long |
是 |
当前时间戳，精确到毫秒。 例如2020年8月1日12:00:00 时间戳为：1596254400000 |
|
sign |
String |
是 |
由以下参数值组合成字符串并计算MD5值，参考详细规则 计算：MD5(userName + timestamp + MD5(password)) |
|
sendTime |
String |
否 |
短信定时发送时间，格式：yyyy-MM-dd HH:mm:ss。 定时时间限制15天以内。 |
|
extcode |
String |
否 |
可选，附带通道扩展码 |
|
callData |
String |
否 |
用户回传数据，最大长度64。 用户若传递此参数将在回执推送时回传给用户。 |
|
参数名 |
类型 |
说明 |
|
code |
Integer |
处理结果，0为成功，其他失败，详细参考响应状态码 |
|
message |
String |
处理结果描述 |
|
msgId |
Long |
当code=0时，系统返回唯一消息Id |
|
smsCount |
Integer |
当code=0时，系统返回消耗计费总数 |
发送请求：
POST http://{address:port}/sms/api/sendMessageMass
Accept: application/json
Content-Type: application/json;charset=utf-8
{
"userName": "test",
"content": "【签名】您的验证码是123456",
"phoneList": ["13500000001", "13500000002", "13500000003"],
"timestamp": 1596254400000,
"sign": "e315cf297826abdeb2092cc57f29f0bf"
}
响应结果：
{
"code": 0,
"message": "处理成功",
"msgId": 123456,
"smsCount": 3
}
地址：http://{address:port}/sms/api/sendMessageOne
请求方法：POST
Accept: application/json
Content-Type: application/json;charset=utf-8
|
参数名 |
类型 |
必填 |
说明 |
|
userName |
String |
是 |
帐号用户名 |
|
messageList |
[Array] |
是 |
数组形式，包含多个JSON对象，对象参数见下表。 每个JSON对象包含短信内容和号码数据，最大1000个号码。 |
|
timestamp |
Long |
是 |
当前时间戳，精确到毫秒。 例如2020年8月1日12:00:00 时间戳为：1596254400000 |
|
sign |
String |
是 |
由以下参数值组合成字符串并计算MD5值，参考详细规则 计算：MD5(userName + timestamp + MD5(password)) |
|
sendTime |
String |
否 |
短信定时发送时间，格式：yyyy-MM-dd HH:mm:ss。 定时时间限制15天以内。 |
messageList由多个JSON对象构成的JSON数组，具体参数列表：
|
参数名 |
类型 |
必填 |
说明 |
|
phone |
String |
是 |
发送手机号码 |
|
content |
String |
是 |
短信内容 |
|
extcode |
String |
否 |
可选，附带通道扩展码 |
|
callData |
String |
否 |
用户回传数据，最大长度64。 用户若传递此参数将在回执推送时回传给用户。 |
