Http 接口调用帮助说明
 

说明：接口调用函数后面带“Str”字符标识表示该接口函数可以直接返回不包含XML属性的值，方便HTTP接口调用后拆分解释返回值,支持在IE浏览器上直接测试调用接口。

为增加帐户安全性，系统默认是不绑定IP,建议您测试接入正常部署在服务器后,让我们客服把您们帐户绑定您们调用的服务器IP。

注意：请不要使用多线程并发调用接口，调用接口间隔请大于200毫秒，群发可以一次提交100-500个号码。


一、UserLogin 接口调用
接口说明：帐号的合法性检测及登陆。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码 支持使用明文或MD5加密大写

返回值：int 数字型  
返回值 说明 备注
大于0 帐户信息正确 调用接口成功，返回帐户ID值
空值 调用接口失败
0 帐户处于禁止使用状态
-1 调用接口失败
-2 帐户信息错误 调用的参数有为空值
-3 用户或密码错误 机构代码、用户名或密码错误
-4 不是普通帐户 该帐户不能使接口模式调用(如：代理帐户或集团帐户等)
注：只有普通用户才能使用接口调用
-30 非绑定IP 访问IP非法

例如接口地址：http://IP:8180/service.asmx  查看调用方式，可点击网页的“UserLogin”连接查看
Http Get 调用方式：http://IP:8180/service.asmx/UserLogin?Id=string&Name=string&Psw=string


二、UserLoginStr 接口调用
接口说明：帐号的合法性检测及登陆，调用参数及返回值说明，请参考 UserLogin
      返回值：数值字符串



三、UpdatePsw 接口调用
接口说明：更改帐号密码。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
OldPsw string 旧密码
NewPsw string 新密码

返回值：int 数字型  
返回值 说明 备注
1 修改密码成功
-1 修改密码失败
其他值 参考UserLogin()返回值说明

例如接口地址：http://IP:8180/service.asmx  查看调用方式，可点击网页的“UpdatePsw ”连接查看
Http Get 调用方式：http://IP:8180/service.asmx/UpdatePsw?Id=string&Name=string&OldPsw=string&NewPsw=string


四、UpdatePswStr 接口调用
接口说明：更改帐号密码，调用参数及返回值说明，请参考 UpdatePsw。

     返回值：数值字符串



五、GetBalance 接口调用
接口说明：获取帐号余额相关信息。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码 支持使用明文或MD5加密大写

返回值：BalanceState 对象类型  
属性 类型 返回值 说明 备注
Balance int >=0 帐户短信可用数量
Sended int >=0 已发送或使用短信数量
State int  >0 调用接口成功 返回帐户ID
其他值 参考UserLogin()返回值说明
Totaled int >=0 总冲值数量


例如接口地址：http://IP:8180/service.asmx  查看调用方式，可点击网页的“GetBalance ”连接查看
Http Get 调用方式：http://IP:8180/service.asmx/GetBalance?Id=string&Name=string&Psw=string


六、GetBalanceStr 接口调用
接口说明：获取帐号余额相关信息，调用参数及返回值参数，请参考 GetBalance。
返回值：字符串，返回值各参数 以半角逗号“,”分隔，各属性名及值以半角冒号“:”分隔。

返回值例子：State:300,Balance:34744674,Sended:123,Totaled:101000000




七、SendMessage  接口调用
接口说明：接收发送短信数据。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码 支持使用明文或MD5加密大写
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
 信息内容要使用UTF-8 URL转码，否则中文内容可能会收到乱码信息。参考编码是否正常，请在自己的程序里测试下使用UTF-8编码“中文”这2个字，正确的utf-8编码后是“%e4%b8%ad%e6%96%87”，如果程序编码结果不同说明程序编码有问题了，需要修改下你的程序编码代码。
Phone string 接收号码，多个号码用半角分号“;"分隔 1.每次调用接收号码数量不能超过1000个(建议100个/次调用)。

2.同批次发送短信号码超过1000个请折分多次调用，调用时设置时间戳相同。
Timestamp int 时间戳,从1970-01-01 00:00:00 到要现在发送时间隔的秒数 可默认为0

返回值：SendState 对象类型  
属性 类型 返回值 说明 备注
FailPhone string 失败号码 返回发送失败的号码 多个失败号码之间以半角分号“;"分隔
Id int 批号 返回服务器保存发送短信的批号ID
State int  1 发送短信成功
-1 发送失败
-5 发送短信内容为空
-6 短信内容过长 长短信内容字数长度超过系统限定的长度
-7 发送号码为空
-8 余额不足
-9 接收数据失败
-10 发送失败 号码错误
-13 内容信息含关键字
-14 信息内容格式与限定格式不符 如帐户限定只能发指定格式信息内容，提交其他信息会返回该失败值
-15 信息没带签名 如帐户限定信息内容须带签名，提交没包含签名的信息会返回该失败值

签名一般是取自己公司简称，要用【】括起来，如：【签名】您的验证码是：12345
-16 黑名单号码 发送号码在黑名单库中
-100 客户端获取状态失败(系统预留)
其他值 参考UserLogin()返回值说明


例如接口地址：http://IP:8180/service.asmx  查看调用方式，可点击网页的“SendMessage”连接查看
Http Get 调用方式：http://IP:8180/service.asmx/SendMessage?Id=string&Name=string&Psw=string&Message=string&Phone=string&Timestamp=string

注意：Phone多个号码须要使用半角分号分隔，Message内容信息要使用UTF-8 URL转码


八、SendMessageStr  接口调用
接口说明：接收发送短信数据，调用参数及返回值参数，请参考 SendMessage。


返回值：字符串，返回值各参数 以半角逗号“,”分隔，各属性名及值以半角冒号“:”分隔。

返回值例子：State:1,Id:35,FailPhone:134123456;1367259360




九、SendTimer  接口调用
接口说明：接收定时发送短信数据。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码 支持使用明文或MD5加密大写
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
 信息内容要使用UTF-8 URL转码，否则中文内容可能会收到乱码信息。参考编码是否正常，请在自己的程序里测试下使用UTF-8编码“中文”这2个字，正确的utf-8编码后是“%e4%b8%ad%e6%96%87”，如果程序编码结果不同说明程序编码有问题了，需要修改下你的程序编码代码。
Phone string 接收号码，多个号码用半角分号“;"分隔 每次号码数量不能超过1000个
DaeTime String 定时短信发送的时间
(格式：2010-03-08 10:20:00)		 定时时间必须大于当前调用时间。
Timestamp int 时间戳,从1970-01-01 00:00:00 到要现在发送时间隔的秒数 可默认为0

返回值：SendState 对象类型  
属性 类型 返回值 说明 备注
FailPhone string 失败号码 返回发送失败的号码 多个失败号码之间以半角分号“;"分隔
Id int 批号 返回服务器保存发送短信的批号ID
State int  1 定时短信成功
-1 定时失败
-5 定时发送短信内容为空
-6 短信内容过长 长短信内容字数长度超过系统限定的长度
-7 发送号码为空
-8 余额不足
-9 接收数据失败
-10 定时发送失败 发送号码错误
-11 定时发送时间或格式错误 (格式：2010-03-08 10:20:00)
-12 定时发送时间失败 定时时间必须大于当前调用时间。
-13 内容信息含关键字
-14 信息内容格式与限定格式不符 如帐户限定只能发指定格式信息内容，提交其他信息会返回该失败值
-15 信息没带签名 如帐户限定信息内容须带签名，提交没包含签名的信息会返回该失败值

签名一般是取自己公司简称，要用【】括起来，如：【签名】您的验证码是：12345
-16 黑名单号码 发送号码在黑名单库中
-100 客户端获取状态失败(系统预留)
其他值 参考UserLogin()返回值说明
 



例如接口地址：http://IP:8180/service.asmx  查看调用方式，可点击网页的“SendTimer ”连接查看
Http Get 调用方式：http://IP:8180/service.asmx/SendTimer?Id=string&Name=string&Psw=string&Message=string&Phone=string&SendTime=string&Timestamp=string

注意：Phone多个号码须要使用半角分号分隔，Message内容信息要使用UTF-8 URL转码



十、SendTimerStr 接口调用
接口说明：接收定时发送短信数据，调用参数及返回值参数，请参考 SendTimer 。

返回值：字符串，返回值各参数 以半角逗号“,”分隔，各属性名及值以半角冒号“:”分隔。

返回值例子：State:1,Id:35,FailPhone:134123456;1367259360



十一、SendMessageExt接口调用
接口说明：带自定义扩展子号接收发送短信数据，调用参数及返回值参数，请参考WebService SendMessageExt。 
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
 信息内容要使用UTF-8 URL转码，否则中文内容可能会收到乱码信息。参考编码是否正常，请在自己的程序里测试下使用UTF-8编码“中文”这2个字，正确的utf-8编码后是“%e4%b8%ad%e6%96%87”，如果程序编码结果不同说明程序编码有问题了，需要修改下你的程序编码代码。
Phone string 接收号码，多个号码用半角分号“;"分隔 1.每次调用接收号码数量不能超过1000个(建议100个/次调用)。

2.同批次发送短信号码超过1000个请折分多次调用，调用时设置时间戳相同。
Timestamp int 时间戳,从1970-01-01 00:00:00 到要现在发送时间隔的秒数 同批次短信，时间戳要相同
Ext string 自定义扩展子号 数字值,最多6位,需运营商支持

返回值：SendState 对象类型  
属性 类型 返回值 说明 备注
FailPhone string 失败号码 返回发送失败的号码 多个失败号码之间以半角分号“;"分隔，如是失败-13，返回是包含的关键字
Id int 批号 返回服务器保存发送短信的批号ID
State int  1 发送短信成功
-1 发送失败
-5 发送短信内容为空
-6 短信内容过长 长短信内容字数长度超过系统限定的长度
-7 发送号码为空
-8 余额不足
-9 接收数据失败
-10 发送失败 号码错误
-13 内容信息含关键字
-14 信息内容格式与限定格式不符 如帐户限定只能发指定格式信息内容，提交其他信息会返回该失败值
-15 信息没带签名 如帐户限定信息内容须带签名，提交没包含签名的信息会返回该失败值

签名一般是取自己公司简称，要用【】括起来，如：【签名】您的验证码是：12345
-16 黑名单号码 发送号码在黑名单库中
-100 客户端获取状态失败(系统预留)
其他值 参考UserLogin()返回值说明




十二、SendMessageStrExt接口调用
接口说明：带自定义扩展子号接收发送短信数据，调用参数及返回值参数，请参考 SendMessageExt 。

返回值：字符串，返回值各参数 以半角逗号“,”分隔，各属性名及值以半角冒号“:”分隔。

返回值例子：State:1,Id:35,FailPhone:134123456;1367259360