湖南超级信使企业版(最新版)_0731

文档编号文档编号产品版本产品版本密级密级 3.3深圳协尔信息系统有限公司深圳协尔信息系统有限公司 产品名称：超级信使产品名称：超级信使共共9页页 湖南电信超级信使企业版湖南电信超级信使企业版 HTTP接口调用说明接口调用说明 拟制：拟制： 李宗波李宗波日期：日期：2006/08/04 审核：审核：日期：日期：yyyy/mm/dd 审核：审核：日期：日期：yyyy/mm/dd 批准：批准：日期：日期：yyyy/mm/dd 深圳协尔信息系统有限公司深圳协尔信息系统有限公司 版权所有版权所有 侵权必究侵权必究 湖南电信超级信使企业版 HTTP 接口调用说明 版权所有 侵权必究 第 1 页 共 12 页 历史修改记录 时间版本操作人说明 06.14V3.0李宗波初稿 08.04V3.3宁菲 10.01V3.3宁菲增加查询帐户余额接口 2 目录目录 1接口设计3 1.1HTTP 接口约定.3 1.1.1.发送短信3 1.1.2.接收短信5 1.1.3.接收状态报告6 1.1.4.确认收取短信7 1.1.5.确认收取状态报告8 1.1.6.修改账号密码9 1.2HTTP 接口测试地址.10 湖南电信超级信使企业版 HTTP 接口调用说明 版权所有 侵权必究 第 3 页 共 12 页 1 接口设计接口设计 1.1 HTTP 接口接口约定约定 为了降低客户的开发技术难度，根据客户需求，提供企业版的 HTTP 接口。采用 HTTP 的 GET(支持 post)方式进行消息的下发。在使用接口时，以如下形式进行调用。 http:/host:port/xx.jsp?xxx=111 smstext不多于 140字符 串 需要发送的短信内容。 采用 UTF-8 对 URL 进行编码。 长度限制是指 url 解码后的短信内容长度。 rstype20字符 串 可选参数， “text”，返回结果为普通字符串格式,“xml”, 返回结果为 xml 格式。不填该参数，则默认为 text 格 式 返回结果： 值含义 0成功 -1失败 -2缺少源号码 -3缺少密码 -4缺少短信内容 -5缺少目标号码 -6缺少短信编号 -7企业账号登录失败 调用接口示例： 1.发送单条短信 : sendsms.jsp?srcmobile=0731234567807318765455,07318765455150269461937”+源号码+”;”+目标号码+”;”+接收时间+”;”+短信内容。 各字段之间用分号分割。 - 2 17053; 07315000000; 07312345678; 2008-06-14 14:52:43.266; 测试短信内容 1 17054; 07315000000; 07312345678; 2008-06-14 14:52:43.266; 测试短信内容 1 - Xml 格式： 6 - 1 17053 07315000000 07312345678 2008-06-14 14:52:43.266 测试短信内容1 17054 07315000000 07312345678 2008-06-14 14:52:43.266 测试短信内容2 - 注意事项，在收取短信之后，请马上调用确认收取短信接口，以通知服务器已成功收取短信 调用示例： /getsms.jsp?srcmobile=07312345678”+状态报告值。 (状态报告值为整数，分别表示的含义为：-1- 未收到状态报告；10发送成功；20发送失 败) - 2 07318765432150269461937;10 07318765432150269461955;20 - Xml 格式： - 1 07318765432150269461937 10 07318765432150269461955 20 1.1.4.确认收取短信确认收取短信 在收取短信之后，请立即调用该接口告知服务端已经成功收取的短信编号，否则会重复收 取短信。 （为了防止收取短信接口调用失败导致丢失短信，因此必须由客户端确认之后服务端 方才标识该短信为成功收取） 入口地址： 确认本账号收取的短信 0:17080/httpinterface/ent/confirmsms.jsp 该接口企业账号有权确认其子号所收取的短信。 参数说明： 参数长度 （字节） 类型说明 8 srcmobile20字符发送消息的企业账号 password20字符账号对应的登录密码 smsids500字符已经成功接收的短信编号，多个编号之间用逗号隔开 rstype20字符可选参数， “text”，返回结果为普通字符串格式, “xml”,返回结果为 xml 格式。默认为 text 格式 返回结果： 值含义 0成功 -1失败 -2缺少源号码 -3缺少密码 -4缺少短信编号 -7帐号登录失败 /confirmsms.jsp?srcmobile=07312345678&password=123789& smsids=07318765432150269461937, 07318765466150269461937, 07318765435550269461937 1.1.5.确认收取状态报告确认收取状态报告 在收取状态报告之后，请立即调用该接口告知服务端已经成功收取的状态报告编号， 否则会重复收取到状态报告。 入口地址： 确认本账号收取的状态报告 0:17080/httpinterface/ent/confirmreport.jsp 该接口企业账号有权确认其子号所收其的状态报告。 参数说明： 参数长度 （字节） 类型说明 srcmobile20字符发送消息的企业账号 password20字符账号对应的登录密码 smsids500字符已经成功接收的短信编号，多个编号之间用逗号隔开 rstype20字符可选参数， “text”，返回结果为普通字符串格式, “xml”,返回结果为 xml 格式。默认为 text 格式 返回结果： 值含义 0成功 -1失败,未知错误 -2缺少源号码 -3缺少密码 -4缺少短信编号 -7帐号登录失败 湖南电信超级信使企业版 HTTP 接口调用说明 版权所有 侵权必究 第 9 页 共 12 页 调用示例： /confirmreport.jsp?srcmobile=07312345678&password=123789&smsids=0731876543215026946193 7, 07318765466150269461937, 07318765435550269461937 1.1.6.修改账号密码修改账号密码 企业版账号修改密码。 入口地址：0:17080/httpinterface/ent/chgpass.jsp 功能说明：即该接口用于修改自身密码。企业可以自身修改密码，使用子账号调用时，可 以修改子账号的密码。 参数说明： 参数长度 （字节） 类型说明 srcmobile20字符发送消息的企业账号（不能缺省） password20字符账号对应的登录密码（不能缺省） pwd20字符新的密码（不能缺省） rstype20字符可选参数， “text”，返回结果为普通字符串格式, “xml”,返回结果为 xml 格式。默认为 text 格式 返回结果： 值含义 0成功 -1失败,未知错误 -2缺少源号码 -3缺少密码 -4缺少新密码 -5新密码的长度小于 4 或者大于 16 -10企业账号登录失败 调用接口示例： 0:17080/httpinterface/ent/chgpass.jsp?srcmobile=07313330001&password= 111111&pwd=123456 则 07313330001 的密码变为 123456 0:17080/httpinterface/ent/chgpass.jsp?srcmobile=07313330001001&password=1 11111&pwd=123456 则 07313330001001 的密码变为 123456 即该接口用于修改自身密码。 返回结果示例(虚线范围内的内容是返回结果，以下皆同)： 文本格式： - 10 -1 - Xml 格式： - -1 - 1.1.7.查询帐户余额查询帐户余额 企业版账号修改密码。 入口地址：0:17080/httpinterface/ent/getCurfee.jsp 功能说明：该接口用于查询账户的余额。 参数说明： 参数长度 （字节） 类型说明 srcmobile20字符要查询的企业账号（不能缺省） password20字符账号对应的登录密码（不能缺省） 返回结果： 值含义 = 0 的数值账户余额数目，单位：分 -1失败,未知错误 -2缺少企业账号 -3缺少密码 -10企业账号登录失败 调用接口示例： 0:17080/httpinterface/ent/getCurfee.jsp?srcmobile=07313330001&password =111111 查询 07313330001 的余额 0:17080/httpinterface/ent/getCurfee.jsp?srcmobile=07313330002&password=111 111 查询 07313330002 的余额 返回结果示例(虚线范围内的内容是返回结果，以下皆同)： 文本格式： - -1 - 湖南电信超级信使企业版 HTTP 接口调用说明 版权所有 侵权必究 第 11 页 共 12 页 Xml 格式： - -1 - 1.2 HTTP 接口测试地址接口测试地址 获取状态报告： 0:17080/httpinterface/ent/getreport.jsp?srcmobile=07313330099&password= 123456 获取短信： 0:17080/httpinterface/ent/getsms.jsp?srcmobile=07313330099&password=1 23456 发送短信： 0:17080/httpinterface/ent/sendsms.jsp?srcmobile=07313330099&password= 123456&objmobilesmsid=07318765432150269461937&smstext=%20%E6%B5%8 B%E8%AF%95%E5%8F%91%E9%80%81%E7%9F%AD%E4%BF%A1 确认短信： 0:17080/httpinterface/ent/confirmsms.jsp?srcmobile=07313330099&passwo rd=123456&smsids=52300,52301 确认状态报告： 0:17080/httpinterface/ent/confirmreport.jsp?srcmobile=07313330099&p