消息收发接口规范

(HTTP方式)目  录一概述  1二名词定义  12.1下行消息  12.2上行消息  12.3状态 报告 软件系统测试报告下载sgs报告如何下载关于路面塌陷情况报告535n,sgs报告怎么下载竣工报告下载   1三HTTP方法  23.1发送接口/修改密码/查询余额/GET[Submit/QxtSetOperPass/surplus]  23.1.1接口 协议 离婚协议模板下载合伙人协议 下载渠道分销协议免费下载敬业协议下载授课协议下载   23.1.2接口命名  23.1.3请求参数  23.1.4应答内容  33.1.5使用范例  33.2发送接口/POST[Submit]  53.2.1接口协议  53.2.3请求参数  53.1.4应答内容  63.1.5使用范例  63.3转发接口[Deliver]  73.3.1接口协议  73.3.2接口命名  73.3.3参数  7五说明  8一概述本接口规范定义了企信通短信平台（服务方）与客户系统（客户方）之间的数据传输协议及使用方法。通过这个接口规范可以实现客户系统(通过企信通)与手机终端之间的消息传送。二名词定义2.1下行消息下行消息又称MT消息，是指由业务系统送到企信通短信平台,再转发到运营商的网关，并最终发送到手机终端上的文字信息。2.2上行消息上行消息又称MO消息，是指由手机终端发送至企信通短信平台并最终送到客户系统的文字信息。2.3状态报告状态报告是一条特殊上行消息，用于报告下行消息的投递情况。状态报告分为二种：提交状态报告与接收状态报告。并不是每一条下行消息都会有对应的状态报告。提交状态报告：消息被提交到运营商消息网关后返回的消息。接收状态报告：消息被送达到手机终端后返回的消息。三HTTP方法3.1发送接口/修改密码/查询余额/GET[Submit/QxtSetOperPass/surplus]3.1.1接口协议企信通短信平台的短信发送接口协议使用HTTP协议，短信平台接口提供访问的URL，用户使用HTTPGET方法发送请求并得到应答内容,用户作为短信平台的HTTP客户端，短信平台作为用户的HTTP服务器。提交时如果使用HTTPGet方法，则同步返回包中将包含msgid，用户接到转发接口发来的状态报告时，可以根据这里的msgid对下行短信进行勾兑。3.1.2接口命名功能接口名调用方式说明发送消息QxtFirewall:9002/QxtSms/QxtFirewall部署在企信通平台修改密码QxtSetOperPass:9002/QxtSms/QxtSetOperPass部署在企信通平台查询余额surplus:9002/QxtSms/surplus部署在企信通平台3.1.3请求参数注：该请求参数仅针对发送接口，修改密码和查询余额参数请以3.15的使用范例为准。在向短信平台发起调用请求时，需要提供下表所列参数：参数名称是否必须(1是0否)参数说明取值说明OperID1业务标识已开通的帐号名称OperPass1操作密码与帐号名称对应的密码SendTime0发送时间YYYYMMDDHHMMSS 格式 pdf格式笔记格式下载页码格式下载公文格式下载简报格式下载 ,为空表示立即发送ValidTime0消息存活有效期YYYYMMDDHHMMSS格式AppendID0附加号码见注1DesMobile1接收手机号集合1.发送单条消息时，此字段填写11位的手机号码。2.群发消息时，此字段为使用逗号分隔的手机号码串。3.每批发送的手机号数量不得超过200个Content1发送消息内容最长70-签名个字符ContentType1消息类型取值有15和8。15：以普通短信形式下发,8：以长短信形式下发,默认为:15注1：例如用户在企信通短信平台的短信身份标识为13，若附加号码(AppendID)为0000，则接收号码收到的短信显示为来自spnumber130000,否则不填附加短信标识，则显示为spnumber13。并且：spnumber企信通短信平台的短信身份标识AppendID的总长度不能大于20.注2：如果需要发送批量短信，则将手机号码用英文的逗号分隔填写进DesMobile字段，DesMobile字段包含的最多手机号不能超过200个。如超过则视为非法包丢弃。注3：短信内容（Content）发起请求前必须进行URL转码。例如对于短信内容为“中文短信abc”,转码过程（java语言）如下：URLEncoder.encode("中文短信abc","GBK")结果为：���Ķ���abc3.1.4应答内容同步应答返回串为XML串，父节点名节点名参数说明取值说明responsecode短信提交状态参照（四.状态报告错误码）responsemessage短信单元帐户正常情况下，一个应答包中至少包含一个message单元，否则只有code节点来表明帐户状态。messagedesmobile提交手机号为用户提交的11位手机号码messagemsgid短信id短信ID（20位），由服务端生成，用户勾兑状态报告时按照此ID勾兑。3.1.5使用范例例：1.单条完整的GET方法请求URL为：:9002/QxtSms/QxtFirewall?OperID=test&OperPass=test&SendTime=&ValidTime=&AppendID=1234&DesMobile=&Content=���Ķ���abc&ContentType=15同步返回应答包如下：03785其中元素表示用户提交到企信通平台的状态报告，具体见4.12.群发完整的GET方法请求URL为：:9002/QxtSms/QxtFirewall?OperID=test&OperPass=test&SendTime=&ValidTime=&AppendID=1234&DesMobile=,,,&Content=���Ķ���abc&ContentType=15同步返回的应答包为：017857867877883.获取短信剩余条数的GET方法请求URL为：:9002/QxtSms/surplus?OperID=test&OperPass=test同步返回的应答包为：剩余条数4修改密码GET方法请求URL为：:9002/QxtSms/QxtSetOperPass?OperID=test&OperPassOld=test&OperPassNew=123同步返回的应答包为：操作状态(01:成功，其他见错误码)3.2发送接口/POST[Submit]3.2.1接口协议提交时如果使用HTTPPost方法，则同步返回包中也将包含msgid，用户接到转发接口发来的状态报告时，可以根据这里的msgid对下行短信进行勾兑。Post接口中同步返回包与get无异同。功能接口名调用方式说明发送消息QxtFirewall:9002/QxtSms/QxtFirewall部署在企信通平台3.2.2请求参数在向短信平台发起调用请求时，需要提供下表所列参数：参数名称是否必须(1是0否)参数说明取值说明OperID1业务标识已开通的帐号名称OperPass1操作密码与帐号名称对应的密码SendTime0发送时间YYYYMMDDHHMMSS格式,为空表示立即发送ValidTime0消息存活有效期YYYYMMDDHHMMSS格式AppendID0附加号码见注1DesMobile1接收手机号集合4.发送单条消息时，此字段填写11位的手机号码。5.群发消息时，此字段为使用逗号分隔的手机号码串。6.每批发送的手机号数量不得超过200个Content1发送消息内容最长67个字符，请与我方技术确定ContentType1发送消息的类型取值有15和8。15：以普通短信形式下发,8：以长短信形式下发,默认为:15注1：例如用户在企信通短信平台中的身份标识的为13，若附加号码为0000，则接收号码收到的短信显示为来自spnumber130000,否则不填附加短信标识，则显示为spnumber13。并且：spnumber企信通短信平台的短信身份标识AppendID的总长度不能大于20.注2：如果需要发送批量短信，则将手机号码用英文的逗号分隔填写进DesMobile字段，DesMobile字段包含的最多手机号不能超过200个。如超过则视为非法包丢弃。注3：短信内容（Content）发起请求前必须进行URL转码。例如对于短信内容为“中文短信abc”,转码过程（java语言）如下：URLEncoder.encode("中文短信abc","GBK")结果为：���Ķ���abc3.2.3应答内容同步应答返回串为XML串，父节点名节点名参数说明取值说明responsercode短信提交状态参照（四.状态报告错误码）responsemessage短信单元一个应答包中可以包含多个message单元messagedesmobile提交手机号为用户提交的11位手机号码messagemsgid短信id短信ID（20位），由服务端生成，用户勾兑状态报告时按照此ID勾兑。3.2.4使用范例例：单条同步返回的应答包为：00785批量同步返回的应答包为：007857867877883.3转发接口[Deliver]3.3.1接口协议企信通短信平台的短信转发接口协议使用HTTP协议，第三方系统需要提供短信平台访问的URL，短信平台使用HTTPGET方法发送请求，第三方接口接到后只需给予其确认应答，短信平台认为处理结果必须成功，即第三方系统是否正确的处理了短信平台的转发请求，短信平台均不再重复转发该短信。第三方系统作为短信平台的HTTP服务器，短信平台作为第三方系统的HTTP客户端。3.3.2接口命名功能接口名调用方式说明转发消息deliverMessagehttp://ip:port/deliverMessage部署在客户系统注:http://ip:port/deliverMessage仅为模拟，具体由客户提供3.3.3参数在向第三方系统发起调用请求时，调用请求提供下表所列请求参数：参数名称参数说明取值说明SmsType短信类型0:上行短信;1－提交网关状态报告（企信通平台提交到运营商网关的状态报告）2－手机接收状态报告SrcMobile发送手机号以13等开头的11位号码（SmsType=0时有效）AppendID附加号码附加号码（SmsType=0时有效）Content消息内容最长62个字符,当SmsType=1,2时，该字段的值为提交序号等RecvTime消息收到时间YYYYMMDDHHMMSS格式SendTime消息发送时间YYYYMMDDHHMMSS格式对联通手机，值为消息提交时间（SmsType=1,2时有效）Status消息状态0为发送成功，其它值为错误码（SmsType=1,2时有效）注1:✧当短信类型（SmsType=0）为上行短信时，SrcMobile、AppendID、Content、RecvTime有效✧当短信类型（SmsType=1,2）为回复报告时，Content、RecvTime、SendTime、Status有效注2:✧当短信类型（SmsType=1,2）为回复报告时，短信内容（Content）为20位的提交序号，例如：200610121123✧当短信类型（SmsType=0）为上行短信时，短信内容调用前已进行URL转码。例如对于短信内容为“中文短信abc”,转码过程（java语言）如下：URLEncoder.encode("中文短信abc","GBK")结果为：���Ķ���abc四状态报告错误码1．用户提交到企信通平台的状态报告错误码错误码说明00批量短信提交成功（批量短信待审批）01批量短信提交成功（批量短信跳过审批环节）03单条短信提交成功04用户名错误05密码错误06剩余条数不足07信息内容中含有限制词(违禁词)08信息内容为黑内容09该用户的该内容受同天内内容不能重复发限制10批量下限不足97短信参数有误98防火墙无法处理这种短信2．企信通平台提交到运营商网关的状态报告错误码（据客户需求给出）五说明本文定义了客户系统与企信通短信平台之间的接口规范，在企信通短信平台上应至少实现发送接口HTTP/GET方法[Submit]的要求。