V5 文档
来源: | 作者:arvin | 发布时间: 2024-04-18 | 1583 次浏览 | 分享到:
短信v5 文档

 

短信平台

第二章HTTP协议接口说明

2.1.短信发送接口

提交地址:

² https://api.smsxy.com/smsSend.do

send接口提交方式:POST/GET

功能:发送短信,单条和群发短信

输入参数

描述

username

用户名(必填)

password

密码(必填)MD5(username+MD5(pwd))

pwd为明文密码

mobile

手机号,多个手机号为用半角 , 分开,如13899999999,13688888888(GET方式最多5000个,必填)

content

发送内容(必填

dstime

定时时间,为空时表示立即发送(选填)

格式:yyyy-MM-dd HH:mm:ss

例如:2016-09-10 09:00:00

ext

用户自定义扩展(选填)

需要和后台人员确认权限

msgid

客户自定义消息id(选填)

样例:

https://api.smsxy.com/smsSend.do?username=abcd&password=910fe2e329eb6ecbedcb8dd0b5a6fee0&mobile=13911000000&content=【签名】您的验证码是321064。如非本人操作,请忽略本短信,5分钟内有效。

1password的处理方式

password=MD5(abcd+MD5(123456)),做两次md5摘要,加密后的内容为

5de8d67910733ce611776d9603436eb7

2content的处理方式

汉字";

<content = URLEncoder.encode(content,UTF-8);

返回参数

描述

>0

成功,系统生成的任务id或自定义的任务id

如果指定的msgid为字符串,则返回系统内部的任务id

0

失败

-1

用户名或者密码不正确

-2

必填选项为空

-3

短信内容0个字节

-4

提交地址或参数有误

-5

余额不够

-10

用户被禁用

-11

短信内容超过500

-12

无扩展权限(ext字段需填空)

-13

IP校验错误

-14

内容解析异常

-990

未知错误

2.2.个性短信接口

提交地址:

&sup2; https://api.smsxy.com/customSmsSend.do

接口提交方式:POST

功能:提交个性短信,适用不同短信内容和不同号码批量发送

输入参数

描述

username

用户名(必填)

password

密码(必填)MD5(username+MD5(pwd))

pwd为明文密码

content

号码,内容(Hex编码)多个用逗号(,)隔开

dstime

定时时间,为空时表示立即发送(选填)

格式:yyyy-MM-dd HH:mm:ss

ext

用户自定义扩展(选填)

需要和后台人员确认权限

msgid

客户自定义消息id(选填)

2.3.余额查询接口

提交地址:

&sup2; https://api.smsxy.com/balanceQuery.do

Finance接口提交方式:POST/GET

功能:查询短信剩余数量

输入参数

描述

username

用户名(必填

password

密码(MD5(username+MD5(password)))(必填

样例:

https://api.smsxy.com/balanceQuery.do?username=userccc&password=MD5(user+MD5(XXXX))

返回参数

描述

XXXXX

XXXXX代表该产品的剩余条数

-1

用户名或者密码不正确

-2

必填选项为空

2.4.修改密码

&sup2; 提交地址:https://api.smsxy.com/passwordUpdate.do

接口提交方式:POST/GET

功能:更新密码

输入参数

描述

username

用户名(必填

password

密码(MD5(username+MD5(password)))(必填

newpassword

新密码

2.5.状态报告

推送方式:http post

推送条数:多条

推送格式:report=号码|状态码|短信ID|扩展码|接收时间;号码|状态码|短信ID|扩展码|接收时间

说明:多条报告中间用英文分号(;)隔开

例如:report=13800000000|DELIVRD|777342392938043392|73249|2016-09-10 11:08:00;13800000001|DELIVRD|777342392938043393|73249|2016-09-10 11:08:00

状态码:

返回参数

描述

DELIVRD

状态成功

UNDELIV

状态失败

EXPIRED

因为用户长时间关机或者不在服务区等导致的短消息超时没有递交到用户手机上

REJECTD

消息因为某些原因被拒绝

LIMITED

号码发送频率受限

REPEATD

相同号码相同内容发送频率受限

MBBLACK

黑号

2.6.短信上行

推送方式:http post

推送条数:单条

推送格式:deliver=内容|扩展号|编码格式|号码|用户名|时间

例如:deliver=你好|78249|8|13800000000|abcd|2016-09-10 11:08:14

2.7.数字签名

MD5摘要生成:

摘要地址:

&sup2; https://api.smsxy.com/md5Digest.do

输入参数

描述

plaintext

明文

2.8.定时任务取消接口

提交地址:

&sup2; https://api.smsxy.com/taskCancel.do

send接口提交方式:POST/GET

功能:取消定时任务

输入参数

描述

username

用户名(必填)

password

密码(必填)MD5(username+MD5(pwd))

pwd为明文密码

msgid

短信提交接口返回的任务编号

取消成功返回1,取消失败返还0

 

环境要求

3.1.网络拓扑图

3.2.环境要求

本节将详细说明正确发送/接收短信的前提条件:

确保企业服务器端可以通过http上网

确保企业服务器端有固定IP, 需要,可对企业方的IP进行鉴权

3.3.并发能力

短信接口服务采用负载均衡集群部署方案,具有良好的并发处理能力。压力测试时数百的提交线程可以达到10000+QPS

 

第四章扣费说明

4.1发送说明

1) 如果一次提交小于等于70字符 系统会默认为一条短信发出,扣费一条;

2) 如果大于70字符 系统会默认为长短信处理,此时扣费按67字符扣一条 (内容不超过500字符)

3) 纯单字节是140一条,超过140个字符后,按普通长短信收费,即67个字符每条收费。

4.2签名说明

提交短信时,需要在content参数上加签名,具体签名格式可与对接技术支持沟通,且签名在使用之前请和相关短信方商务或者客服同事报备。

4.3提交说明

1)  提交成功,接口返回值是不包含负号的18位以内的字符串;

2)  提交失败,则会返回以“-”开头的字符串