短信接口指南
本系统是本司自主研发的系统,用于实现终端客户短信/彩信发送的管理平台,本文档为第三方平台使用API接口,与本短信平台进行对接而完成。本接口提供了HTTP实现方式。对于采用HTTP协议的用户,出于数据安全性和数据容量的考虑,建议采用http中的Post方法连接Api地址进行数据传输。
接口限制规则客户端 | 服务端 | 长短信 | 字符 | 签名 | 签名位置 | 签名长度 |
---|---|---|---|---|---|---|
本文中特指企业客户侧系统。 | 本文中特指本司系统。 | 超过70字为长短信,长短信按67字/条扣费。用户收到显示一条(手机会合并多条信息)。 | 本平台最大支持500字,标点符号,签名,英文,汉字都算一个字。 | 包含【】符号里的汉字或英文,即为签名。比如:【验证码】,签名即为验证码下发短信必须带上签名,签名需提前找客服报备 | 签名必须在内容的最前面或者最后面。不能在短信内容中间。正确的示例:【签名A】短信内容1短信内容2【签名B】错误的示例:部分内容【签名A】部分内容 | 签名长度一般为3-8个字符。具体可咨询客服。 |
提交地址:http://ip:port/sms/send.do
接口提交方式:GET/POST
功 能:普通群发
参数名称 | 说明 | 备注 |
---|---|---|
userid | 用户名 | |
timespan | 时间戳 | 格式为yyyyMMddHHmmss |
pwd | 密码 | 此处用原始密码+时间戳做MD5加密,32位大写格式 (+号为连接符) |
mobile | 手机号 | 多个用英文逗号隔开 |
msgfmt | 编码类型 | 选填,如果不填默认为GBK,可以选填GBK或者UTF8/UTF-8 |
content | 内容 | 做base64加密操作,编码方式使用msgfmt中的方式,如果msgfmt有值的话 |
ext | 扩展 | 选填, 纯数字 具体支持位数咨询客服 |
msgid | 唯一标识 | 选填,纯数字,如果不填系统自动生成作为当前批次的唯一标识 |
attime | 定时时间 | 选填,2008-06-09 12:00:00 |
返回值说明:提交成功,返回当前提交数据的唯一标记ID
提交样例:http://ip:port/sms/send.do?
userid=******&pwd=66FDD754657E6D7E98E3BDDF14B2A179×pan=
123456&mobile=188****8888&content=xPq1xNHp1qTC686qMTIz
提交地址:http://ip:port/sms/sendData.do
接口提交方式:GET/POST
功能:针对不同号码不同内容群发
参数名称 | 说明 | 备注 |
---|---|---|
userid | 用户名 | |
timespan | 时间戳 | 格式为yyyyMMddHHmmss |
pwd | 密码 | 此处用原始密码+时间戳做MD5加密,32位大写格式 |
mobile | 手机号 | 多个用英文逗号隔开 |
msgfmt | 编码类型 | 选填,如果不填默认为GBK,可以选填GBK或者UTF8/UTF-8 |
content | 内容 | 做base64加密操作,编码方式使用msgfmt中的方式,如果msgfmt有值的话,内容之间用逗号隔开,内容个数需要与手机号个数相等。 |
ext | 扩展 | 选填, 纯数字 具体支持位数咨询客服 |
attime | 定时时间 | 选填,2008-06-09 12:00:00 |
返回值说明:提交成功,返回当前提交数据的唯一标记ID
提交地址:http://ip:port/sms/balance.do
接口提交方式:GET/POST
功能:查询余额
参数名称 | 说明 | 备注 |
---|---|---|
userid | 用户名 | |
timespan | 时间戳 | 格式为yyyyMMddHHmmss |
pwd | 密码 | 此处用原始密码+时间戳做MD5加密,32位大写格式 |
返回值说明:成功返回当前账户余额。
错误码 | 描述 |
---|---|
-101 | 用户不存在 |
-102 | 密码不正确 |
-103 | 余额不足 |
-104 | 参数格式有误 |
-105 | 扩展码错误 |
-106 | 内容超长(500字)或内容为空 |
-107 | 用户状态异常 |
-108 | Ip鉴权失败 |
-109 | 内容解析异常 |
-990 | 未知异常 |