| 本站接入短信通道列表(x_gate_id值如下) |
| 通道ID |
通道名称 |
工作时间 |
短信长度 |
子号码扩展 |
支持回复 |
强签名 |
批量提交上限(条) |
| 100 |
北京移联通道.支持移动和联通 |
不限时间 |
66个字符 |
不提供 |
是 |
是 |
1000 |
| 101 |
湖南电信通道 |
|
|
|
否 |
是 |
100 | 本接口专为中小型网站提供。开通简单,平台稳定，24小时发送.速度快(最大限度的减少延迟时间),支持上行,可以在线充值,不限充值金额大小等优点.
本站短信通道为正规企业通道支持移动
联通 小灵通。禁止群发垃圾短信,发现者立即封号.并没收帐户余额!
如果发送失败,请切换通道尝试重新发送.某个通道如果被运营商关闭,我们会在首页及时通知客户切换其它通道.
我们提供多条通道发送.可以动态切换通道。
| 网页中参数详细列表 |
| 编号 |
参数名称 |
参数说明 |
是否必须 |
| 1 |
x_eid |
会员企业ID号,个人用户为0 |
是 |
| 2 |
x_uid |
会员账号 |
是 |
| 3 |
x_pwd_md5 |
登陆密码的MD5值 |
是 |
| 4 |
x_sub_id |
扩展子号码,发送短信时需要,根据通道是否支持子号码扩展而提供 |
否 |
| 5 |
x_target_no |
接受者号码，多个号码用“,”分开 |
否 |
| 6 |
x_memo |
短信发送内容.长度请参考通道说明 |
否 |
| 7 |
x_send_time |
定时短信,格式YYYY-MM-DD
HH:MM:SS,24小时制.值为空或无该参数代表立即发送 |
否 |
| 8 |
x_gate_id |
发送短信时通道ID，通道发送失败可以切换其它通道，无该值系统使用默认通道 |
否 |
| 9 |
x_ac |
本此提交的行为。比如是发送短信。查询余额,参数值如下 |
是 |
| 参数x_ac（提交动作）值 |
| 编号 |
值 |
说明 |
| 1 |
10 |
发送短信。返回失败或成功 |
| 2 |
11 |
发送短信。返回详细报告状态 |
| 3 |
12 |
快速发送短信，直接提交到短信网关,本站不存储任何发送数据 |
| 4 |
20 |
发送前参考通道是否支持回复。需要提供通道ID号,不提供通道采用默认通道 |
| 5 |
30 |
查询账户余额 |
| 参数x_ac＝10发送短信时。返回值 |
| 编号 |
值 |
说明 |
| 1 |
大于0 |
发送成功,此次发送成功条数 |
| 2 |
-1 |
参数无效 |
| 3 |
-2 |
通道不存在 |
| 4 |
-3 |
定时格式错误 |
| 5 |
-4 |
接收号码无效 |
| 6 |
-5 |
提交号码个数超过上限,每个通道都有批量提交的上限.详细值请参考通道说明 |
| 7 |
-6 |
发送短信内容长度不符合要求,参考通道要求长度 |
| 8 |
-7 |
当前账户余额不足 |
| 9 |
-8 |
网关发送短信时出现异常 |
| 10 |
-9 |
用户或者密码没输入 |
| 11 |
-10 |
企业ID号不存在 |
| 12 |
-11 |
密码错误 |
| 13 |
-12 |
账户锁定 |
| 14 |
-13 |
网关状态关闭 |
| 15 |
-14 |
验证用户时执行异常 |
| 16 |
-15 |
网关初始化失败 |
| 17 |
-100到-199 |
运营商返回失败代码 |
| 参数x_ac＝11发送短信时。返回XML |
<SendReport>
<RetCode>1</RetCode>
<!--状态代码-->
<ErrorDesc>成功</ErrorDesc>
<!--代码文字描述-->
<BlackWords />
<!--发送失败，被屏蔽的关键字-->
<FailNo />
<!--失败号码列表串-->
<ShieldNo />
<!--被屏蔽的号码字符串-->
</SendReport> |
| 参数x_ac＝12快速发送短信(直接提交到网关)。返回XML |
<SendReport>
<RetCode>1</RetCode>
<!--状态代码-->
<ErrorDesc>成功</ErrorDesc>
<!--代码文字描述-->
<BlackWords />
<!--发送失败，被屏蔽的关键字-->
<FailNo />
<!--失败号码列表串-->
<ShieldNo />
<!--被屏蔽的号码字符串-->
</SendReport> |
| 参数x_ac＝20接收短信时。返回XML格式,返回<NoData/>代表没有收到新短信.每次最多返回100条最新收到的。第一次读取后。第二次不会重复读取 |
<ReadSMS>
<!--收到短信开始-->
<Item>
<!--如果有多条循环此节-->
<SenderNo>13405886058</SenderNo>
<!--回复者号码-->
<MsgContent>星信:我时工作顺利用这</MsgContent>
<!--回复短信内容-->
<SendTime>2008-03-14 23:07:39</SendTime>
<!--回复时间-->
<SP_PID>1065810889988</SP_PID>
<!-回复到SP号的号码-->
</Item>
<Item> <!--收到第二条短信-->
<SenderNo>13405886658</SenderNo>
<MsgContent>星信:测试短信收到!</MsgContent>
<SendTime>2008-03-14
23:07:35</SendTime>
<SP_PID />
</Item>
</ReadSMS> |
| 参数x_ac=30查询账户.返回值 |
| 编号 |
值 |
说明 |
| 1 |
-1 |
查询账户余额失败 |
| 2 |
>=0 |
返回当前余额 |
| 用户身份验证时的返回值 |
| 编号 |
值 |
说明 |
| 1 |
-9 |
用户或者密码没输入 |
| 2 |
-10 |
企业ID号不存在 |
| 3 |
-11 |
登陆密码错误 |
| 4 |
-12 |
账户锁定 |
| 5 |
-13 |
网关状态关闭 |
| 6 |
-14 |
验证账户时执行异常 |
| HTTP
POST方式发送短信例子 |
|
<form id="sms_send">
<input type="hidden"
name="x_eid" value="100"/>
<input type="hidden"
name="x_pwd_md5"
value="md5(123)"/><!--密码必须MD5后的值，不区分大小写-->
<input
type="hidden" name="x_target_no" value="15910619901,1591061901"/>
<!--多个号码用“,”分开-->
<input type="hidden" name="x_memo"
value="这是一条测试短信请试试"/>
<input type="hidden"
name="x_send_time" value="2009-12-12 12:20:10"/>
<!--短信发送时间，如果立即发送不提供该参数-->
<input type="hidden"
name="x_ac" value="10"/> <!--提交目的是发送短信-->
<input
type="submit" name="Submit" value="发送短信" />
</form>
|
| 接收短信或查询账户余额例子 |
<form id="sms_send">
<input type="hidden"
name="x_eid" value="100"/>
<input type="hidden"
name="x_pwd_md5"
value="md5(123)"/><!--密码必须MD5后的值，不区分大小写-->
<input
type="hidden" name="x_ac" value="30"/> <!--提交目的是发送短信
20代表接收短信，需要提供通道ID号-->
<input type="submit"
name="Submit" value="查询余额" />
</form> |
| HTTP GET方试
(参数使用URL编码) |
| http://gateway.woxp.cn:6630/gb2312/web_api/?x_eid=100&x_uid=admin&x_pwd_md5=asdfsdf&x_ac=10&x_target_no=15910619901&x_memo=test |
| 公共参数说明 |
| string
eid_pwd_gateId |
| 详细说明 |
用户身份标识串,由【企业ID号-会员账号-密码MD5-通道ID】组成。中间用"-"分隔开.
例如10002-admin-87373df3f89fa9932a9c6c58cc75e309-100(通道是可选值，不提供该值，系统使用默认通道),MD5不区分大小写
该值可通过GetIdentityMark函数获取. | |
| 获取网关身份识别字符串,供网关功能调用前的验证 |
| public string
GetIdentityMark(int Eid, string uid, string pwd, int
gateId) |
| 参数名称 |
参数说明 |
| Eid |
企业ID代码,个人用户为0 |
| uid |
注册时的账号 |
| pwd |
登陆密码. |
| gateId |
短信通道ID,详细请参考通道说明 |
|
|
|
| 根据错误ID号，返回详细错误描述 |
| public string
GetErrorHint(int ErrorId) |
| 参数名称 |
参数说明 |
| ErrorId |
错误的ID号。操作失败后的ID号 |
|
|
|
| 快速发送短信,直接提交到网关。本站不存储发送的任何数据 |
| public
SendResult FastSend(string eid_pwd_gateId,string No_List, string
Memo, string SendTime,string strSubId) |
| 参数名称 |
参数说明 |
| TargetNo |
发送对方的手机号码，多个用','分开。每次最多提交1000条.是否支持移动还是联通或者小灵通请参考通道说明 |
| MsgContent |
发送短信内容，长度要求请参考通道说明 |
| DateTime |
定时发送时间,必须大于当前时间.空代表立即发送 |
| strSubId |
如果通道支持子号码扩展,值为子号码.否则使用空值 |
|
|
| 返回值说明 |
| 返回SendResult类型。显示发送详细状态
/// <summary>
/// 返回发送状态，大于0代表成功
///
</summary>
属性名: RetCode
/// 被屏蔽的关键字
///
</summary>
属性名: BlackWords
///
<summary>
/// 发送失败号的码列表,","分开
///
</summary>
属性名: FailNo
///
<summary>
/// 被屏蔽的号码列表,","分开
///
</summary>
属性名： ShieldNo
///
<summary>
/// 错误的描述
///
</summary>
属性名：ErrorDesc | |
| 发送短信 |
| public int
Send(string eid_pwd_gateId, string TargetNo, string
MsgContent,string SendTime,string strSubId) |
| 参数名称 |
参数说明 |
| TargetNo |
同上 |
| MsgContent |
同上 |
| DateTime |
定时发送时间,必须大于当前时间.空代表立即发送 |
| strSubId |
同上 |
|
|
|
| 发送短信，扩展功能 |
| public
SendResult SendEx(string eid_pwd_gateId, string TargetNo, string
MsgContent, string SendTime,string strSubId) |
| 参数名称 |
参数说明 |
| TargetNo |
同上 |
| MsgContent |
同上 |
| SendTime |
定时发送时间,必须大于当前时间.空代表立即发送 |
| strSubId |
同上 |
|
|
| 返回值说明 |
|
返回SendResult类型。显示发送详细状态
/// <summary>
/// 返回发送状态，大于0代表成功
///
</summary>
属性名: RetCode
/// 被屏蔽的关键字
///
</summary>
属性名: BlackWords
///
<summary>
/// 发送失败号的码列表,","分开
///
</summary>
属性名: FailNo
///
<summary>
/// 被屏蔽的号码列表,","分开
///
</summary>
属性名： ShieldNo
///
<summary>
/// 错误的描述
///
</summary>
属性名：ErrorDesc
| |
| 接收上行短信，用哪个通道发送。必须使用哪个通道接收 |
| public string
ReadXml(string eid_pwd_gateId) |
| 参数名称 |
参数说明 |
| eid_pwd_gateId |
同上 |
|
|
| 返回值说明 |
|
返回xml类型,包含四个字段，回复者号码，回复内容。回复时间,回复到SP商的号码.没有记录返回空
返回样本
<ReadSMS>
<!--收到短信开始-->
<Item><!--如果有多条循环此节-->
<SenderNo>13405886058</SenderNo><!--回复者号码-->
<MsgContent>星信:我时工作顺利用这</MsgContent><!--回复短信内容-->
<SendTime>2008-03-14
23:07:39</SendTime><!--回复时间-->
<SP_PID>1065810889988</SP_PID>
<!-回复到SP号的号码-->
</Item>
</ReadSMS>
| |
| 查询当前账户余额 |
| public double
GetMoney(string eid_pwd_md5) |
| 参数名称 |
参数说明 |
| eid_pwd_md5 |
用户身份标识串，不需要通道ID号 |
|
|
|
| 用户修改登陆密码 |
| public int
EditPWD(string eid_pwd_md5,string newPwd) |
| 参数名称 |
参数说明 |
| eid_pwd_md5 |
用户身份标识串，不需要通道ID号 |
| newPwd |
新密码 |
|
|
| 返回值说明 |
|
1执行成功，其它值请调用错误函数获取详细信息
| |
|