Web Service 接口调用帮助说明

 

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

 


 

一、UserLogin(int Id, string Name, string Psw) 接口调用
接口说明：帐号的合法性检测及登陆。
参数 类型 说明 备注
Id int 机构代码 　
Name string 帐户名 　
Psw string 密码 　

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



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

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




三、GetBalance(int Id, string Name, string Psw) 调用
接口说明：获取帐号余额相关信息。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码

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



四、SendMessage(int Id, string Name, string Psw, string Message, string Phone, int Timestamp) 调用
接口说明：接收发送短信数据。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
Phone string 接收号码，多个号码用半角分号“;"分隔 1.每次调用接收号码数量不能超过1000个(建议100个/次调用)。

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

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

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



五、SendTimer(int Id, string Name, string Psw, string Message, string Phone,String DateTime, long Timestamp) 调用
接口说明：接收定时发送短信数据。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
Phone string 接收号码，多个号码用半角分号“;"分隔 每次号码数量不能超过1000个
DaeTime String 定时短信发送的时间
(格式：2010-03-08 10:20:00)		 定时时间必须大于当前调用时间。
Timestamp int 时间戳,从1970-01-01 00:00:00 到要现在发送时间隔的秒数 同批次定时短信，时间戳要相同

返回值：SendState 对象类型  
属性 类型 返回值 说明 备注
FailPhone string 失败号码 返回发送失败的号码 多个失败号码之间以半角分号“;"分隔，如是失败-13，返回是包含的关键字
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()返回值说明



六、SendMessageExt(int Id, string Name, string Psw, string Message, string Phone, int Timestamp,string Ext) 调用
接口说明：接收发送短信数据,带自定义扩展子号功能,扩展子号最多6位,需运营商支持。
参数 类型 说明 备注
Id int 机构代码
Name string 帐户名
Psw string 密码
Message string 短信内容，长短信建议不超过300字数的长度，具体长短信支持最大字数请咨询客服
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()返回值说明