文档介绍：短信平台外部接口说明书
当前版本:
修改:2013-07-02
版本历史
版本
更改描述
更改日期
修订人
正式发布
2008-12-02
侯伟
增加webservice调用方式
2008-12-10
侯伟
增加修改密码
2009-01-08
侯伟
增加了定时发送
2009-01-09
侯伟
增加了代理商充值
2009-01-09
侯伟
中文参数改为UTF-8编码方式(向前兼容老版本)
2009-04-07
侯伟
API支持GET方式提交数据(必须对汉字URL UTF-8Encode)
2009-04-08
侯伟
可以获取状态
2010-01-05
侯伟
可以设置长短信(需要通道支持)
2011-05-17
侯伟
增加接收短信
2012-04-18
侯伟
增加发送个性化短信
2012-11-30
侯伟
密码可以使用MD5加密
2013-04-27
侯伟
增加是否过滤重复号码参数
2013-05-10
侯伟
增加接收短信
2013-06-06
侯伟
增加扩展号码
2013-06-26
侯伟
增加获取状态的方法
2012-07-02
侯伟
外部接口概述:
本接口面向短信平台代理商及普通用户,以用户的程序调用本接口的方式,实现外部程序实现短信发送、接收、查询等系列操作。
本说明书适用于程序员查阅。
接口基础信息
调用网址格式:
访问IP地址:
访问端口:8889
HTTP POST(支持GET)
/?username={username}&password={password}&action={action}&{para1}={value1}&{para2}={value2}
1. 其中{username}为用户在平台的登录用户名,{password}为用户在平台的登录密码,密码可以不进行任何处理,也可以md5加密32位小写后加前缀,例如密码“test01”加密后“0xe10adc3949ba59abbe56e057f20f883e”。
2. 其中{action}为操作方法。
3. 其中{para}和{value}为操作方法需要的参数。
例如发送时:
:8889/?username=YourUsername&password=YourPassword&action=send&receive_number=PhoneNumber&message_content=MessageContent
参数传递方式:
POST(支持GET)
推荐使用POST方式,如果选择GET方式提交,需注意提交数据量有限制
编码:
UTF-8
其中汉字部分需要用urlEncode的UTF-8编码,例如“汉字”编码后变为“%E6%B1%89%E5%AD%97”
约定
如无特殊说明,所有格式均为正则表达式格式
方法参数及返回值说明:
查询余额
参数列表:
参数名称
参数释义
必传?
格式说明
username
用户登录名
是
/^[0-9a-zA-Z_]{6,20}$/
password
用户登录密码
是
/^(0x)?[a-zA-Z0-9_]+$/
action
调用方法
是
/^surplus$/
返回值:
格式
说明
/^-1$/
登录失败
/^-2$/
用户名或密码格式不正确
/^(?:(\d+):(\d+)\n?)+$/
$1 通道ID
$2 通道余额
查询通道信息
参数列表:
参数名称
参数释义
必传?
格式说明
username
用户登录名
是
/^[0-9a-zA-Z_]{6,20}$/
password
用户登录密码
是
/^(0x)?[a-zA-Z0-9_]+$/
action
调用方法
是
/^passage$/
pid
通道ID
是
/^\d+$/
返回值:
格式
说明
/^-1$/
登录失败
/^-2$/
用户名或密码格式不正确
/^(\d+):(.+?):(\d+):(.*)$/
$1 通道ID
$2 通道名称
$3 通道状态
1 可用
2 不可用
$4 备注
发送短信
参数列表:
参数名称
参数释义
必传?
格式说明
username
用