案卷号
日期
亿美软通短信平台SDK4.2.0(WebService版)
用户手册
作者:北京亿美软件科技有限公司
完成日期:2010-08-16
签收人:
签收日期:
修改情况记录:
版本号修改批准人修改人安装日期签收人
北京亿美软通科技有限公司
地址:北京市朝阳区光华路4号东方梅地亚中如何开展网络营销 心C座20层()
网址:手机快捷网址:
电话:010-传真:010-
售前咨询:400-810-7255售后服务:400-779-7255
手机中文实名:亿美软通亿美移动商务
目录
用户手册........................................................错误!未定义书签。
1亿美软通WEBSERVICE接口开发说明......................................错误!未定义书签。
1.1简介.....................................................................................................................错误!未定义书签。
1.2背景.....................................................................................................................错误!未定义书签。
1.3定义.....................................................................................................................错误!未定义书签。
1.4开发流程..............................................................................................................错误!未定义书签。
2数据结构..........................................................错误!未定义书签。
2.1上行数据结构......................................................................................................错误!未定义书签。
2.2状态报告数据结构.菱角的功效与作用 .............................................................................................错误!未定义书签。
3功能介绍及使用..............孩子培养 ......................................错误!未定义书签。
3.1注册序列号..........................................................................................................错误!未定义书签。
3.2注册企业信息......................................................................................................错误!未定义书签。
3.3注销序列号..........................................................................................................错误!未定义书签。
3.4查询单价..............................................................................................................错误!未定义书签。
3.5序列号充值..........................................................................................................错误!未定义书签。
3.6发送短信..............................................................................................................错误!未定义书签。
3.7接收短信..............................................................................................................错误!未定义书签。
3.8修改密码..............................................................................................................错误!未定义书签。
3.9查询余额..............................................................................................................错误!未定义书签。
3.10状态报告………………………………………………………………………………………..12
3/15页
1亿美软通WebService接口开发说明
1.1简介
亿美短信SDK:是针对独立软件开发商(ISV)和系统集成商(SI)的软件开发
及技术产品服务的需求,提供的短信通讯开发组件(SDK,SoftwareDevelopmentKit)
1.2背景
系统名称:亿美SDK移动商务开发组件
项目开发者:北京亿美软通科技有限公司
1.3定义
MTMessageTerminal——下行短信,即向手机终端发送短信
MOMessageOriginal——上行短信,即手机用户向特服号码发送短信
企业特服号码由亿美为SDK用户分配的属于该用户专用的特服号码。每个
软件序列号对应一个企业特服号码。
扩展号码基于企业特服号码,企业自行扩展维护的子号码(最大15位),类似电话分机号码。
软件序列号由亿美分配给SDK用户,用来身份验证、计费的标识信息
EUCPEmayUnifiedCommunicationPlatform——亿美统一通讯平台
EUCP实现了统一的接入,提供统一的服务
多运营商(中国移动、中国联通、中国网通、中国电信)的统一接入及服务提供,
只需通过一个SDK接入EUCP即可统一的与上述运营商的手机用户进行短信通讯
余额与SDK帐户即软件序列号对应的帐户余额,只有拥有足够的余额才能进行成功的短信
收发操作
KEY值默认情况下,注册序列号后,序列号会与电脑的硬件信息绑定,这样一个序列号只
能在一台定机器上使用。如果设置Key值,注册序列号后,序列号不会与电脑的硬件信息绑定
,这样,一个序列号就可以在多台机器上使用(不同的电脑上设置相同的Key值即可)。
优先级发送短信时,可以定义短信的优先级别,重要的短信定义的优先级可以高一些,普通短
信可以使用低一点的优先级。可以定义1-5共5个级别的优先级,其中1为最低优先级,5为最高
优先级
1.4开发流程
合作伙伴必须通过亿美软通或是亿美软通代理商,取得SDK开发包和相关文档,
取得供由本SDK使用的序列号及密码,这些参数将用于服务注册及短信发送。
接口调用流程如下:
永久执行
序列号首次使用时执行一次,就像我们的信用卡一样,首次使用必须激活一次
调用软件序列号注销以后,再次使用该序列号重庆涉外商贸学院 时必须重新激活
运行时执行
主要是发送短信接口,软件序列号激活以后便可以随时使用我们的短信发送接口,前提是软件序
列号处于激活状态
需要时执行
需要时执行的方法,调用频率相对较低,我们可以在需要的时候调用一次啊,前提是软件序列号
处于激活状态
5/15页
结束执行
此接口一旦调用该软件序列号便不能在使用,即不能发送短信等,直到下次重新激活
2数据结构
2.1上行数据结构
所属类:MO
用途保存上行短信接口函数返回的短信内容。
字段名数据类型说明
mobileNumberString手机号码
smsContentString内容
ntTimeSting
发送时间(格式为yyyy-mm-ddhi24:mi:ss)
addSerialSting发送者扩展号码(只有当发送者申请扩展号码功能后,
该参数才有效)
addSerialRevSting接收者扩展号码(只有当接收者申请扩展号码功能后,
该参数才有效)
channelNumberString该字段用来接收上行短信的被叫号码
2.2状态报告数据结构
所属类:StatusReport
用途保存状态报告接口函数返回的短信内容。
字段名数据类
型
说明
reportStatus
String
状态报告的值(0发送成功)
mobile
String
手机号码
submitDate
Sting
发送时间(格式为yyyy-mm-ddhi24:mi:ss)
receiveDate
Sting
接收时间(格式为yyyy-mm-ddhi24:mi:ss)
errorCode
Sting
未发送成功错误编码
Memo
Sting
备注
rviceCodeAdd
Sting
短信下行时服务号码
qID
Long
自定义唯一的消息ID,长度6位,消息流水号,顺序累
加,步长为1,循环使用
3功能介绍及使用
3.1注册序列号
功能介绍
完成对序列号的注册。
序列号说明
(1)软件序列号首次使用必须注册,就像信用卡首次使用必须激活一样。
(2)软件序列号只需注册成功一次即可,注册成功后,即使重启电脑,都不需再次注册序列号。
(3)序列号注册成功后,需记住密码并妥善保管。
(4)试用SDK接口时,亿美提供测试序列号,并提供适当测试余额。
(5)正式应用SDK接口时,亿美提供正式序列号,在应用时,只需重新注册一次序列号即可,其它接
口不变。
函数声明
publicintregistEx(StringsoftwareSerialNo,Stringkey,String
rialpass)
参数详解
参数名称说明
softwareSerialNo软件序列号,必须输入
key要注册的关键字,必须输入
1.用户自定义key值,长度不超过15个字符的
字符串(可包含数字和字母)
2.将key做好备份,不要遗忘
3.请做好保密工作,因客户自身原因泄露该关键
字造成的经济损失北京亿美软通科技有限公司不承
担任何责任
rialpass软件序列号密码,密码(6位),必须输入
返回值
返回值描述
0注册成功
7/15页
101、303客户端网络故障
305服务器端返回错误,错误的返回值(返回值不是数字字符
串)
999操作频繁
-1
系统异常
-2
客户端异常
-101
命令不被支持
-104
请求超过限制
-110
号码注册激活失败
-126
路由信息失败
-190
数据操作失败
-1100
序列号错误,序列号不存在内存中,或尝试攻击的用户
-1103
序列号Key错误
-1102
序列号密码错误
-1104
路由失败,请联系系统管理员
-1105
注册号状态异常,未用1
-1107
注册号状态异常,停用3
-1108
注册号状态异常,停止5
-1901
数据库插入操作失败
-9001
序列号格式错误
-9002
密码格式错误
-9025
客户端请求sdk5超时
-9003
客户端Key格式错误
3.2注册企业信息
功能介绍
用户序列号激活以后便可以通过该接口注册自己的详细信息,如果要修企业的某个
信息,那么可重新调用该接口
函数声明
publicintregistDetailInfo(StringsoftwareSerialNo,StringrialPwd,
StringeName,Stringinkman,StringphoneNum,Stringmobile,古玉
Stringemail,Stringfax,Stringaddress,Stringpostcode)
参数详解
参数名称说明
softwareSerialNo软件序列号
key关键字key,必须和软件序列号注册的key一致
eName企业名称(最多60字节),必须输入
linkMan联系人姓名(最多20字节),必须输入
phoneNum联系电话(最多20字节),必须输入
mobile联系手机(最多15字节),必须输入
email电子邮件(最多60字节),必须输入
fax联系传真(最多20字节),必须输入
address公司地址(最多60字节),必须输入
postcode邮政编码(最多6字节),必须输入
返回值
返回值描述
0注册企业信息成功
101、303客户端网络故障
305服务器端返回错误,错误的返回值(返回值不是数字字符
串)
307目标电话号码不符合规则,电话号码必须是以0、1开头
999操作频繁
-1系统异常
-2
客户端异常
-101
命令不被支持
-104请求超过限制
-111
企业注册失败
-126
路由信息失败
-190
数据操作失败
-1104
路由失败请联系系统管理员
-1901
数据库插入操作失败
-9001
序列号格式错误
-9002
密码格式错误
-9003
客户端Key格式错误
-9005
公司地址格式错误
9/15页
-9006
企业中文名格式错误
-9007
企业中文名简称格式错误
-9008
邮件地址格式错误
-9009
企业英文名格式错误
-9010
企业英文名简称格式错误
-9011
传真格式错误
-9012
联系人格式错误
-9013
联系电话
-9014
邮编格式错误
-9025
客户端请求sdk5超时
3.3注销序列号
功能介绍
软件注销返回0为成功(软件注销之后可以重新注册,余额保持注销前状态),软件注
销以后必须重新激活才能使用短信发送接口
函数声明
publicintlogout(StringsoftwareSerialNo,Stringkey)
参数详解
返回值描述,其它的请参见第四章
softwareSerialNo软件序列号
key关键字key,和软件注册时的关键字必须一致
返回值
返回值描述
0注销成功
101、303客户端网络故障
305服务器端返回错误,错误的返回值(返回值不是数字
字符串)
999操作频繁
-1系统异常
-2客户端异常
-101
命令不被支持
-104请求超过限制
-122
号码注销激活失败
-126
路由信息失败
-1104
路由信息失败,请联系系统管理员
-190
数据操作失败
-1902
数据库更新操作失败
-9001
序列号格式错误
-9002
密码格式错误
-9003
客户端Key格式错误
-9025
客户端请求sdk5超时
-1100
序列号错误,序列号不存在内存中,或尝试攻
击的客户
3.4查询单价
功能介绍
获取发送一条短信所需要的费用
函数声明
publicdoublegetEachFee(StringsoftwareSerialNo,Stringkey)
参数详解
参数名称说明
softwareSerialNo软件序列号
key关键字,必须和软件注册时的关键字保持一致
返回值:单价
3.5序列号充值
功能介绍
获得充值卡后,调用此方法传入您的序列号KEY,卡号及密码即可对该序列号充
值。
函数声明
publicintchargeUp(StringsoftwareSerialNo,Stringkey,StringcardNo,String
cardPass)
参数详解
参数名称说明
softwareSerialNo软件序列号
key关键字,和软件注册的关键字必须一致
11/15页
cardNo充值卡号
cardPass
充值卡密码
返回值
返回值描述
0充值成功
101、303客户端网络故障
305服务器端返回错误,错误的返回值(返回值不是数字
字符串)
999操作频繁
-1系统异常
-2客户端异常
-101命令不被支持
-104请求超过限制
-126路由信息失败
-190数据操作失败
-9001序列号格式错误
-9002密码格式错误
-9003客户端Key格式错误
-113充值失败
-1131充值卡无效
-1132充值密码无效
-1133充值卡绑定异常
-1134充值状态无效
-1135充值金额无效
-1902数据更新操作失败
-9023充值卡号格式错误
-9024充值密码格式错误
-9025客户端请求sdk5超时
3.6发送短信
功能介绍
短信发送函数,可发送即时短信,也可发送定时短信,当ndTime不为空且是
正确的时间各式,那么该条短信就是定时短信;当ndTime值为空时,则为即
时短信。
函数声明
publicintndSMS(StringsoftwareSerialNo,Stringkey,StringndTime,
String[]mobiles,StringsmsContent,StringaddSerial,
StringsrcChart,intsmsPriority,longsmsID)
参数详解
参数名称说明
softwareSerialNo软件序列号
key
用户自定义key值,长度不超过15个字符字,和软件
序列号注册时的关键字保持一致
ndTime
定时短信的定时时间,格式为:年年年年月月日日时时分
分秒秒,例如:010代表2009年5月4日11时10分10
秒,短信会在指定的时间发送出去
ndTime值为空时,为即时发送短信
ndTime值不为空时,为定时发送短信
mobiles
手机号码(字符串数组,最多为200个手机号码)
smsContent
短信内容(最多500个汉字或1000个纯英文,emay服务
器程序能够自动分割;亿美有多个通道为客户提供服务,
所以分割原则采用最短字数的通道为分割短信长度的规
则,请客户应用程序不要自己分割短信以免造成混乱)
addSerial
扩展号码(长度小于15的字符串)用户可通过附加码自
定义短信类别
扩展号码的功能,需另外申请,当未申请扩展号码功能
时,该参数默认为空值即可。
srcChart
字符编码,默认为"GBK"
smsPriority
短信等级,范围1~5,数值越高优先级越高
smsID
短信ID,自定义唯一的消息ID,数字习欢 位数最大19位,
与状态报告ID一一对应,需用户自定义ID规则确保ID
的唯一性。如果smsID为0将获取不到相应的状态报告
信息。
返回值
返回值描述
0短信发送成功
305服务器端返回错误,错误的返回值(返回值不是数字字符
串)
101、303客户端网络故障
307目标电话号码不符合规则,电话号码必须是以0、1开头
997平台返回找不到超时的短信,该信息是否成功无法确定
13/15页
998由于客户端网络问题导致信息发送超时,该信息是否成功下发无法确
定
-1
系统异常
-2
客户端异常
-101
命令不被支持
-104
请求超过限制
-117
发送短信失败
-127
没有余额
-128
余额不足
-1104
路由失败,请联系系统管理员
-9016
发送短信包大小超出范围
-9017
发送短信内容格式错误
-9018
发送短信扩展号格式错误
-9019
发送短信优先级格式错误
-9020
发送短信手机号格式错误
-9021
发送短信定时时间格式错误
-9022
发送短信唯一序列值错误
-9001
序列号格式错误
-9002
密码格式错误
-9003
客户端Key格式错误
-9025
客户端请求sdk5超时
3.7接收短信
功能介绍
从EUCP平台接收手机用户上行的短信,返回上行短信,该list的每个元素为一个冰心是谁
MO。
接收短信需要申请才可使用。
函数声明
publicList
参数详解
参数说明
softwareSerialNo软件序列号
key关键字,必须和注册时的关键字保持一致
返回值
返回结果说明
List
结构请参考数据结构部分
3.8修改密码
功能介绍
修改软件序列号的密码
函数声明
publicintrialPwdUpd(StringsoftwareSerialNo,Stringkey,String
rialPwd,StringrialPwdNew)
参数详解
参数名称说明
softwareSerialNo软件序列号
key关键字
rialPwd旧密码
rialPwdNew新密码,6位,必须是数字字符串,必须输入
返回值
返回值描述
0密码修改成功
101、303客户端网络故障
305服务器端返回错误,错误的返回值(返回值不是数字
字符串)
308新密码不是数字,必须是数字
999操作频繁
-1
系统异常
-2
客户端异常
-101
命令不被支持
-104
请求超过限制
-120
修改密码失败
-9025
客户端请求sdk5超时
15/15页
-9015
新密码格式错误
-9001
序列号格式错误
-9002
密码格式错误
-9003
客户端Key格式错误
3.9查询余额
功能介绍
获得序列号当前余额
函数声明
publicdoublegetBalance(StringsoftwareSerialNo,Stringkey)throws
Exception
参数详解
参数名称说明
softwareSerialNo软件序列号
key关键字,必须和软件注册时的关键字保持一致
返回值:余额。
3.10接收状态报告
功能介绍
接收短信发送状态报告
函数声明
publicList
参数详解
参数说明
softwareSerialNo软件序列号
Key关键字,必须和注册时的key保持一致
返回值
返回结果说明
List
StatusReport对象,StatusReport的结构请
参考数据结构部分
本文发布于:2023-03-17 17:35:46,感谢您对本站的认可!
本文链接:https://www.wtabcd.cn/fanwen/zuowen/1679045747290136.html
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
本文word下载地址:电脑发送短信软件.doc
本文 PDF 下载地址:电脑发送短信软件.pdf
留言与评论(共有 0 条评论) |