短信API接口示例说明.doc

优客易通短信API
统一提交WebService 接口说明
接口地址：
电信：:6003/submitdata/Service.asmx
网通：:6003/submitdata/Service.asmx

接口源代码下载含各种主流开发语言示例：

短信提交接口
接口说明
类型
命名
描述
接口定义
g_Submit(
string sname,
string spwd,
string scorpid,
string sprdid,
string sdst,
string smsg)
提交短信
参数
sname
提交账户
参数
spwd
提交账户密码
参数
scorpid
企业代码
参数
sprdid
产品编号
参数
sdst
接收号码，多个以','分割,最大10000个号码
参数
smsg
信息内容,通常为70汉字以内，具体由平台内部决定

返回值说明
返回值CSubmitState结构说明：
命名
类型
描述
State
int
//提交结果值,返回值为0时，表示提交成功
MsgID
string
//提交结果ID，仅当提交成功后，此字段值才有意义
MsgState
string
//提交结果描述
Reserve
int
//保留，扩展用
返回值枚举
State
MsgState
0
提交/审查
6002
信息内容超长
6003
提交参数不可为空，或参数类型错误
6004
提交速度限制
6005
提交池限制
6006
接收号码异常,或号码总数超过10000
100028
帐号余额不足
100030
记录入库失败
100031
用户帐号无效
100033
用户计费失败
100045
用户没有购买该类产品
100050
IP地址不符合
100051
企业号错误
200053
数据库操作异常
201005
接收号码被过滤，【过滤类型】：【过滤号码】，【过滤类型】：【过滤号码】………..
201054
产品编号错误
201056
短信内容超长
-1
接口提交异常
其他值
提交结果未定义

说明：
针对 201005（接收号码被过滤）这个返回值时，MsgState的内容格式为
接收号码被过滤，【过滤类型】：【过滤号码】，【过滤类型】：【过滤号码】………..
【过滤类型】定义：1.号码异常 2.号码归属省份异常 3.黑名单用户
【过滤号码】定义：实际被过滤的号码

信息发送状态查询接口
接口说明
类型
命名
描述
接口定义
g_QuerySendState(
string sname,
string msgid)
查询成功提交信息的发送状态
参数
Sname
提交账户
参数
Msgid
成功提交短信后的信息编号

返回值说明
返回值CSendState结构说明：
命名
类型
描述
State
Int
//状态返回值
TelNum
Int
//提交总数
SndNum
Int
//已发送的数量
SndErr
Int
//发送失败的数量
OutFailedNum
Int
//屏蔽过滤的数量
MsgState
String
//信息包状态
Reserve
Int
//保留，扩展用
返回值枚举 
State
说明
0
成功
-1
系统异常
6004
无对应MSGID的信息记录
6007
日查询表尚未创建

用户帐号信息余量查询
接口说明
类型
命名
描述
接口定义
Sm_GetRemain(
string sname,
string spwd,
string scorpid,
string sprdid)
用户帐号信息余量查询
参数
Sname
提交账户
参数
Spwd
提交账户密码
参数
Scorpid
企业代码
参数
Sprdid
产品编号
返回值说明
返回值CRemain结构说明：
命名
类型
描述
State
Int
//状态返回值
Remain
Int
//余额
返回值枚举
State
说明
0
成功
-1
系统异常
6001
无效的帐号或密码
6012
当前的IP禁止查询
6021
无效的企业介入号
6024
帐号处于冻结状态

Web Service接口上行收取说明

如果客户需要接收用户上行，在相关的申请成功后，可以按照下面的说明进行编程接收
<%
'短信接口用户，需要自己做好上行接收数据的接口，提供如下几个参数：
'1、提供上行URL（例如： http://XXX.XXX.XXX.XXX/Up.asp）以便我们给予绑定。
'2、我们会上行3个数据,如下：
' Request("Up_YourNum") ''自己的特服号号码接口
' Request("Up_UserTel") ''客户上行的手机号码接口
' Request("Up_UserMsg") ''客户上行的短信内容接口
'
'3、用户自行写进自己的数据库，以便接收数据。
'4、下面的例子写进当地文件中

Option Explicit
dim YourNum,UserTel,UserMsg,UserTime
dim temp
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
YourNum=Request("Up_YourNum") ''特服号，取值比如106588889011
UserTel=Request("Up_UserTel") ''客户上行的手机号码，比如13912345678
UserMsg =Request("Up_UserMsg") ''客户上行的短信内容
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
UserTime=Now
UserTime=Server.HTMLEncode(UserTime)
temp=YourNum+" "+UserTel+" "+UserMsg+" "+UserTime
WriteData temp
Response.Write temp
Response.End
'''函数
Sub WriteData(Desc)
On Error Resume Next
Dim oFs,OutFile
set oFs = server.CreateObject("Scripting.FileSystemObject")
set OutFile = oFs.OpenTextFile("C:\upData.txt", 8, true)
call OutFile.writeLine(Desc)
OutFile.close
end Sub
%>