企信通短信增值程序员手册

企信通短信增值程序员手册一 概述本手册主要介绍接口开发详细说明，为客户提供快速、准确的短信增值业务，可为应用系统提供二次开发的API接口。我们通过部署HTTP服务器接收用户提交的短信或者其他需求，解析后返回XML格式的数据包，无论是基于C/S还是B/S结构的应用系统，均可完成与企信通的无缝对接。二 接口开发准备2.1 由企信通业务经理处获取企信通服务器IP；2.2 由企信通业务经理处获取企信通用户以及用户密码；2.3 如需指定服务器提交须向企信通业务经理指明，或者联系客服指定，并提供相关信息；三 接口描述所有接口提交方式均为“POST”提交方式。不提供“GET”的方法。3.1 下行短信接口3.1.1 接口示例：接口通过指定的URL进行短信发送请求并获取数据应答，基本格式如下：http:/企信通服务器IP:8080/smsServer/submit?CORPID=企信通用户&CPPW=用户密码& PHONE=电话号码&CONTENT=发送内容3.1.2 接口提交参数说明：序号参数名称类型说明特殊要求备注1CORPID必选企业用户ID为企信通业务管理员统一分配半角2CPPW必选企业用户密码，初始值为用户名相同。半角，在提交短信中使用需MD5加密（32位）密码不区分大小写3PHONE必选接收短信手机号码半角，若多个号码当以半角逗号隔开，最多为100个号码。4CONTENT必选短信发送内容小灵通短信需要小于116个字节长度，其中汉字，全角符号占两个字节，半角符号占一个字节。发给移动、联通手机的短信需要小于70个字符，不分全角半角。提交时需UTF-8编码5SENDTIME可选发送时间半角，立即发送可不填写, 定时不得超过7天，格式：2012-11-12 12:00:00。6MSGID可选短信流水号和扩展半角数字，用户自定义流水号，前3位可显示在用户手机上。在状态报告中对应。需联系客服开通扩展号码7LTYPE可选长短信半角数字，0为正常短信，1为长短信标识。最长300字以67字为一条计费需联系客服开通3.1.3 接口返回值说明：SUCCESS：用户提交成功USER_ERROR: 登录失败USER_TYPE_ERROR:非接口用户（可联系企信通客服修改用户为接口用户）USER_IP_ERROR:请求IP与注册IP不符（发送短信服务器与客户账号指定IP不一致，可联系企信通客服修改用户发送短信服务器IP，或使用正确的服务器）SEND_ERROR:发送失败TIMEOUT：定时超过7天Get method is forbidden!：不支持GET方式提交3.2上行短信接口3.2.1 接口示例：接口通过指定的URL进行获取上行短信请求并获取对应XML数据应答，上行短信接收只能接收一次。基本格式如下：http:/企信通服务器IP:8080/smsServer/deliver?CORPID=企信通用户&CPPW=用户密码3.2.2 接口提交参数说明序号参数名称类型说明特殊要求备注1CORPID必选企业用户ID为企信通业务管理员统一分配半角2CPPW必选企业用户密码，初始值为用户名相同。半角，在提交短信中使用需MD5加密（32位）3.2.3 接口返回值说明3.2.3.1接收到短信示例： MESSAGE 2654123 15653218907 测试短信1 2013-02-27 16:39:14.553 1065505328992654123 2654789 15653218907 测试短信2 2013-02-27 16:12:04.583 1065505328992654789 3.2.3.2无上行短信格式： NOMESSAGE 3.2.3.3未开通上行短信功能格式： USER_ERROR MSGSTATUS：返回信息类型(MESSAGE:上行短信，NOMESSAGE没有上行，USER_ERROR: 未开通SMSID：短信流水号PHONE：上行短信的主叫号码CONTENT：上行短信内容RECVTIME：返回时间TOPHONE：接收号码3.3用户状态报告接口3.3.1 接口示例：接口通过指定的URL进行退费请求并获取对应XML数据应答，上行短信接收只能接收一次。基本格式如下：http:/企信通服务器IP:8080/smsServer/queryError?UID=企信通用户&PWD=用户密码3.3.2 接口提交参数说明序号参数名称类型说明特殊要求备注1UID必选企业用户ID为企信通业务管理员统一分配半角2PWD必选企业用户密码，初始值为用户名相同。半角，在提交短信中使用需MD5加密（32位）3.3.3 接口返回值说明返回的状态值中，000为成功状态，002为失败状态，其他为异常失败错误。发送短信时没有传递MSGID参数返回格式： 2013-02-28 16:31:37.723 2651 15653218907 测试短信1 000 2013-02-28 16:31:38.287 2651 15653218907 测试短信2 000 发送短信时传递MSGID参数返回格式： 123&18663993927&002 123&13163312002&002 注：MSGID里的分别表示（MSGID&呼叫号码&状态值）如果服务器没有短信返回格式： NULL3.4查询短信条数接口3.4.1 接口示例：http:/企信通服务器IP:8080/smsServer/querySurplus?UID=企信通用户&PWD=用户密码3.4.2 接口提交参数说明序号参数名称类型说明特殊要求备注1UID必选企业用户ID为企信通业务管理员统一分配半角2PWD必选企业用户密码，初始值为用户名相同。半角，在提交短信中使用需MD5加密（32位）3.4.3 接口返回值说明返回格式: 00&11&22&33说明：00剩余条数；11-退费条数；22-充值总条数；33-其他用户使用