大汉三通企信通平台CTC-EMA接口手册(综合版).doc_第1页
大汉三通企信通平台CTC-EMA接口手册(综合版).doc_第2页
大汉三通企信通平台CTC-EMA接口手册(综合版).doc_第3页
大汉三通企信通平台CTC-EMA接口手册(综合版).doc_第4页
大汉三通企信通平台CTC-EMA接口手册(综合版).doc_第5页
已阅读5页,还剩40页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

企信通平台企信通平台 EMAEMA (综合版)(综合版) 接口手册接口手册 产品名称产品名称企信通平台企信通平台 EMAEMA(综合版)(综合版) 发布日期发布日期 2011-052011-05 企信通平台 EMA 接口手册(综合版) 第 2 页 共 45 页 目目 录录 1 1、引言引言4 4 1.1.目的4 1.2.修改历史记录4 1.3.名称解释4 2 2、短信短信5 5 2.1.HTTP接口.5 2.1.1.短信下行5 2.1.2.短信上行8 2.1.3.短信状态报告9 2.1.4.查询余额11 2.2.API接口 .11 2.3.WEBSERVICE接口(不推荐).15 2.3.1.自定义数据结构16 2.3.2.短信下行(发送多条内容相同的短信)17 2.3.3.短信下行(发送多条内容不同的短信)18 2.3.4.获取上行18 2.3.5.获取状态报告(单条)19 2.3.6.获取状态报告(多条)19 2.3.7.获取余额20 2.4.WEBSERVICE接口(新,推荐使用)20 2.4.1.自定义数据结构20 2.4.2.短信下行(发送一条或者多条内容相同的短信)21 2.4.3.短信下行(发送内容不同的短信)21 2.4.4.获取上行23 2.4.5.获取状态报告23 2.4.6.获取余额25 2.4.7.短信webservice(新)错误码.25 2.5.WEBSERVICE接口(支持上下行子号码)25 2.5.1.自定义数据结构26 2.5.2.短信下行(发送一条或者多条内容相同的短信)26 2.5.3.短信下行(发送内容不同的短信)27 2.5.4.获取上行28 2.5.5.获取状态报告29 2.5.6.获取余额30 2.5.7.短信webservice错误码31 2.6.DB 用户接口(只限外部企业).31 企信通平台 EMA 接口手册(综合版) 第 3 页 共 45 页 2.6.1.短信下行(smsout+(企业子号码) 31 2.6.2.短信上行(smsin+(企业子号码)).32 2.6.3.状态报告(smsreport+(企业子号码))32 3 3、彩信彩信3232 3.1.HTTP 接口.32 3.1.1.发送彩信32 3.1.2.上传彩信34 3.1.3.获取彩信报告36 3.2.API接口 .37 3.3.WEBSERVICE40 3.3.1.自定义数据结构40 3.3.2.彩信下行(发送多条内容相同的彩信)41 3.3.3.获取状态报告43 3.3.4.彩信webservice错误码44 企信通平台 EMA 接口手册(综合版) 第 4 页 共 45 页 1 1、 引言引言 . 目的目的 该接口手册编写目的在于描述企信通平台 EMA(以下简称 EMA)具体的接口协议,供接 口用户进行接口的对接开发。 . 修改历史记录修改历史记录 版版 本本修改人修改人日日 期期描描 述述 5.0.1顾黎杰2006/8/10创建文档。 5.0.2顾黎杰2008/6/20增加短信 api 接口。 5.0.3顾黎杰2010/5/5细化接口返回参数。 5.0.3赵鸿2011/5/6WebService 接口(支持上下行子号码) 5.3.8王鹏2011/8/26细化 HTTP 下行 SUBCODE 参数描述 . 名称名称解释解释 缩略语缩略语英文全名英文全名中文全名中文全名 EMAEnterprise Mobile Agent企信通 SMSShort Messaging Service短消息服务 MMSMultimedia Message Service多媒体消息 APIApplication Programming Interface应用程序编程接口 MOMessage Original消息上行 MTMessage Terminal消息下行 SPService Provider服务提供商 CPContent Provider内容提供商 企信通平台 EMA 接口手册(综合版) 第 5 页 共 45 页 2 2、 短信短信 . http 接口接口 .1.1. 短信下行短信下行 功能:下发单条或者多条内容相同的短信。 地址: 平台地址/http/SendSms。 建议采用 post 方法提交请求。 请求参数定义如下: 参数名称描述字段值 Account帐号String,不空。 Password密码String,不空(需 MD5 加密,32 位,加 密后字母全部为小写,例如: “123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456 ”用户可以用此例子验证加密方法是否 正确 ) 。 SubCode子号码String,可以为空。格式为企业帐号+子 号码。例如:如果平台号码为 “10650300” ,企业帐号为 2,子号码为 “22” ,则 SubCode 设置为“222” ,短 信将以“10650300222”号码下发给手 机用户(注:此功能需要通道支持)。 Phone手机号码String,不空,支持多号码,号码之间 用英文逗号隔开,最多 100 个。如:13900000000。 Content短信内容String,不空 。GBK 编码 Java 例: .URLEncoder.encode(Content, “UTF-8“)。 WappushurlWappushurlWappush 地址,如果需要发送 Wappush,则 Content 表示 title SendTime定时发送时间String,可以为空,为空就是立即发送。 定时发送格式为年月日时分,如: 200803201615。 企信通平台 EMA 接口手册(综合版) 第 6 页 共 45 页 返回参数定义如下: 参数名称描述 response0:成功条数; -1:帐号不存在,请检查用户名或者密码是否正确; -2:账户余额不足; -3:帐号已被禁用; -4:ip 鉴权失败(需要 ip 校验的场合) ; -8:缺少请求参数或参数不正确(请检查用户名,密码,下 发号码,下发内容是否为空,或者下发号码数量是否大于 100 个) ; -9:内容不合法(含有非法内容,请检查下发内容) 。 -10:账户当日发送短信量已经超过允许的每日最大发送量 (账户被限制每日发送短信数量的情况有用) phone手机号。 smsID短信 ID(用于匹配状态报告) 。 下发实例(java): import java.io.BufferedReader; import java.io.InputStreamReader; import java.io.OutputStream; import .HttpURLConnection; import .URL; import java.security.MessageDigest; public class HttpSend public static void main(String args) try Long startt = System.currentTimeMillis(); / 短信内容 String _content = “测试,见谅“; / 用UTF-8编码执行URLEncode _content = .URLEncoder.encode(_content, “UTF-8“); / 密码加密 String pass = MD5Encode(“10“); String _url = “1:8080/ctc- emassh/http/SendSms“; String _param = “Account=10 URL url = null; HttpURLConnection urlConn = null; 企信通平台 EMA 接口手册(综合版) 第 7 页 共 45 页 url = new URL(_url); urlConn = (HttpURLConnection) url.openConnection(); urlConn.setRequestMethod(“POST“); urlConn.setDoOutput(true); OutputStream out = urlConn.getOutputStream(); out.write(_param.getBytes(“GBK“); out.flush(); out.close(); BufferedReader rd = new BufferedReader(new InputStreamReader( urlConn.getInputStream(), “GBK“); StringBuffer sb = new StringBuffer(); int ch; while (ch = rd.read() -1) sb.append(char) ch); System.out.println(sb); rd.close(); Long end = System.currentTimeMillis(); System.out.println(“发送 短信 耗时:“ + (end - startt); catch (Exception ex) System.out.print(ex); public static String MD5Encode(String sourceString) String resultString = null; try resultString = new String(sourceString); MessageDigest md = MessageDigest.getInstance(“MD5“); resultString = byte2hexString(md.digest(resultString.getBytes(); catch (Exception ex) return resultString; public static final String byte2hexString(byte bytes) StringBuffer bf = new StringBuffer(bytes.length * 2); for (int i = 0; i - -8 成功返回页面示例: - 2 -2c92811a29a0c90c0129a0ca984e0016 -2c92811a29a0c90c0129a0ca984e0015 .1.2. 短信上行短信上行 功能:接收若干条手机用户的上行短信(一次最多十条) 。 地址: 平台地址/http/GetSms。 建议采用 post 方法提交请求。调用短信上行间隔时间不小于 30 秒。 请求参数定义如下: 参数名称描述字段值 Account帐号String,不空。 Password密码String,不空(需 MD5 加密) 。 返回参数定义如下: 参数名称描述 response大于 0:上行短信的条数,一次最多取 10 条; 企信通平台 EMA 接口手册(综合版) 第 9 页 共 45 页 0:没有上行短信; -1:帐号登陆失败; -3:此帐号被禁用; -4:ip 鉴权失败; -8:缺少请求参数。 -9:访问速度太快,每次访问间隔不能小于 30 秒 phone手机号。 content短信内容; 已经用 .URLEncoder.encode()编码; 需要用 .URLDecoder.decode()解码。 sendTime上行时间。 无短信或者参数错误返回页面示例: - 0 成功返回短信页面示例:(一次最多取 10 条) - 3 - 1376612345678 test 2009-02-06 09:01:33.0 - 1386612345678 %E6%B5%8B%E8%AF%95 2009-02-06 09:01:33.0 - 1396612345678 abc 2009-02-06 09:01:33.0 .1.3. 短信状态报告短信状态报告 功能:根据 SmsID 返回短信是否成功发送到用户手机。 企信通平台 EMA 接口手册(综合版) 第 10 页 共 45 页 地址: 平台地址/http/GetReport。 建议采用 post 方法提交请求。调用短信状态报告间隔时间不小于 30 秒。 请求参数定义如下: 参数名称描述字段值 Account帐号String,不空。 Password密码String,不空(需 MD5 加密) 。 SmsID消息 IDString,不空。 返回参数定义如下: 参数名称描述 response大于 0:此消息 ID 所对应的状态报告条数。最多 100 条; 0:没有此消息 ID 的状态报告; -1:帐号登陆失败; -3:此帐号被禁用; -4:ip 鉴权失败; -8:缺少请求参数。 -9:访问速度太快,每次访问间隔不能小于 30 秒 phone手机号。 smsID消息 ID。 stat状态报告 0:成功; 2:发送失败。 请求错误返回页面示例: - -8 请求成功返回页面示例: - 1 -2c92812d1ebf8704011ebf939ba80004 0 企信通平台 EMA 接口手册(综合版) 第 11 页 共 45 页 .1.4. 查询余额查询余额 功能:查询剩余短信跟彩信的条数。 地址: 平台地址/http/GetBalance。 建议采用 post 方法提交请求。调用查询余额间隔时间不小于 30 秒。 请求参数定义如下: 参数名称描述字段值 Account帐号String,不空。 Password密码String,不空(需 MD5 加密) 。 返回参数定义如下: 参数名称描述 response-1:帐号登陆失败; -3:此帐号被禁用; -4:ip 鉴权失败; -8:缺少请求参数。 sms短信余额。 mms彩信余额。 返回页面示例: - 10002000 . api 接口接口 相关 jar 包包括:ctc-smsclient.jar,ctc-message.jar,ctc-slidewindow.jar,ctc- sync.jar,ctc-util.jar。 注意:只有外部企业才能使用此接口注意:只有外部企业才能使用此接口 名称initConn 功能连接初始化。 接口方法 public int initConn(String host, int port, 企信通平台 EMA 接口手册(综合版) 第 12 页 共 45 页 String user, String password) 输入说明host:EMA 的 ip; port:EMA 的端口; user:接口用户名; password:接口密码。 输出说明 0成功 1已经登陆 2用户名错误 3密码错误 4客户端 ip 错误(需要校验 ip 的时候需要) 5 其他 名称sendSms 功能发送短信。 接口方法 public boolean sendSms(String from, String to, String msg) 输入说明from:子号码,一般不填写; to:手机号码,支持多号码,以英文逗号隔开。建议一次最多 100 个; msg:短信内容。 输出说明true:成功; false:失败。 名称 onSubmitedSMS 功能接收下行短信响应。sendSms 方法不直接返回下行响应,由此 方法返回,此方法为回调方法,不需要手动调用。 接口方法 public boolean onSubmitedSMS(ISubmitMsg arg0) 输入说明arg0:下行数据结构,具体支段见示例。 输出说明true:成功; false:失败。 企信通平台 EMA 接口手册(综合版) 第 13 页 共 45 页 名称 onDeliverSMS 功能接收上行短信。此方法为回调方法,不需要手动调用。 接口方法 public boolean onDeliverSMS(IDeliverMsg arg0) 输入说明arg0:上行数据结构,具体支段见示例。 输出说明true:成功; false:失败。 名称 onMTReportSMS 功能接收状态报告。此方法为回调方法,不需要手动调用。 接口方法 public boolean onMTReportSMS(IReportMsg arg0) 输入说明arg0:状态报告数据结构,具体支段见示例。 输出说明true:成功; false:失败。 示例程序: import com.chinatricom.message.IDeliverMsg; import com.chinatricom.message.IReportMsg; import com.chinatricom.message.ISubmitMsg; import com.chinatricom.slidewindow.SMSCallback; import com.chinatricom.smsclient.ctcpp.CtcppChannel; import com.chinatricom.smsclient.message.DeliverMsg; import com.chinatricom.smsclient.message.ReportMsg; import com.chinatricom.smsclient.message.SubmitMsg; /* * title: 调用CTC-SMS API客户端接口 SMSUtil.java create on 2010-10-26 copyright (c) * 2010-10-26 * * author * version 1.0 */ public class SMSUtil implements SMSCallback 企信通平台 EMA 接口手册(综合版) 第 14 页 共 45 页 public static CtcppChannel _chan = null; static / 相关参数定义 SMSUtil _client = new SMSUtil(); String host = ““; / 调用IP地址 int port = 28013; / 调用IP地址的端口 String user = “8888“; / 用户名 String passwd = “8888“;/ 密码 int wndSize = 16; int timeout = 60 * 1000; / 连接超时时间 int trys = 3; int speed = 0; / 记录日志 System.out.println(“start“); / 开启通道 _chan = new CtcppChannel(host, port, user, passwd, 1, wndSize, timeout, trys, speed, _client, 0, 0, 1, 1); _chan.start(); /* * 这个函数接收上行短信,短信的各个字段都放在DeliverMsg */ public boolean onDeliverSMS(IDeliverMsg arg0) DeliverMsg msg = (DeliverMsg) arg0; if (msg != null) System.out.println(“收到deliverMsg:phone=“ + msg.getFrom() + “,内容=“ + msg.getMsg() + “,to=“ + msg.getTo(); return true; /* * 这个函数接收下发短信的状态报告,它通过msgid关联到下行短信 result : 0成功 1等待发送 2失败 */ public boolean onMTReportSMS(IReportMsg arg0) ReportMsg msg = (ReportMsg) arg0; if (msg != null) System.out.println(“收到repot: result=“ + msg.getResult() + 企信通平台 EMA 接口手册(综合版) 第 15 页 共 45 页 “); return true; /* * 这个函数接收下行短信的response,SubmitMsg里面有了result和msgId,这里的msg 就是_chan.submit(_msg) * 里面的_msg。 result = 0 表示成功, 其他均为失败。 */ public boolean onSubmitedSMS(ISubmitMsg arg0) SubmitMsg msg = (SubmitMsg) arg0; if (msg != null) System.out.println(“收到submit response:result“ + “=“ + msg.getResult() + “, msgid=“ + msg.getMsgId(); return true; /* * 下发方法入口 */ public static void sendSMS(String phoneNumber, String smsContext) try SubmitMsg _msg = new SubmitMsg(); _msg.setChanId(1); _msg.setFrom(“1“); _msg.setTo(phoneNumber); _msg.setMsg(smsContext); _chan.submit(_msg); catch (Exception e) e.printStackTrace(); finally public static void main(String args) SMSUtil.sendSMS(, “test“); . WebService 接口(不推荐)接口(不推荐) 地址:url/services/SmsOperator 企信通平台 EMA 接口手册(综合版) 第 16 页 共 45 页 .3.1. 自定义数据结构自定义数据结构 MTMessage 参数名称类型说明 sequenceId String消息序号,用来取状态报告时候匹配,可以为空,建议不 填写,为空时返回的 MTResponse 会自动生成一个唯一的消 息序号。 phoneNumber String 手机号码。支持多号码,号码之间用英文逗号隔开,建议最 多 100 个。如:13900000000。 content String短信内容。 scheduleTime Date下行时间,可以为空。 MTResponse 参数名称类型说明 isSuccessboolean是否调用成功 true:成功; false:失败。 sequenceId String消息 ID,用来取状态报告时候匹配。 phoneNumber String 手机号码。 MOMessage 参数名称类型说明 sequenceId String消息序号。 phoneNumber String 手机号码。 content String短信内容。 receivedTime Date下行时间,可以为空。 isSuccessboolean是否调用成功 true:成功; 企信通平台 EMA 接口手册(综合版) 第 17 页 共 45 页 false:失败。 MTReport 参数名称类型说明 isSuccessboolean是否调用成功 true:成功; false:失败。 sequenceId String消息 ID,用来取状态报告时候匹配。 phoneNumber String 手机号码。 nStat int 0:成功; 2:失败。 Balance 参数名称类型说明 isSuccessboolean是否调用成功 true:成功; false:失败。 smsBalance int短信条数。 mmsBalance int 彩信条数。 .3.2. 短信下行(发送多条内容相同的短信)短信下行(发送多条内容相同的短信) 名称sendSms 功能发送多条内容相同的短信。 接口方法MTResponse sendSms(String account, String password, MTMessage message) 输入说明account 用户账号; password 用户密码(用 MD5 加密) ; 企信通平台 EMA 接口手册(综合版) 第 18 页 共 45 页 MTMessage 对象,短信平台根据对象包含的属性来决定如何发 送短信。 输出说明返回的结果是以 MTResponse 对象构成的数组,客户端可以据 此判断,方法执行成功与否。 .3.3. 短信下行(发送多条内容不同的短信)短信下行(发送多条内容不同的短信) 名称batchSendSms 功能发送多条内容不相同的短信(同一 MTMessage 对象的内容相 同) 。 接口方法MTResponse batchSendSms(String account, String password, MTMessage message) 输入说明account 用户账号; password 用户密码(用 MD5 加密) ; MTMessage 对象数组,平台根据每一个对象包含的属性来决定 如何发送短信。 输出说明返回的结果是以 MTResponse 对象构成的数组,客户端可以据 此判断,方法执行成功与否。 .3.4. 获取上行获取上行 调用短信上行间隔时间不小于 30 秒。 名称getSms 功能获取上行短信,一次最多取 10 条。 接口方法MOMessage getSms(String account, String password) 输入说明account 用户账号; 企信通平台 EMA 接口手册(综合版) 第 19 页 共 45 页 password 用户密码(用 MD5 加密) 。 输出说明返回的结果是一个以 MOMessage 对象构成的数组,据此可以 分析该上行短信的结果。 .3.5. 获取状态报告(单条)获取状态报告(单条) 调用短信状态报告间隔时间不小于 30 秒。 名称getReport 功能获取状态报告。 接口方法MTReport getReport(String account, String password, MTMessage message) 输入说明account 用户账号; password 用户密码(用 MD5 加密) ; MTMessage,包含消息序号和手机号码的对象。 (只需要填写 sequenceId 和 phoneNumber 字段) 。 输出说明返回的结果是一个以 MTReport 对象构成的数组,据此可以分 析对应短信的状态。 .3.6. 获取状态报告(多条)获取状态报告(多条) 调用短信状态报告间隔时间不小于 30 秒。 名称getReports 功能获取多条状态报告。 接口方法MTReport getReports(String account, String password, MTMessage message) 输入说明account 用户账号; password 用户密码(用 MD5 加密) ; MTMessage,包含消息序号和手机号码的对象数组。 (只需要 企信通平台 EMA 接口手册(综合版) 第 20 页 共 45 页 填写sequenceId 和 phoneNumber 字段) 。 输出说明返回的结果是一个以 MTReport 对象构成的数组,据此可以分 析对应短信的状态。 .3.7. 获取余额获取余额 调用获取余额间隔时间不小于 30 秒。 名称getBalance 功能获取帐号余额。 接口方法Balance getBalance(String account, String password) 输入说明account 用户账号; password 用户密码(用 MD5 加密) 。 输出说明返回的结果是 Balance 对象。 . WebService 接口接口(新,推荐使用新,推荐使用) 地址:url/services/SmsNewOperator .4.1. 自定义数据结构自定义数据结构 MtNewMessage 参数名称类型说明 smsId String消息序号,用来取状态报告时候匹配,可以为空,建议不 填写,为空时服务端会返回一个唯一的消息序号。 phoneNumber String 手机号码。支持多号码,号码之间用英文逗号隔开,建议最 多 100 个。如:13900000000。 content String短信内容。 scheduleTime Date下行时间,可以为空。 WappushurlStringWappush 地址,如果需要发送 Wappush,则 Content 表示 企信通平台 EMA 接口手册(综合版) 第 21 页 共 45 页 title .4.2. 短信下行(发送一条或者多条内容相同的短信)短信下行(发送一条或者多条内容相同的短信) 名称sendSms 功能发送一条或则多条内容相同的短信。 接口方法sendSms(String account, String password, MtNewMessage message, StringHolder sendResMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; message对象,详情请参照自定义数据结构:MtNewMessage。 输出说明sendResMsg:发送情况返回 (当errMsg 不为负值时该值有效) 格式(无换行符):2c9281e22c1ac7c2012c1adc8bdb0021 132 -7 errMsg:输出参数,小于零时表示下发错误,详情见错误码 .4.3. 短信下行(发送内容不同的短信)短信下行(发送内容不同的短信) 名称batchSendSms 企信通平台 EMA 接口手册(综合版) 第 22 页 共 45 页 功能发送一条或则多条内容相同的短信。 接口方法batchSendSms(String account, String password, MtNewMessage message, StringHolder sendResMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; message对象数组,详情请参照自定义数据结构: MtNewMessage。 输出说明sendResMsg:发送情况返回 (当errMsg 不为负值时该值有效) 格式(无换行符):2c9281e22c5d9f77012c5da2d0b7001b2c9281e22c5d9f77012c5da2d0c0001c errMsg:输出参数,小于零时表示下发错误,详情见错误码 企信通平台 EMA 接口手册(综合版) 第 23 页 共 45 页 .4.4. 获取上行获取上行 调用短信上行间隔时间不小于 30 秒。 名称getSms 功能获取上行短信,一次最多取 10 条。 接口方法getSms(String account, String password, StringHolder resMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) 。 输出说明resMsg:返回上行短信(当errMsg 不为负值时该值有效) 格式(无换行符):Test MO! 测试 Deliver 消息!Test MO! 测试 Deliver 消息! 没有上行时返回: errMsg:输出参数,小于零时表示下发错误,详情见错误码 .4.5. 获取状态报告获取状态报告 调用短信状态报告间隔时间不小于 30 秒。 企信通平台 EMA 接口手册(综合版) 第 24 页 共 45 页 名称getReport 功能获取一条或者多条状态报告。 接口方法getReport(String account, String password, MtNewMessage message, StringHolder reportMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; MtNewMessage,详情请参照自定义数据结构: MtNewMessage,包含消息序号和手机号码的对象数组。 (只需 要填写smsId 和 phoneNumber 字段) 。 输出说明reportMsg: 返回状态报告(当 errMsg 不为负值时该值有效) 格式(无换行符):2c9281e22bf60182012bf6025949001a 02c9dd1e22aa6018dd12bf60ff5949055 0 无状态报告时返回: errMsg: 输出参数,小于零时表示下发错误,详情见错误码 企信通平台 EMA 接口手册(综合版) 第 25 页 共 45 页 .4.6. 获取余额获取余额 调用获取余额报告间隔时间不小于 30 秒。 名称getBalance 功能获取帐号余额。 接口方法getBalance(String account, String password, StringHolder resMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密 方法是否正确) 。 输出说明resMsg:返回账户余额(当 errMsg 不为负值时该值有效) 格式(无换行符): 043216 errMsg: 输出参数,小于零时表示下发错误,详情见错误码 .4.7. 短信短信 webservicewebservice(新)错误码(新)错误码 -1:输入参数不正确,请检查账户,密码,等输入参数是否为空 -2:账户不存在,请检查用户名密码是否正确 -3:账户已经超过每日发送短信限制数量(当账户被限制每日发送量时有用) -4:客户端 ip 地址不正确(当需要 ip 校验时) -5:smsId 与数据库重复(下发短信时,如果smsId 由客户端传入,该参数不能重复) -6:内容含有非法关键字,请检查下发内容。 -7:对应的号码下发失败,下发号码为空或其他错误,导致该号码发送失败 . WebService 接口接口(支持上下行子号码支持上下行子号码) 地址:url/services/SmsNewOperatoraddsubCode 企信通平台 EMA 接口手册(综合版) 第 26 页 共 45 页 前提:下发通道支持子号码 .5.1. 自定义数据结构自定义数据结构 MtNewMessage 参数名称类型说明 smsId String消息序号,用来取状态报告时候匹配,可以为空,建议不 填写,为空时服务端会返回一个唯一的消息序号。 phoneNumber String 手机号码。支持多号码,号码之间用英文逗号隔开,建议最 多 100 个。如:13900000000。 content String短信内容。 scheduleTime Date下行时间,可以为空。 WappushurlStringWappush 地址,如果需要发送 Wappush,则 Content 表示 title .5.2. 短信下行(发送一条或者多条内容相同的短信)短信下行(发送一条或者多条内容相同的短信) 名称sendSms 功能发送一条或则多条内容相同的短信。 接口方法sendSms(String account, String password, MtNewMessage message,String subCode, StringHolder sendResMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; subCode :子号码,需要通道支持,手机终端用户收到的信息发送号码 将是长号码 + 子号码( account + 自定义子号码) message对象,详情请参照自定义数据结构:MtNewMessage。 输出说明sendResMsg:发送情况返回 (当errMsg 不为负值时该值有效) 格式(无换行符): 企信通平台 EMA 接口手册(综合版) 第 27 页 共 45 页2c9281e22c1ac7c2012c1adc8bdb0021 132 -7 errMsg:输出参数,小于零时表示下发错误,详情见错误码 .5.3. 短信下行(发送内容不同的短信)短信下行(发送内容不同的短信) 名称batchSendSms 功能发送一条或则多条内容相同的短信。 接口方法batchSendSms(String account, String password, MtNewMessage message, String subCode, StringHolder sendResMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; subCode :子号码,需要通道支持,手机终端用户收到的信息发送号码 将是长号码 + 子号码 message对象数组,详情请参照自定义数据结构: MtNewMessage。 输出说明sendResMsg:发送情况返回 (当errMsg 不为负值时该值有效) 格式(无换行符): 企信通平台 EMA 接口手册(综合版) 第 28 页 共 45 页2c9281e22c5d9f77012c5da2d0b7001b2c9281e22c5d9f77012c5da2d0c0001c errMsg:输出参数,小于零时表示下发错误,详情见错误码 .5.4. 获取上行获取上行 调用短信上行间隔时间不小于 30 秒。 名称getSms 功能获取上行短信,一次最多取 10 条。 接口方法getSms(String account, String password, StringHolder resMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) 。 输出说明resMsg:返回上行短信(当errMsg 不为负值时该值有效) 企信通平台 EMA 接口手册(综合版) 第 29 页 共 45 页 格式(无换行符):Test MO! 测试 Deliver 消息! 112Test MO! 测试 Deliver 消息! 没有上行时返回: errMsg:输出参数,小于零时表示下发错误,详情见错误码 .5.5. 获取状态报告获取状态报告 调用短信状态报告间隔时间不小于 30 秒。 名称getReport 功能获取一条或者多条状态报告。 接口方法getReport(String account, String password, MtNewMessage message, StringHolder reportMsg, StringHolder errMsg) 输入说明account 用户账号; password 用户密码(用 MD5 加密,32 位,加密后字母全部为 小写,例如:“123.com“ 加密后应该等于 “cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加 密方法是否正确) ; 企信通平台 EMA 接口手册(综合版) 第 30 页 共 45 页 MtNewMessage,详情请参照自定义数据结构: MtNewMessage,包含消息序号和手机号码的对象数组。 (只需 要填写smsId 和 phoneNumber 字段) 。

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论