API文档短信云 —— 为 您 服 务
API文档—短信
短信/国际短信 下发
名称 Submit
功能 发送一条或者多条内容相同的短信
输入说明

参数值说明:

以下json内容为提交请求数据格式:

{"account":"8528",

"password":" e717eb fd527 1ea4a 98bd3 8653c 01113d",

"msgid":" 2c928 25934 837c 4d01 3483 7dc ba00 150",

"phones":"157****6132",

"content":"您好,您的手机验证码为:430237。",

"sign":" 【8528】", "subcode" :"8528",

"sendtime":"201405051230"}

字段说明

account:用户账号;

password:账号密码,需采用MD5加密(32位小写);

msgid:该批短信编号(32位UUID),需保证唯一,选填;

phones:接收手机号码,多个手机号码用英文逗号分隔,最多500个,必填;国际号码格式:“+国别号 手机号”

content:短信内容,最多350个汉字,必填,内容中不要出现【】[]这两种方括号,该字符为签名专用;

sign:短信签名,该签名需要提前报备,生效后方可使用,不可修改,必填

,示例如:【大汉三通】;

subcode:短信签名对应子码(大汉三通提供)+自定义扩展子码(选填),必须是数字,选填,未填使用签名对应子码;

sendtime:定时发送时间,格式yyyyMMddHHmm,为空或早于当前时间则立即发送;

输出说明

响应数据格式:

{"msgid": "f02a daaa 99c54 ea58d 626aac 2f4d dfa8",

"result":"0",

"desc":"提交成功",

"failPhones":"129 35353 535,110, 13012 3123"}

字段说明

msgid:该批短信编号;

result:该批短信提交结果;说明请参照:5.1.提交响应错误码;

desc:状态描述;

failPhones:如果提交的号码中含有错误(格式)号码将在此显示。

批量 短信/国际短信 下发
名称 Submit
功能 批量发送不同内容短信
输出说明

参数值说明:

以下json内容为提交请求数据格式:

{"account":"dh8528",

"password":"bb43a 2c4081be c02fca7b7 2f38e63021",

"data":[{

"msgid":"9378 6e387cf64 62b9b60a 36f8e7f1b27",

"phones":"1111 1111, 157116 66133,173 8786465, 44554545",

"content":"您好!你有一个快递,请注意查收。",

"sign":"【客户签名】",

"subcode":"8528",

"sendtime":""},{

"msgid":"93786e 387cf646 2b9b60a36 f8e7f1b27",

"phones":"157********",

"content":"您的订单今日送达,谢谢",

"sign":"【客户签名】",

"subcode":"8527",

"sendtime":""}]}

字段说明

account:用户账号;password:账号密码,需采用MD5加密(32位小写);

msgid:该批短信编号(32位UUID),需保证唯一,必填;

phones:接收手机号码,多个手机号码用英文逗号分隔,最多500个,必填;国际号码格式:“+国别号 手机号”

content:短信内容,最多350个汉字,必填,内容中不要出现【】[]这两种方括号,该字符为签名专用;

sign:短信签名,该签名需要提前报备,生效后方可使用,不可修改,必填。

示例如:【大汉三通】;

subcode:短信签名对应子码(大汉三通提供)+自定义扩展子码(选填),必须是数字,选填,未填使用签名对应子码;

sendtime:定时发送时间,格式yyyyMMddHHmm,为空或早于当前时间则立即发送;

输出说明

响应数据格式:

{"result":"0",

"desc":"提交成功",

"data":[{

"msgid":"9378 6e387cf64 62b9b60a36f 8e7f1b27",

"status":"4",

"desc":"错误号码/限制运营商号码",

"failPhones":" 44554545, 1738786465, 11111111"}]}

字段说明

result:该数据包短信提交结果;说明请参照:5.1.提交响应错误码;

desc:状态描述;

status:每一批失败短信的错误码;说明请参照:5.1.提交响应错误码;

msgid:每一批短信编号;

failPhones:如果提交的号码中含有错误(格式)号码将在此显示。

短信/国际短信 状态报告
名称 Report
功能 获取状态报告,有数据时无需休眠; 当请求无数据返回时,建议客户端休眠30秒再进行请求。 每次最多取200条状态报告。
输入说明

参数值说明:

以下json内容为提交请求数据格式:

{"account":"8528",

"password":"e717 ebfd5271 ea4a98bd38 653c01113d",}

字段说明

account:用户账号;

password:账号密码,需采用MD5加密(32位小写);

输出说明

响应数据格式:

{"result":"0",

"desc":"成功",

"reports":[{

"msgid":"2c9 2825934837 c4d0134837 dcba00150",

"phone":"135********",

"status":"0",

"desc":"成功",

"wgcode":"DELIVRD",

"time":"2015-03-17 16:32:20",

"smsCount":"1",

"smsIndex":"1"}]}

字段说明

result:接口调用结果,说明请参照:5.1.提交响应错误码;

当result为0时reports字段将出现0到1次,否则reports字段不出现;

msgid:短信编号;

phone:下行手机号码;

status:短信发送结果:

0——成功;1——接口处理失败;2——运营商网关失败;

desc:当status为1时,以desc的错误码为准。说明请参照:5.2.状态报告错误码;

wgcode:当status为2时,表示运营商网关返回的原始值;

time:状态报告接收时间格式为yyyy-MM-ddHH:mm:ss。

smsCount:长短信条数。

smsIndex:长短信第几条标示。

获取回复 短信/国际短信
名称 deliver
功能 获取回复短信,请求无数据返回,建议客户端休眠30秒再进行请求,每次最多取150条上行回复。
输入说明

参数值说明:

以下json内容为提交请求数据格式:

{"account":"8528",

"password":"e717 ebfd5271ea4 a98bd38653 c01113d"}

字段说明

account:用户账号;

password:账号密码,需采用MD5加密(32位小写)。

输出说明

响应数据格式:

{"result":"0",

"desc":"成功",

"delivers":[

{"phone":"157********",

"content":"短信内容",

"subcode":"4210"

"delivertime":"2015-03-11 11:00:00"}]}

字段说明

result:接口调用结果,说明请参照:5.1.提交响应错误码;

当result为0时delivers字段将出现0到1次,否则delivers字段不出现;

phone:上行手机号码;

content:上行短信内容;

subcode:子号码;

delivertime:上行接收时间,格式yyyy-MM-ddHH:mm:ss。

提交响应错误码
错误码 描述
0 提交成功
1 账号无效:
2 密码错误
3 msgid太长,不得超过32位
5 手机号码个数超过最大限制(500个)
6 短信内容超过最大限制
7 扩展子号码无效
8 定时时间格式错误
14 手机号码为空
19 用户被禁发或禁用
20 ip鉴权失败
21 短信内容为空
22 数据包大小不匹配
98 系统正忙
99 消息格式错误
状态报告错误码
错误码 描述
4
5 手机号码无效
6 签名不合法
9 请求来源地址无效
10 内容包含敏感词
11 余额不足
12 购买产品或订购还未生效或产品已暂停使用
13 账号被禁用或禁发
14 不支持该运营商
16 发送号码数没有达到该产品的最小发送数
19 黑名单号码
20 该模板ID已被禁用
21 非法模板ID
22 不支持的MSGFMT
23 子号码无效
24 内容为空
25 号码为空
26 单个号码相同内容限制
27 单个号码次数限制
28 账号被拦截,不允许发送
96 处理失败
97 接入方式错误
98 系统繁忙
98 消息格式错误