华录亿动短信接口文档

1、企业短信平台企业API接口说明华录亿动2013-05-21版本时间更新内容更新人1.02010-08-11文档成立李2.02010-08-111.扩展发送接口函数,增加了如下功能:a. 使用基本参数的形式发送短信;b. 通过xml的形式组织短信并发送;c. 支持多号码发送,号码间用逗号分隔,号码类别(即各运营商号码,如:小灵通手机)可混合发送同一条信息;d. 支持回执确认的操作.e. 支持上行获取的操作;f. 返回格式更新为XML的模式,以存放更丰富的返回信息,如:发送状态报告,获取上行;g. 查询用户余额。e. 添加彩信发送功能f. 添加彩信获取状态报告李3.02013-05-211、 修改

2、文档中出现的错误2、 调整文档中参数列表的顺序，方便用户调用3、 添加.net调用方法简单介绍闫卫新目 录1企业API接口31.1接口函数说明31.1.1发送消息函数sendSmsAsXml41.1.2发送消息函数sendLongSmsAsXml41.1.3发送消息函数sendSmsAsNormal51.1.4发送消息函数sendSmsAsNormal1（支持用户扩展）61.1.5发送消息函数sendLongSmsAsNormal61.1.6发送任务状态查询getSmsStates71.1.7发送彩信sendMms71.1.8彩信发送状态查询getMmsStates81.1.9接收消息函数ge

3、tMoList91.1.10接收消息函数getMoList1101.1.11查询余额getAmount101.2企业接口调用方式111.2.1C#中的调用111.2.2PHP中的调用111.2.3Java的调用方式131.2.4彩信的调用方式141 企业API接口企业API接口的实现使用了WebService的方式，企业用户通过调用WebService的指定接口函数以达到发送和接收短信的目的；企业接口的服务地址为： 要查看接口的定义的话则在连接地址下面增加“?WSDL”，即：1.1 接口函数说明企业接口中提供了常用的短信函数如下：sendSmsAsXml函数为通过基本参数发送消息sendLon

4、gSmsAsXml 函数为通过基本参数发送长消息（遗留接口，可直接调用sendSmsAsXml）sendSmsAsNormal函数为通过XML发送消息sendLongSmsAsNormal 函数为通过XML发送长消息(遗留接口，可直接调用SendSmsAsNormal)sendLongSmsAsNormal1发送短信，支持扩展的方法getSmsStates函数为获取状态报告sendMms 函数为发送彩信getMmsStates 函数为获取彩信状态报告getMoList函数为获取上行getMoList1函数为获取上行,xml有目的号码字段getAmount函数为查询余额1.1.1 发送消息函数s

5、endSmsAsXml函数定义如下：public String sendSmsAsXml(String smsPack, String cpid, String cppwd)函数参数有三个：参数名说明smsPackXml格式数据包（电话号，短信内容，流水号），sms节点为根节点,。msg表示一个短信包。phone节点为接收号码,号码间用逗号”,”分隔.可支持最大50个号码。content节点为内容节点，内容无字数限制，低于70按一条计费，多余70字按65字一条计费，最多支持300字。spnumber节点为对应的流水号节点，此节点将用来匹配状态报告。chid节点为预留节点，用来作为扩展节点。cp

6、id分配给企业用户的登录名cppwd分配给企业用户的对应密码对于smsPack结构如下:<?xml version="1.0" encoding="utf-8" ?><sms> <msg> <phone>13811111111</phone> <content>xxxxxxxxxx</content> <spnumber>短信流水号</spnumber><chid>0</chid> </msg&

7、gt; <msg> . </msg></sms>返回值及其含义如下:statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.2 发送消息函数sendLongSmsAsXml（遗留接口）函数定义如下：public String sendLongSmsAsXml (String smsPack, String cpid, String cppwd)函数参数有三个：参数名说明smsPackXml格式数据包（电话号，短信内容，流水号），sms节点为根节点,。msg表示一个短信包。phone节点为接收号码,号码间用逗号”,”分隔.可支持最大5

8、0个号码。content节点为内容节点，内容无字数限制，低于70按一条计费，多余70字按65字一条计费，最多支持300字。spnumber节点为对应的流水号节点，此节点将用来匹配状态报告。chid节点为预留节点，用来作为扩展节点。cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码对于smsPack结构如下:<?xml version="1.0" encoding="utf-8" ?><sms> <msg> <phone>13811111111</phone>

9、 <content>xxxxxxxxxx</content> <spnumber>短信流水号</spnumber><chid>0</chid> </msg> <msg> . </msg></sms>返回值及其含义如下:statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.3 发送消息函数sendSmsAsNormal函数定义如下：public String sendSmsAsNormal(String phone, String msgcont,

10、String spnumber,String chid, String cpid, String cppwd);函数的参数有六个：参数名说明phone发送的手机号码，多个号码使用”,”分开，最多支持50个号码msgcont需要发送的内容，内容最多300字，低于70按一条收费多于70系统自动拆分成多条并按65字计费。spnumber流水号，用来匹配状态报告。chid预留字段，默认为0cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回参数如下：statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.4 发送消息函数sendSmsAsNormal1（支持用

11、户扩展）函数定义如下：public String sendSmsAsNormal1(String phone, String msgcont, String spnumber,String chid, String cpid, String cppwd,String extend);函数的参数有六个：参数名说明phone发送的手机号码，多个号码使用”,”分开，最多支持50个号码msgcont需要发送的内容，内容最多300字，低于70按一条收费多于70系统自动拆分成多条并按65字计费。Spnumber流水号，用来匹配状态报告。Chid预留字段，默认为0Cpid分配给企业用户的登录名cppwd分配

12、给企业用户的对应密码Extend扩展小号（不超过5位，可以为空），例如设置extend为1001，扩展会在显示的时候追加到发送号码上，比如发送的号码是106902588，启用扩展后用户那里显示的会是1069025881001返回参数如下：statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.5 发送消息函数sendLongSmsAsNormal（遗留接口）函数定义如下：public String sendLongSmsAsNormal (String phone, String msgcont, String spnumber,String chid, String

13、 cpid, String cppwd);函数的参数有六个：参数名说明phone发送的手机号码，多个号码使用”,”分开，最多支持50个号码msgcont需要发送的内容，内容最多300字，低于70按一条收费多于70系统自动拆分成多条并按65字计费。spnumber流水号，用来匹配状态报告。chid预留字段，默认为0cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回参数如下：statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.6 发送任务状态查询getSmsStates函数定义如下：public String getSmsStates(String

14、cpid,String cppwd)函数的参数有两个：参数名说明cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回结果为一个XML列表对象<?xml version="1.0" encoding="utf-8" ?> <smsResult><result> < spnumber >短信流水号</ spnumber > <phone>手机号码</phone> <status>DELIVRD</status> <sendtime

15、>20101102000000</sendtime> </result> </smsResult>Spnumber：下发时对应的流水号Phone： 下发时对应的手机号码Status：表示短信对应的结果:DELIVRD成功其他 失败Sendtime：节点为下发时的时间1.1.7 发送彩信sendMms函数定义如下：public String sendMms(String smsPack, String cpid, String cppwd)函数的参数有两个：参数名说明smsPack彩信数据包为XML格式cpid分配给企业用户的登录名cppwd分配给企业用

16、户的对应密码smsPack为一个XML列表对象<?xml version="1.0" encoding="utf-8" ?><mms> <phone>13811111111</phone> <spnumber>短信流水号</spnumber> <subject>这是一个测试</subject> <chid></chid>    <pages>  

17、60;    <page dur=”50”>         <img type=” gif”>base64编码</img>          <text>这是第1屏中的文字</text>       </page>    &#

18、160;  <page dur=”30”>          <img type=” jpeg”>base64编码</img>          <text>这是第2屏中文字</text>       </page>  </pages></mms&g

19、t;Pages下面可以由多个page节点，每一个节点代表一个彩信屏。1. 每一屏中只能有一个图片img和一个文字text 节点，图片在上。或者仅有一个图片，或者仅有一段文字。2. 图片节点中的内容就是图片文件内容的base64编码。3. 图片的格式可以采用gif和jepg两种。4. 图片的宽度是以内，高度在以内。5. 所有的图片和文字的总大小不能超过（建议在之内，有些手机不能显示超过的彩信）彩信屏数没有太多的限制，建议在制作端限制在屏之内（有的手机显示不了屏以上的彩信）返回参数如下：statusmessage0发送成功及成功的信息描述其他对应响应的错误信息1.1.8 彩信发送状态查询getMm

20、sStates函数定义如下：public String getMmsStates(String cpid,String cppwd)函数的参数有三个：参数名说明cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回参数如下：<?xml version="1.0" encoding="utf-8" ?> <smsResult><result><spnumber>0</spnumber> <phone>手机号码</phone> <status>DEL

21、IVRD</status> <sendtime>20130322163620</sendtime> </result> </smsResult>Spnumber：下发时对应的流水号Phone： 下发时对应的手机号码Status：表示短信对应的结果:DELIVRD成功其他 失败Sendtime：节点为下发时的时间1.1.9 接收消息函数getMoList函数定义如下：public String getMoList(String nextId, String cpid, String cppwd);函数的参数有三个：参数名说明nextId

22、预留字段，默认为0cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回参数如下：<?xml version="1.0" encoding="utf-8" ?> <moResult><result> <phone>手机号码</phone> <content>1000</ content > <datetime>20101102000000</ datetime > </result> </moResult >P

23、hone：上传用户的手机号码。Content：用户上传的内容。Datetime：用户上传时的时间。1.1.10 接收消息函数getMoList1函数定义如下：public String getMoList(String nextId, String cpid, String cppwd);函数的参数有三个：参数名说明nextId预留字段，默认为0cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码返回参数如下：<?xml version="1.0" encoding="utf-8" ?> <moResult><r

24、esult> <phone>手机号码</phone> <content>1000</ content > <datetime>20101102000000</ datetime > <dest>1065700089123</dest> </result> </moResult >phone：上传用户的手机号码。content：用户上传的内容。datetime：用户上传时的时间。dest：上行目的号码1.1.11 查询余额getAmount函数定义如下：public St

25、ring getAmount(String cpid, String cppwd, String chid)函数的参数有三个：参数名说明cpid分配给企业用户的登录名cppwd分配给企业用户的对应密码chid预留字段，默认为0。返回值：数字，即剩余的条数1.2 企业接口调用方式企业接口函数的调用方式，此处列出各种语言及开发环境调用的示例，具体环境还需要作实际的修改。1.2.1 C#中的调用在你的项目的引用上右键à添加服务引用，点击左下角高级，接着在弹出的对话框中”添加web引用”，在url中填写：cn.my2my.hl.esmsservice service = new cn.my2

26、my.hl.esmsservice();实例化对象并调用相应方法1.2.2 PHP中的调用<?phpset_time_limit(0);header("Content-Type: text/html; charset=gbk");/* * 定义程序绝对路径 */define('SCRIPT_ROOT', dirname(_FILE_).'/');require_once SCRIPT_ROOT.'include/Client.php'/* * 网关地址 */$gwUrl = ' http:/ /newesmsse

27、rvice/services/esmsservice '/* * 序列号,请通过华录亿动销售人员获取 */$serialNumber = '用户名'/* * 密码,请通过华录亿动销售人员获取 */$password = '密码'/* * 登录后所持有的SESSION KEY，即可通过login方法时创建 */$sessionKey = '621163'/* * 连接超时时间，单位为秒 */$connectTimeOut = 2;/* * 远程信息读取超时时间，单位为秒 */ $readTimeOut = 10;/*$proxyhost可选

28、，代理服务器地址，默认为 false ,则不使用代理服务器$proxyport可选，代理服务器端口，默认为 false$proxyusername可选，代理服务器用户名，默认为 false$proxypassword可选，代理服务器密码，默认为 false*/$proxyhost = false;$proxyport = false;$proxyusername = false;$proxypassword = false; $client = new Client($gwUrl,$serialNumber,$password,$sessionKey,$proxyhost,$proxyport

29、,$proxyusername,$proxypassword,$connectTimeOut,$readTimeOut);$client->setOutgoingEncoding("gbk");$statusCode = $client->sendSmsAsNormal("quot;,"PHP WebService Client测试","201009201216","201","用户名","密码");echo "处理状态

30、码:".$statusCode;$result = $client->getMoList("用户名","密码");$result_1 = $client->getSmsStates("用户名","密码");?>1.2.3 Java的调用方式需要下载apache soap。下载地址：/soap/index.html导入：import org.apache.axis.client.Call;import org.apache.axis.client.Service;例子：private static Service service = new Service();private String URL=" http:/ /newesmsservice/services/esmsservice "public String testSend(int type) try Call call = (Call) service.createCall();call.setTargetEndpointAddress(new URL(URL);String send=&quo