售前咨询
400-6999-710 , 13788998373
* 在线可以咨询售前、售后、技术开发等问题,联麓信息365天x24小时为你服务!在线技术工程师帮你解决遇到的任何问题。
售前顾问咨询 09:00 - 20:00 (24x7)
API文档
代码示例

短信验证码说明

短信验证码接口文档下载:点击下载
普通短信发送
用户在遵循HTTP协议的前提下,可通过GET和POST方式提交短信发送请求
普通短信发送
短信可以提交不超过50000个手机号码,每个号码用英文逗号间隔。 (一次提交发送超过200个手机号码,请使用POST请求)
短信验证码API文档:

本协议基于HTTP服务,使用POST请求方式,请求和应答均为JSON格式数据.。

字段命名方式:驼峰法。

统一请求和响应编码:UTF-8

统一请求Header内容:Content-Type: application/json

请使用接口网关地址替换文档中的服务器地址:http://address:port/sms

sign参数计算规则:多个指定参数值组合成字符串后计算MD5 32位小写结果

假设要求:MD5(userName + content + timestamp + MD5(password))

参数:userName(帐号名)=test

           password(帐号密码)=123

           content=测试内容

           timestamp=1596254400000

 计算:MD5(password)=202cb962ac59075b964b07152d234b70

     组合字符串:test测试内容1596254400000202cb962ac59075b964b07152d234b70

sign结果:MD5(组合字符串)=92f4abe1a56cac716bc790c93149a3ae


2.短信批量发送接口

2.1调用地址

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

请求方法:POST

2.2请求包头定义

Accept: application/json

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


2.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。

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



2.4响应结果

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

msgId

Long

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

2.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

}

3.短信一对一发送接口

3.1调用地址

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

请求方法:POST

3.2请求包头定义

Accept: application/json

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

3.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。

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


3.4响应结果


参数名

类型

说明

code

Integer

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

message

String

处理结果描述

data

[Array]

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

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


参数名

类型

说明

code

Integer

发送手机号码

message

String

短信内容


msgId

Long

可选,附带通道扩展码


phone

String

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

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


3.5请求示例

批量发送请求:

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"

}

]

}

4.回执状态推送接口

4.1调用地址

地址:客户需向我司提交接收回执状态地址,由平台主动推送回执状态数据

推送请求方法:POST

4.2推送请求包头定义

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

4.3请求参数

推送数据为JSON数组形式,每次推送不大于2000条。推送字段如下:

参数名

类型

必填

说明

msgId

Long

消息id,对应发送成功时系统响应的msgId

phone

String

手机号码

status

String

回执状态,DELIVRD成功,其他失败

receiveTime

String

回执时间,格式:yyyy-MM-dd HH:mm:ss

callData

String

用户回传数据,如果提交时有传递此参数将原样推送带回


4.4响应结果

正常响应HTTP状态码200即可。非200状态码将转换为客户获取形式

4.5推送请求示例

[

{

"msgId": 11600001,

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32",

"status": "DELIVRD"

},

{

"msgId": 11600002,

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32",

"status": "FAILURE"

}

]

5.上行回复推送接口

5.1调用地址

地址:客户需向我司提交接收上行回复地址,由平台主动推送上行回复数据

推送请求方法:POST

5.2推送请求包头定义

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

5.3请求参数

推送数据为JSON数组形式,每次推送不大于2000条。推送字段如下:


参数名

类型

必填

说明

content

String

上行回复内容

phone

String

手机号码

receiveTime

String

回执时间,格式:yyyy-MM-dd HH:mm:ss

destId

String

通道端口号

callData

String

用户回传数据,如果提交时有传递此参数将原样推送带回



5.4响应结果

正常响应HTTP状态码200即可。非200状态码将转换为客户获取形式

5.5推送请求示例

[

{

"content": "好的, 已收到",

"destId": "106203069598",

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32"

},

{

"content": "OK",

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32"

}

]

6.回执状态获取接口

6.1调用地址

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

请求方法:POST

6.2请求包头定义

Accept: application/json

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

6.3请求参数

此接口每次请求间隔时间不得小于30秒,如果获取条数为2000条表示还有回执未获取,可立即再次请求获取回执。


参数名

类型

必填

说明

userName

String

帐号用户名

timestamp

Long

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

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

sign

String

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

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


6.4响应结果

响应数据为JSON形式,每次获取不大于2000条,已获取的数据不会被再次获取到。

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

data

[Array]

获取的回执列表。JSON数组形式,具体字段如下

data包含推送字段如下(与4.4推送参数一致)

参数名

类型

必填

说明

msgId

Long

消息id,对应发送成功时系统响应的msgId

phone

String

手机号码

status

String

回执状态,DELIVRD成功,其他失败

receiveTime

String

回执时间,格式:yyyy-MM-dd HH:mm:ss

callData

String

用户回传数据,如果提交时有传递此参数将原样推送带回

6.5请求示例

状态获取请求:

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

Accept: application/json

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


{

"userName": "test",

"timestamp": 1596254400000,

"sign": "e315cf297826abdeb2092cc57f29f0bf"

}

响应结果:

{

"code": 0,

"message": "处理成功",

"data": [

{

"msgId": 11600001,

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32",

"status": "DELIVRD"

},

{

"msgId": 11600002,

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32",

"status": "FAILURE"

}

]

}

7.上行回复获取接口

7.1调用地址

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

请求方法:POST

7.2请求包头定义

Accept: application/json

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

7.3请求参数

此接口每次请求间隔时间不得小于30秒,如果获取条数为2000条表示还有上行未获取,可立即再次请求获取上行数据。


参数名

类型

必填

说明

userName

String

帐号用户名

timestamp

Long

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

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

sign

String

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

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


7.4响应结果

响应数据为JSON形式,每次获取不大于2000条,已获取的数据不会被再次获取到。

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

data

[Array]

获取的回执列表。JSON数组形式,具体字段如下

data包含推送字段如下(与5.4推送参数一致)

参数名

类型

必填

说明

content

String

上行回复内容

phone

String

手机号码

receiveTime

String

回执时间,格式:yyyy-MM-dd HH:mm:ss

destId

String

通道端口号

callData

String

用户回传数据,如果提交时有传递此参数将原样推送带回

7.5请求示例

状态获取请求:

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

Accept: application/json

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


{

"userName": "test",

"timestamp": 1596254400000,

"sign": "e315cf297826abdeb2092cc57f29f0bf"

}

响应结果:

{

"code": 0,

"message": "处理成功",

"data": [

{

"content": "好的, 已收到",

"destId": "106203069598",

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32"

},

{

"content": "OK",

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32"

}

]

}

8.查询余额接口

8.1调用地址

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

请求方法:POST

8.2请求包头定义

Accept: application/json

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

8.3请求参数

参数名

类型

必填

说明

userName

String

帐号用户名

timestamp

Long

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

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

sign

String

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

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

8.4响应结果

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

balance

Long

当code=0时,系统返回帐号短信余额

8.5请求示例

状态获取请求:

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

Accept: application/json

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


{

"userName": "test",

"timestamp": 1596254400000,

"sign": "e315cf297826abdeb2092cc57f29f0bf"

}

响应结果:

{

"code": 0,

"message": "处理成功",

"balance": 967793

}

9.提交短信模板接口

9.1调用地址

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

请求方法:POST

9.2请求包头定义

Accept: application/json

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

9.3请求参数

参数名

类型

必填

说明

userName

String

帐号用户名

timestamp

Long

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

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

sign

String

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

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

content

String

模板内容,内容文本中变量符:{%变量%}

9.4响应结果

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

9.5请求示例

状态获取请求:

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

Accept: application/json

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


{

"userName": "test",

"timestamp": 1596254400000,

"sign": "be5312e95c43624b52399a24ac268876",

"content": "【签名】您的验证码是{%变量%} "

}

响应结果:

{

"code": 0,

"message": "处理成功"

}

10.查询短信模板接口

10.1调用地址

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

请求方法:POST

10.2请求包头定义

Accept: application/json

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

10.3请求参数

此接口每次请求间隔时间不得小于60秒。

参数名

类型

必填

说明

userName

String

帐号用户名

timestamp

Long

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

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

sign

String

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

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

10.4响应结果

参数名

类型

说明

code

Integer

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

message

String

处理结果描述

data

[Array]

字符串数组, 返回已生效的短信模板列表

10.5请求示例

状态获取请求:

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

Accept: application/json

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


{

"userName": "test",

"timestamp": 1596254400000,

"sign": "e315cf297826abdeb2092cc57f29f0bf"

}

响应结果:

{

"code": 0,

"message": "处理成功",

"data": [

"【签名】您的验证码是{%变量%}",

"【签名】亲爱的顾客, 您本次共消费{%金额%}, 感谢您的光临"

]

}

11.响应状态码列表

状态码

说明

0

处理成功

1

帐号名为空

2

帐号名或密码鉴权错误

3

帐号已被锁定

4

此帐号业务未开通

5

帐号余额不足

6

缺少发送号码

7

超过最大发送号码数

8

发送消息内容为空

9

无效的RCS模板ID

10

非法的IP地址,提交来源IP地址与帐号绑定IP不一致

11

24小时发送时间段限制

12

定时发送时间错误或超过15天

13

请求过于频繁,每次获取数据最小间隔为30秒

14

错误的用户扩展码

16

时间戳差异过大,与系统时间误差不得超过5分钟

18

帐号未进行实名认证

19

帐号未开放回执状态

50

缺少模板标题

51

缺少模板内容

52

模板内容不全

53

不支持的模板帧类型

54

不支持的文件类型

97

此链接不支持GET请求

98

HTTP Content-Type错误, 请设置Content-Type: application/json

99

错误的请求JSON字符串

500

系统异常


产品与服务
验证码API短信
通知短信
会员通知短信
会员营销短信
彩信营销
视频彩信营销
联麓云文档中心
短信验证码
国际验证码接口
彩信文档
会员营销接口
联系我们
咨询热线:400-6999-710
客户经理:13788998373
投诉专线:17701870888
渠道合作:18001911753
公司地址:上海市奉贤区宝龙广场2号楼1510
公众号
扫描二维码关注
微信ID:LLxinxigzh
短信群发