易信通平台接口手册(电信用户)

EMS平台接口手册产品名称EMS平台发布日期2013/7/20易信通平台接口手册第2页共27页目录1、引言..............................................31.1.目的...............................................................................................................................31.2.修改历史记录...............................................................................................................31.3.名称解释.......................................................................................................................32、短信..............................................42.1.HTTP接口......................................................................................................................42.1.1.短信发送.........................................................................................................................42.1.2.短信接收.........................................................................................................................72.1.3.查询状态报告.................................................................................................................82.1.4.查询余额.......................................................................................................................102.1.5.查询关键字...................................................................................................................112.2.WEBSERVICE接口......................................................................................................122.2.1.短信发送.......................................................................................................................122.2.2.短信接收.......................................................................................................................152.2.3.查询状态报告...............................................................................................................162.2.4.查询余额.......................................................................................................................182.2.5.查询关键字...................................................................................................................19附录：公共错误代码定义.........................................................................................................27易信通平台接口手册第3页共27页1、引言1.1.目的该接口手册编写目的在于描述企业信息系统（以下简称EMS）具体的接口协议，供接口用户进行接口的对接开发。1.2.修改历史记录版本修改人日期描述V1.0.0.0陈林2013-07-20创建文档。V1.1.0.0陈林2013-11-19增加2.1.2及2.2.2一对一批量发送，同时增加两个错误代码值13，14V1.2.0.0陈林2013-12-10增加2.3节DB接口V1.2.0.1陈林2014-03-09增加错误代码15签名未报备V1.3.0.0陈林2014-04-14DB接口升级：增加监控，路由功能V1.3.0.1陈林2014-04-28增加错误代码16单位时间内该号码最大发送限制V1.3.0.2陈林2014-05-20增加错误代码17校验签名时签名长度及格式非法1.3.名称解释缩略语英文全名中文全名EMSEnterpriseMessageSystem企业信息系统SMSShortMessagingService短消息服务MMSMultimediaMessageService多媒体消息APIApplicationProgrammingInterface应用程序编程接口MOMessageOriginal消息上行MTMessageTerminal消息下行易信通平台接口手册第4页共27页SPServiceProvider服务提供商CPContentProvider内容提供商2、短信2.1.http接口2.1.1.短信发送功能：发送短信地址：备注：建议采用post方法提交请求。请求参数定义如下：参数名称描述字段值enterpriseID企业ID由系统开户设置,系统分配。不允许为空loginName登录名String，不允许为空。系统开户设置登录名password登录密码String，不可以为空。密码采用32位小写MD5加密.smsId消息idString，可以为空。消息id是这个包唯一标识，若为空则系统随机分配一个唯一标识值。若不为空，由用户自己设置一个唯一标识值。该值做为应答及状态报告中的消息id一一对应。subPort扩展端口String,可以为空。空表示不再扩展，若扩展必须是数字如：00，01，02…若扩展输入00则手机收到端口号为：10657*****00(备注：扩展必须此帐户配置通道支持)content短信内容String不可以为空，内容采用utf-8编码mobiles接收手机号码String，不可以为空。支持移动，联通，电信混合提交;多个号码中间采用半角逗号分隔,每个包最大支持100个号码。例：13500000000,13000000000,15100000000易信通平台接口手册第5页共27页sendTime定时发送时间String,可以为空。为空表示立即发送，定时时间格式为：yyyy-MM-ddHH:mm:ss返回结果以xml形式返回，详细参数及示例如下：参数名称描述Response根节点Result提交返回结果状态，详细状态码详见附录：公共错误代码定义SmsId消息id,用于配对状态报告,每个包提交返回消息id唯一。若发送时设置消息id，则返回是设置消息id值。失败返回结果样例：?xmlversion=1.0encoding=UTF-8?ResponseResult1/Result/Response成功返回结果样例：?xmlversion=1.0encoding=UTF-8?ResponseResult0/ResultSmsId10201201200/SmsId/Response2.1.2.一对一批量发送功能：发送短信地址：备注：建议采用post方法提交请求。请求参数定义如下：参数名称描述字段值enterpriseID企业ID由系统开户设置,系统分配。不允许为空loginName登录名String，不允许为空。系统开户设置登录名password登录密码String，不可以为空。密码采用32位小写MD5加密.batchSmsId消息id串String，可以为空。消息id串每一个号易信通平台接口手册第6页共27页码即一条短信对应一个id值，该值唯一区分每一个短信。同一批次提交多个信息消息id值中间采用半角逗号分隔，若为空则系统随机分配一批消息id值，与号码串一一对应。若不为空，由用户自己设置一批消息id值，中间用半角逗号分隔，注意每一个消息id唯一。该值做为应答及状态报告中的消息id一一对应。subPort扩展端口String,可以为空。空表示不再扩展，若扩展必须是数字如：00，01，02…若扩展输入00则手机收到端口号为：10657*****00(备注：扩展必须此帐户配置通道支持)batchContent短信内容String不可以为空，内容采用utf-8编码,批量提交多个内容格式：{内容1},{内容2},{内容3},{…},{内容n}若内容只有一个则格式：{内容}batchMobiles接收手机号码String，不可以为空。支持移动，联通，电信混合提交;多个号码中间采用半角逗号分隔,每个包最大支持100个号码。例：13500000000,13000000000,15100000000sendTime定时发送时间String,可以为空。为空表示立即发送，定时时间格式为：yyyy-MM-ddHH:mm:ss备注：批量发送一对一时，batchSmsId,batchContent,batchMobiles三个参数当batchSmsId不为空时，这三个参数分解出来短信对应个数必须一致，否则返回错误代码13（批量一对一参数格式错误）。返回结果以xml形式返回，详细参数及示例如下：参数名称描述Response根节点Result提交返回结果状态，详细状态码详见附录：公共错误代码定义SmsIdList消息id节点集合，只有Result值为0，即处理成功时才有该节点。num属性表示返回多少个消息id值，这个值与发送时多少条一对一短信对应。Item节点表示批量提交中每一条短信提交结果信息易信通平台接口手册第7页共27页index属性表示发送中这一批次提交中第N条短信smsId属性表示发送中这一批次提交中第index条短信返回的消息id值，该值若发送自定义则返回发送时定义值，若发送为空则系统生成唯一值。result属性表示发送中这一批次提交中第index条短信发送结果值，该结果值解释请参考公共错误代码定义。失败返回结果样例：?xmlversion=1.0encodi