《红树服务器接口文档》由会员分享，可在线阅读，更多相关《红树服务器接口文档（10页珍藏版）》请在金锄头文库上搜索。
1、文档编号 产品版本 密级20北京红树科技有限公司共6页HTTP 接口文档更新日期：2011 年 3 月 25 日 北京红树科技 HTTP 接口文档第 1 页 共 9 页目录1 短信发送接口设计 .21.1 发送短信 .21.2 短信发送参数 .21.3 发送返回参数说明 .32 账户余额查询 .42.1 接口地址 .42.2 接口参数 .43 状态报告 .44 上行信息 .75 附录(java 开发的接收 demo).8 北京红树科技 HTTP 接口文档第 2 页 共 9 页1 短信发送接口设计1.1 发送短信为了降低客户的开发技术难度，根据客户需求，提供 HTTP 接口。采用 HTTP的 G
2、ET(支持 post)方式进行消息的下发。在使用接口时，以如下形式进行调用。http:/211.103.155.246:8080/sms_send2.do?corp_id= 账户 id&corp_pwd=密码&corp_service=业务代码&.服务器接口地址：http:/211.103.155.246:8080/sms_send2.do账号简单页面测试地址：http:/211.103.155.246:8080/smsSubmitTest2.jsp 注意事项：1.下发短信时，不要提交错了服务器的接口地址，如果你的账户是开在服务器2 上的，提交的时候提交到服务器 1 的接口地址会返回（106
3、错误：用户名不存在） 。2.参数提交后的返回结果为文本格式和 xml 格式，即，发送完毕后，我方会推送相关数字信息或 xml 格式的字符串信息。3.服务器支持 http 方式，为安全性考虑，建议以 http 方式调用。1.2 短信发送参数参数说明：参数名称 参数说明 备注corp_id 企业接口访问 id 由系统管理员开通corp_pwd 系统访问接口密码 由系统管理员设定corp_service 业务代码 由系统管理员分配Mobile 要发送的手机号码 多个号码用英文的逗号隔开，且群发总号码数不超过 50 个msg_content 短信内容 短信内容长度不超过 500 个汉字每个英文或阿拉伯
4、字符也算 1 个汉字corp_msg_id 用户发送短信自己定义的短信 id用于处理群发状态报告 可以为空英文和数字的组合总长度不超过 50个字节Ext 用户自己分配的小号（即显示在接收手机上的主叫尾号，可用于上行信息匹配）例：我们给合作方开的特服号是 10657532521924，然后合作方在发送信息的时候可以随意填写扩展号 ext=8888，那么用户收到信息时显示的下发号码就是106575325219248888从 00000 到 99999 的范围 北京红树科技 HTTP 接口文档第 3 页 共 9 页说明：1）发送速度：接口的访问间隔是 0.1 秒，最快访问速度是每秒十次。2）IP：如
5、果用户开账户时指定 IP，则接口只接收该 IP 发送请求。接口编码格式：根据不同开发语言可选用 gbk 或 ISO-8859-1 编码（提交信息时，汉字应转成 gbk 或 iso-8859-1 提交，否则手机用户收到会显示乱码）1.3 发送返回参数说明返回代码 代码说明0#数字 提交成功#提交成功的手机数量100 余额不足101 账号关闭102 短信内容超过 500 字或为空或内容编码格式不正确103 手机号码超过 50 个或合法的手机号码为空104 用户访问时间间隔低于 50 毫秒105 用户访问方式不是 post 方式106 用户名不存在107 密码错误108 指定访问 ip 错误109
6、业务不存在110 小号不合法111 短信内容内有敏感词常见问题说明：1) 长短信：对于长短信，返回的是用户提交的条数，而不是实际扣费的条数，例如用户发送了 190 字的短信三条，返回的是 0#3,后台根据拆分后的结果，计费为 9 条。2) 102 错误：确认接口编码格式是否正确，测试标准是发送带有“%”的短信看是否能成功发送。 北京红树科技 HTTP 接口文档第 4 页 共 9 页2 账户余额查询2.1 接口地址接口地址： http:/211.103.155.246:8888/get_balance.do2.2 接口参数参数名称 参数说明 备注corp_id 企 业 接 口 访 问 id 由
7、系 统 管 理 员 开 通user_id 用户 idPwd 系 统 访 问 接 口 密 码 由 系 统 管 理 员 设 定说明：支持非一级账户余额查询返回结果为：ok:余额。 北京红树科技 HTTP 接口文档第 5 页 共 9 页3 状态报告用于客户查询每条短信发送的状态是否成功。在收取状态报告之后，请立即调用该接口告知服务端已经成功收取的状态报告编号，否则会重复收取到状态报告接口地址：由合作方提供相应的接收的 url，我方主动推送数据。推送的数据样例(为一整条 xml 格式的字符串，注：是一整条字符串，不是xml 文档)test138100000010 (这个参数表示拆分长短信的条数：0 无
8、长短信，1 表示被拆分为(1/2),(2/2)两条，以此类推.)12345asd 0(这个参数表示短信发送状态： 0 表示成功，其他数字均是失败，113 表示审核拦截，200 表示无状态报告返回，112 黑名单用户)test138100000020 12345asd 200说明：当成功接收我方推送过去的信息时必须给个返回参数：0: 接收成功 9:接收失败 ,这个参数不给的话，我方会认为对方接收信息失败，导致接收数据重复推送。状 态 报 告 的 推 送 ， 有 时 可 能 会 推 一 条 过 去 ， 有 时 可 能 会 推 多 条 过 去 ， 最 多 可一 次 推 200 条 ， 并 且 ， 你
9、 方 接 收 到 我 方 推 送 串 后 ， 应 立 即 回 响 应 ， 同 时 存 起 这 些状 态 报 告 ， 然 后 ， 你 方 再 完 成 插 表 工 作 ， 否 则 ， 边 接 收 边 插 表 ， 插 完 后 再 给 响 应 ，因 时 差 原 因 ， 会 导 致 我 方 接 收 响 应 错 乱 ， 从 而 严 重 影 响 状 态 报 告 的 推 送 。状 态 报 告 是 根 据 mobile 和 msg_id 一 起 来 匹 配 的 北京红树科技 HTTP 接口文档第 6 页 共 9 页返回结果值 含义0 成功-1 失败2 失败112 黑名单用户113 信审拦截115 系统自动拦截2
10、00 无返回状态1000 返回状态未知 北京红树科技 HTTP 接口文档第 7 页 共 9 页4 上行信息上行信息：手机用户给发送方回复的信息。接口地址：有合作方提供相应的 url(上行推送和状态报告推送原理一样，区别：xml 字符串的节点不同，解析的时候需要注意)推送数据样例test13810000000 8888 (对应下发时的 ext 参数根据手机用户回复短信时（即上行信息）的 ext的值， 8888 可知道用户上行的是客户下发的哪一批的信息的回复)2010-07-02 00:00:00收到 返回参数(注意给我方返回接收后的结果参数同上)0：成功9：失败说 明 ：上 行 信 息 是 一 条 一 条 的 推 送 过 去 ， 为 了 更 好 的 接 收 上 行 ， 需 要 你 方 接 收 完 字符 串 后 立 即 返 回 响 应 ， 不 要 等 到 插 入 成 功 后 再 响 应 ， 这 样 才 不 会 影 响 上 行 信 息 的接 收 。上 行 信 息 是 根 据 mobile 和 ext 来 匹 配 的 。 北京红树科技 HTTP 接口文档第 8 页 共 9 页5 附录(java 开发的接收 demo)介绍：我方推送过去的 xml 格式的上行字符串
