亿美短信平台SDK4.2.0(WebService版)用户手册

1/16页案卷号日期亿美软通短信平台SDK4.2.0（WebService版）用户手册作者：北京亿美软件科技有限公司完成日期：2010-08-16签收人：签收日期：修改情况记录：版本号修改批准人修改人安装日期签收人北京亿美软通科技有限公司地址：北京市朝阳区光华路4号东方梅地亚中心C座20层（100026）网址：手机快捷网址：emay.m.cn电话：[phone]传真：[phone]售前咨询：400-810-7255售后服务：400-779-7255手机中文实名：亿美软通亿美移动商务2/16页目录用户手册.........................................................................11亿美软通WEBSERVICE接口开发说明.......................................................31.1简介.......................................................................................................................................................31.2背景.......................................................................................................................................................31.3定义.......................................................................................................................................................31.4开发流程................................................................................................................................................42数据结构...........................................................................52.1上行数据结构........................................................................................................................................52.2状态报告数据结构................................................................................................................................53功能介绍及使用.....................................................................63.1注册序列号............................................................................................................................................63.2注册企业信息........................................................................................................................................73.3注销序列号............................................................................................................................................93.4查询单价..............................................................................................................................................103.5序列号充值............................................................................................................错误!未定义书签。3.6发送短信..............................................................................................................................................103.7接收短信..............................................................................................................................................123.8修改密码..............................................................................................................................................133.9查询余额..............................................................................................................................................143.10状态报告………………………………………………………………………………………..123/16页1亿美软通WebService接口开发说明1.1简介亿美短信SDK：是针对独立软件开发商（ISV）和系统集成商（SI）的软件开发及技术产品服务的需求，提供的短信通讯开发组件（SDK，SoftwareDevelopmentKit)1.2背景系统名称：亿美SDK移动商务开发组件项目开发者：北京亿美软通科技有限公司1.3定义MTMessageTerminal——下行短信，即向手机终端发送短信MOMessageOriginal——上行短信，即手机用户向特服号码发送短信企业特服号码由亿美为SDK用户分配的属于该用户专用的特服号码。每个软件序列号对应一个企业特服号码。扩展号码基于企业特服号码，企业自行扩展维护的子号码（最大15位），类似电话分机号码。软件序列号由亿美分配给SDK用户，用来身份验证、计费的标识信息EUCPEmayUnifiedCommunicationPlatform——亿美统一通讯平台EUCP实现了统一的接入，提供统一的服务多运营商（中国移动、中国联通、中国网通、中国电信）的统一接入及服务提供，只需通过一个SDK接入EUCP即可统一的与上述运营商的手机用户进行短信通讯余额与SDK帐户即软件序列号对应的帐户余额，只有拥有足够的余额才能进行成功的短信4/16页收发操作KEY值默认情况下，注册序列号后，序列号会与电脑的硬件信息绑定，这样一个序列号只能在一台定机器上使用。如果设置Key值，注册序列号后，序列号不会与电脑的硬件信息绑定，这样，一个序列号就可以在多台机器上使用（不同的电脑上设置相同的Key值即可）。优先级发送短信时，可以定义短信的优先级别，重要的短信定义的优先级可以高一些，普通短信可以使用低一点的优先级。可以定义1-5共5个级别的优先级，其中1为最低优先级，5为最高优先级1.4开发流程合作伙伴必须通过亿美软通或是亿美软通代理商，取得SDK开发包和相关文档，取得供由本SDK使用的序列号及密码，这些参数将用于服务注册及短信发送。接口调用流程如下：永久执行序列号首次使用时执行一次，就像我们的信用卡一样，首次使用必须激活一次调用软件序列号注销以后，再次使用该序列号时必须重新激活运行时执行主要是发送短信接口，软件序列号激活以后便可以随时使用我们的短信发送接口，前提是软件序列号处于激活状态需要时执行需要时执行的方法，调用频率相对较低，我们可以在需要的时候调用一次啊，前提是软件序列号处于激活状态5/16页结束执行此接口一旦调用该软件序列号便不能在使用，即不能发送短信等，直到下次重新激活2数据结构2.1上行数据结构所属类：MO用途保存上行短信接口函数返回的短信内容。字段名数据类型说明mobileNumberString手机号码smsContentString内容sentTimeSting发送时间（格式为yyyy-mm-ddhi24:mi:ss）addSerialSting发送者扩展号码（只有当发送者申请扩展号码功能后，该参数才有效）addSerialRevSting接收者扩展号码（只有当接收者申请扩展号码功能后，该参数才有效）channelNumberString该字段用来接收上行短信的被叫号码2.2状态报告数据结构所属类：StatusReport用途保存状态报告接口函数返回的短信内容。字段名数据类型说明reportStatusString状态报告的值（0发送成功）mobileString手机号码submitDateSting发送时间（格式为yyyy-mm-ddhi24:mi:ss）receiveDateSting接收时间（格式为yyyy-mm-ddhi24:mi:ss）errorCodeSting未发送成功错误编码MemoSting备注serviceCodeAddSting短信下行时服务号码seqIDLong自定义唯一的消息ID，长度6位，消息流水号,顺序累6/16页加,步长为1,循环使用3功能介绍及使用3.1注册序列号功能介绍完成对序列号的注册。序列号说明(1)软件序列号首次使用必须注册，就像信用卡首次使用必须激活一样。(2)软件序列号只需注册成功一次即可，注册成功后，即使重启电脑，都不需再次注册序列号。(3)序列号注册成功后，需记住密码并妥善保管。(4)试用SDK接口时，亿美提供测试序列号，并提供适当测试余额。(5)正式应用SDK接口时，亿美提供正式序列号，在应用时，只需重新注册一次序列号即可，其它接口不变。函数声明publicintregistEx(StringsoftwareSerialNo,Stringkey,Stringserialpass)参数详解参数名称说明softwareSerialNo软件序列号，必须输入key要注册的关键字，必须输入1．用户自定义key值，长度不超过15个字符的字符串(可包含数字和字母)2．将key做好备份，不要遗忘3．请做好保密工作，因客户自身原因泄露该关键字造成的经济损失北京亿美软通科技有限公司不承担任何责任serialpass软件序列号密码，密码（6位），必须输入返回值返回值描述0注册成功7/16页101、303