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