SDK通用版接口调用说明
版本:2.0
第一次修订时间:2011-01-06
第二次修订时间:2011-01-14
目录
1请仔细阅读信息安全责任保证条款............. - 3 -
1.1安全信息责任条款 ..................................................................................- 3 -
1.2注意事项: ..............................................................................................- 4 - 2Webservice接口 ............................ - 4 -
2.1webservice返回集合对照表 .................................................................- 4 -
2.2Register注册 .........................................................................................- 5 -
2.3balance 查询余额 ..................................................................................- 6 -
2.4ChargUp充值 ...........................................................................................- 6 -
2.5mt 发送短信 ............................................................................................- 7 -
2.6mo接收短信 .............................................................................................- 8 -
2.7gxmt 个性发送 ........................................................................................- 9 - 3Http接口................................. - 11 -
3.1http返回集合对照表 .......................................................................... - 11 -
3.2发送短信 ............................................................................................... - 11 -
3.3接收短信 ............................................................................................... - 12 - 4DLL接口.................................. - 13 -
4.1使用流程 ............................................................................................... - 13 -
4.2Register注册 ...................................................................................... - 13 -
4.3QueryBalance查询余额 ...................................................................... - 14 -
4.4ChargeFee充值 .................................................................................... - 14 -
4.5mt 发送短信 ......................................................................................... - 14 -
4.6gxmt 发送个性短信 ............................................................................. - 15 -
4.7ReceiveSMS接收短信 .......................................................................... - 15 -
4.8UpdatePassword修改密码 .................................................................. - 16 -
4.9ReceiveSMSEx接收子号回复短信 ...................................................... - 16 -
4.10UnRegister注销账户 .......................................................................... - 16 - 5发送说明.................................. - 17 -
5.1做单发说明 ........................................................................................... - 17 -
5.2做群发说明 ........................................................................................... - 17 -
5.3编码说明 ............................................................................................... - 17 -
5.4长短信说明 ........................................................................................... - 17 -
5.5长短信扣费说明 ................................................................................... - 17 - 6接收说明.................................. - 17 -7附加说明.................................. - 18 -
7.1接口地址 ............................................................................................... - 18 -
7.2其它说明 ............................................................................................... - 18 -
7.3郑重声明 ............................................................................................... - 18 - 1请仔细阅读信息安全责任保证条款
1.1安全信息责任条款
本人/本公司在使用本软件过程中,将严格遵守国家相关法律、法规、保证本公司信息发布的安全,并切实做到:
(1)建立健全本公司信息发布的内部保障制度、信息安全保密制度、用户信息安全管理制度,建立健全本公司信息安全责任制度和信息发
布的审批制度,严格审查本公司产品所发布信息。
(2)严格遵守《互联网信息服务管理办法》,对用户编辑的信息内容进行把关,保证信息内容的健康、合法。
(3)明确本企业的客户群和客户范围,所有通讯受众必须是自愿且明确同意接受企业服务。
(4)若发送未经用户允许的信息等所造成的影响、投诉等一切损失与本软件版权方无关、由本人/本公司承担全部责任;同时,本人/本公
司也应承担若因此给本软件版权方造成的全部损失。
(5)不利用本软件制作、复制、发布、传播含有下列内容的信息:
?反对宪法所确定的基本原则的;
?危害国家安全,泄露国家秘密,颠覆国家政权,破坏国家统一的;
?损坏国家荣誉和利益的;
?煽动民族仇恨、民族歧视,破坏民族团结的;
?破坏国家民族宗教政策,宣扬邪教和封建迷信的;
?散布谣言,扰乱社会秩序,破坏社会稳定的;
?散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的;
?侮辱或者诽谤他人,侵害他人合法权益的;
?含有法律、行政法规禁止的其他内容的;
(6)自信息发布六个月内不修改删除信息发送日志内容,日志记录的备份应至少保持6个月以上,在国家机关进行依法查询时,予以提供。
(7)若发现本公司所发布的信息明显属于上述第(5)款所列内容,保证立即停止传输,并向国家有关机关报告。
(8)对本公司所发布的信息一时难以辨别是否属于以上所列内容之一的,应报相关主管部门审核同意后再发布。
(9)对客户的个人信息保密,未经客户同意不得向他人泄漏,但法律规定的除外。
本人/本公司保证:在使用本软件进行信息发布活动中,服从监督和管理;若未做到上述一至八条,本人/本公司愿意承担由此引起的一切法律责任,并接受相应的处罚。
1.2注意事项:
同一个序列号提交,必须提交到同一个SDK服务器;
同一个序列号提交,必须等上一批次返回后再提交下一批次;
相同内容,不同手机号,请使用mt,每次建议3000个手机号;
不同内容,不同手机号,请使用gxmt,每次建议1000个手机号;
为了便于技术与技术之间的沟通及后期维护事宜的及时通知,请负责开发人员将您的联系方式发至Email:haidong@https://www.doczj.com/doc/e416198542.html, 或者直接添加QQ(技术支持):531631044、1104014356.谢谢配合.
2Webservice接口
2.1webservice返回集合对照表
注:以上返回值针对个别方法.请具体参看每个用到方法的详细说明。
2.2Register注册(信息必须真实, 短信出现问题联系不上使用者后果自
负.)
注:使用序列号的第一步即激活序列号的状态.和使用者进行绑定.如不注册便发送短信会返回相应的返回值-2.除sign参数可为空其它均为必填项.请认真对待这些参数的真实性.短信出现问题联系不上使用者后果自负.
返回结果:
XML格式:
文本格式: 0 成功。
2.3balance 查询余额
函数返回值:String(余额)
示例:序列号SDK-BBX-010-00001 密码 123456
参数输入:
SN= SDK-BBX-010-00001
PWD=3B5D3C427365F40C1D27682D78BB31E0
返回结果:
XML格式:
文本格式:
79109
2.4ChargUp充值
函数返回值:string
返回结果:
XML格式:
文本格式:
0 成功。
2.5mt 发送短信
函数返回值:String(唯一标识,即当前发送短信批次的唯一标识,和rrid对应,如为空则返回系统生成的rrid)此方法推荐用于大量群发.内容相同手机号多个示例1:
输入参数:
SN= SDK-BBX-010-00001
PWD=3B5D3C427365F40C1D27682D78BB31E0
Mobile:139***404,138***213…………….
Content:测试
Ext:21(如果不是网络版,请置空)
Stime: 2009-10-19 16:34:00 (如果不需要定时,请置空)
Rrid:123456 (如果填写则系统返回填写内容,如果置空,返回系统生成的rrid)输出结果:
XML格式:
文本格式:
123456
示例2
SN= SDK-BBX-010-00001
PWD=3B5D3C427365F40C1D27682D78BB31E0
Mobile:139***404,138***213…………….
Content:测试
Ext:
Stime:
Rrid: 此处为空
输出结果:
XML格式:
文本格式:
201012300908160937。
2.6mo接收短信
函数返回值:Stirng
返回值说明:mo ID,特服号,手机号,内容(对内容进行gb2312解码),时间
如有多条回车换行隔开 \n
返回结果:
XML格式:
文本格式:
12323666,47512,152********,%b2%e2%ca%d41,2010-12-30 9:15:56
注:拆分形式为先\n拆分成数组,然后逗号拆分成数组.根据索引读出需要的数据.内容要GB2312解码。
如果发送时ext=3 用子号3发送了那么调用mo之后第二个参数47512 就变成了475123了由此可以判断用户是回复的那条短信或者哪个应用!
2.7gxmt 个性发送
函数返回值:String (唯一标识,即当前发送短信批次的唯一标识,和rrid对应,如为空则返回系统生成的rrid,此处的rrid和mt发送的rrid用法相同,此方法用于发送多条内容不相同手机号多个的情况)
需要注意:
1、手机号以英文逗号隔开
2、发送内容GB2312编码后,以英文逗号隔开,个数和手机号个数一致
3、扩展码可以为空,单个,或多个(以英文逗号隔开,个数和手机号个数一致)
4、定时时间可以为空,单个,或多个(以英文逗号隔开,个数和手机号个数一致)
返回结果:
XML格式:
示例1:
输入参数:
SN= SDK-BBX-010-00001
PWD=3B5D3C427365F40C1D27682D78BB31E0
Mobile:139***404,138***213
Content: %B2%E2%CA%D41, %B2%E2%CA%D42
Ext:(如果不是网络版,请置空)
Stime: (如果不需要定时,请置空)
Rrid:123456 (如果填写则系统返回填写内容,如果置空,返回系统生成的rrid)输出结果:
XML格式:
文本格式:
123456
示例2
SN= SDK-BBX-010-00001
PWD=3B5D3C427365F40C1D27682D78BB31E0
Mobile:139***404,138***213…………….
Content: %B2%E2%CA%D41, %B2%E2%CA%D42
Ext:
Stime:
Rrid: 此处为空
输出结果:
XML格式:
文本格式:
201012300908160937。
3Http接口
3.1http返回集合对照表
3.2发送短信
Eg: (单机版)
https://www.doczj.com/doc/e416198542.html,/z_send.aspx?sn=SDK-XXX-010-XXXXX&pwd=88888 8&mobile=135****4752&content=你好
Eg: (网络版)
https://www.doczj.com/doc/e416198542.html,/z_send.aspx?sn=SDK-XXX-010-XXXXX&pwd=88888 8&mobile=135****4752&content=你好&ext=1
sn:序列号,pwd:密码,mobile:手机号,用,隔开,content:发送内容,ext:扩展码
注1:如果是第一次使用,请先注册(注册方法请参看附加说明)
注2:HTTP方式只有发送和接收两种方法,其它方法可以通过demo或
webservice接口实现其它功能的操作
注:Get由于字符串长度限制,手机号个数请小于等于500
Post 理论是没有长度限制,但手机号一次不能超过10000.
3.3接收短信
结果说明结果说明
-2 参数错误 0 表示没有需要接受的短信
-1 操作失败-3 序列号密码错误
Eg: (单机版)
https://www.doczj.com/doc/e416198542.html,/z_receive.aspx?sn=SDK-XXX-010-XXXXX&pwd=88 8888
sn:序列号,pwd:密码
注:http方式需保证帐号是正常状态
Eg: (网络版)
https://www.doczj.com/doc/e416198542.html,/z_receive.aspx?sn=SDK-XXX-010-XXXXX&pwd=88 8888&ext=子号
sn:序列号,pwd:密码,ext:扩展码(空:接收所有子号码;0:单机版接收;
其他:接收此子号码
注:http方式需保证帐号是正常状态
返回示例:
3 3
13076525 47XXX 1520169XXXX 测试1 2011-1-13 17:51:18
13076529 47XXX 1520169XXXX 测试2 2011-1-13 17:51:24
13076532 47XXX 1520169XXXX 测试3 2011-1-13 17:51:29
返回值说明:
第一行表示总数当前行数
从第二行开始是用户回复的数据各个元素分别为:
数据id,特服号,手机号,内容,用户回复时间
行与行之间是\n 分隔各个元素之间是\t分隔一次最多返回5条记录
4DLL接口
4.1使用流程
注册组件方法:开始->运行->输入(CMD) 然后在控制台输入
regsvr32.exe空格 c:\vbsdk.dll(注:路径为vbsdk.dll的所在路径)
调用Register方法注册帐号
<注>dll只允许一个帐号在一台服务器上使用,如需多台使用,请参看webservice接口;
同一帐号,只需注册一次,如不更换服务器,不需要注销;
4.2Register注册
返回值true/false
注:使用序列号的第一步即激活序列号的状态.和使用者进行绑定.如不注册便发送短信会返回false
注册一次即可,不用重复注册,如需更换服务器先在本地上注销,然后再在其它电脑上注册。
4.3QueryBalance查询余额
函数功能:查询余额
返回值: true/false
4.4ChargeFee(软件序列号,卡号,密码)
函数功能:充值
输入参数:
函数返回值:true/false
4.5mt 发送短信
函数功能:发送短信
此方法推荐用于大量群发.内容相同手机号多个
函数返回值:true/false
4.6gxmt 发送个性短信
此方法推荐用于个性群发.即内容不同多个手机号
Content 需要gb2312编码.如果找不到GB2312的方法,请直接调用dll里的urlencoded 将需要编码的string 传入会返回编码好的字符串.
需要注意:
1、手机号以英文逗号隔开
2、发送内容GB2312编码后,以英文逗号隔开,个数和手机号个数一致
3、扩展码可以为空,单个,或多个(以英文逗号隔开,个数和手机号个数一致)
4、定时时间可以为空,单个,或多个(以英文逗号隔开,个数和手机号个数一致)
返回结果: true/false
4.7ReceiveSMS接收短信
函数功能:接收短信
输入参数:
函数返回值:true/false
(需要自定义接收变量,详看demo)
注:信息接收后不能再次接收。
4.8UpdatePassword修改密码
函数功能:更改密码
输入参数:
函数返回值:true/false
4.9ReceiveSMSEx接收子号回复短信
函数功能:接收短信
输入参数:
函数返回值:true/false
(需要自定义接收变量,详看demo)
注1:每个子号只能接收自己子号的信息,如特服号为12345,子号1只能接收123451号上的短信,ext为空串可接收所有子号MO的信息;信息接收一次便不能再接收。
注2:根据用户需求由客服开通,子号以数字1开始,不得以0开头,如01,001…
4.10UnRegister注销账户
函数功能:注销
输入参数:
函数返回值:true/false
5发送说明
5.1做单发说明
(每次提交只有一个手机号)时,在一个时间点需要发送N条
相同内容不得超过20次.如果需要发送大量的单条信息并且内容不相
同,请参考gxmt的方法;
5.2做群发说明
(提交内容相同)时,请参看mt 的使用方法,禁止连续一条一条的提交.
5.3编码说明
接口所有方法都是gb2312编码,使用时请进行相应转换
5.4长短信说明
一次提交内容最大是600字节 300汉字(建议290汉字) 此时出现长
短信的概念.
5.5长短信扣费说明
如果一次提交小于等于70字符系统会默认为一条短信发出扣费一条
如果大于70字符系统会默认为长短信处理此时根据长短信前边会
加(1/2) 或者(2/2)的标志此时扣费按65字符扣一条所以198字符
是 65*3+3 扣费4条对方如果手机支持长短信则收到一条如果不
支持长短信则收到四条(建议内容不超过290字符) 纯单字节是140
一条,没有长短信的概念。
6接收说明
●接收短信间隔最少为5秒;如对回复的短信不急需要请将间隔时间放长.
减少对数据库的压力
●接收短信每条以回车换行符(\n)分割,接收内容请进行GB2312解码;
7附加说明
7.1接口地址
地址:https://www.doczj.com/doc/e416198542.html,:8060/webservice.asmx
7.2其它说明
1.开发使用的帐号必须为SDK开头,如SDK-OFT-010-00001,帐号第一次
需要调用Register方法注册一次.仅需注册一次即可,信息必须真实
U2.nRegister与Register配合使用,连续使用不得超过10次/天;
3.群发推荐使用接口方法 mt或者mdSmsSend (仅方法名不同);
4.单发内容不同(某一时间点)推荐gxmt(具体请参看gxmt方法介绍)
7.3郑重声明
1. 禁止相同的内容多个手机号连续一条一条提交. 否则禁用帐号,由此
带来损失由客户自行负责.
2.Webservice接口地址向短信平台技术人员索取
3.所有帐号提交短信,必须提交到同一个服务器
4.所有帐号提交短信,必须等上一批提交返回后再提交下一批