接口文档

API短信一对一接口

1.1 调用地址

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

请求方法:POST

1.2 请求包头定义

Accept: application/json

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

1.3 请求参数

参数名

类型

必填

说明

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。

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

1.4 响应结果

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

data

[Array]

当code=0时,系统返回处理结果的数组对象集合,对象参数见下表。

data由多个JSON对象构成的JSON数组,具体参数列表:

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

msgId

Long

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

phone

String

发送手机号码

1.1 请求示例

批量发送请求:

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

Accept: application/json

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

 

{

"userName""test",

"messageList": [

{

"phone""13500000001",

"content" : "【签名】尊敬的张先生,本次共消费211.45元"

},

{

"phone""13500000002",

"content" : "【签名】尊敬的林女士,本次共消费78.00元"

}

],

"timestamp"1596254400000,

"sign""e315cf297826abdeb2092cc57f29f0bf"

}

发送响应结果:

{

"code"0,

"message""处理成功",

"data": [

{

"code"0,

"message""处理成功",

"msgId"11600001,

"phone""13500000001"

},

{

"code"0,

"message""处理成功",

"msgId"11600002,

"phone""13500000002"

}

]

}