下面是关于在线接口文档-在线接口文档管理工具

易文档

英文名叫easydoc，是新出来的文档管理平台，跟市面的那些有所不同，这个不管是编写体验还是预览，专业性和美观性都会大大超越其他的。

看下他的预览效果：

市面很多http接口文档的编写都是直接写markdown文档，这种编写起来特别麻烦。易文档在http文档方面有做专门的处理，做了很多优化体验，比如按tab就可以自动下一个输入框，可以保存一些常用的参数，方便快速引用进来，还有不限层次的子参数，参数行顺序调整。

特别强大的是，他的http文档可以自定义参数块和描述块，比如失败和成功返回的参数不一样，我们可以添加两个参数块，分别对应成功响应参数、失败响应参数

如果你想给每个返回都提供一个示例或者说明，也都没问题，可以自己添加描述块。而且块的顺序是可以调整的，非常方便。

修订历史

目录

HTTP接口文档修订历史目录1. 用户提交1.1 接口公共参数说明1.2 接口通用返回值说明1.2.1 返回参数2.个性（批量）短信提交2.1 用户2.1.1 用户批量提交2.1.2 获取状态报告2.1.3 获取上行信息2.1.4 获取余额3. 附录3.1 提交响应错误码3.2 状态报告错误码

1. 用户提交

• 请求地址：http://sms.51yixun.com:8200/sms/sendBatch

1.1 接口公共参数说明

请求示例

http://ip:port/sms/sendBatch?appId=LHW-SMS-2XG&sign=e0be54f095fc72ee82a70dae644e7a0&mobiles=13000000000,15000000000&content=%E3%80%90%E9%B8%BF%E8%81%94%E4%B9%9D%E4%BA%94%E3%80%91%E6%82%A8%E5%A5%BD%EF%BC%8C%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%81%E6%98%AF252111&timestamp=20190409153345&schTime=&batchId=101&addserial=3

1.2 接口通用返回值说明

1.2.1 返回参数

响应示例

{   "code": "SUCCESS",   "data": ""}

##

2.个性（批量）短信提交

2.1 用户

2.1.1 用户批量提交

接口说明

如需要大批量发送个性短信，减少HTTP请求次数，时间，可用此接口进行发送。可定时发送，定时本批提交的所有的个性短信的发送时间

URL

http://sms.51yixun.com:8200/sms/send

请求方式

get

参数请求格式

url

请求参数

请求示例

http://ip:port/sms/send?appId=LHW-SMS-1LL&timestamp=20190409170903&sign=5063d9ecad6559113a8a385dda985d4&batchId=121121&addserial=001&13000000000=%E3%80%90%E8%81%94%E5%90%88%E3%80%91%E6%82%A8%E7%9A%84%E9%AA%8C%E8%AF%81%E7%A0%

返回参数

响应示例

{   "code": "SUCCESS",   "data": ""}

异常示例

{   "code": "SUCCESS",   "data": ""}

返回码说明

详细参考附录中全局返回码

备注

无

2.1.2 获取状态报告

接口说明

用于用户批量提交

URL

http://sms.51yixun.com:8200/sms/report

请求方式

get

参数请求格式

url

请求参数

请求示例

http://ip:port/sms/report?appId=LHW-SMS-2FG&sign=e0be54f095fc72ebea70dae644e7a0&timestamp=20190409153345

返回参数

响应示例：请求后有可返回的状态报告时：

{   "code": "SUCCESS",   "data": [       {"batchId":"101",        "state":"DELIVRD",        "desc":"成功",        "mobile":"15000000000",        "receiveTime":"2019-04-09 15:34:01",        "submitTime":"2019-04-09 15:32:30",        "addserial":"3"},       {"batchId":"101",        "state":"DELIVRD",        "desc":"成功",        "mobile":"13000000000",        "receiveTime":"2019-04-09 15:34:01",        "submitTime":"2019-04-09 15:32:30",        "addserial":"3"}]}

异常示例:请求后没有可返回的状态报告

{   "code": "SUCCESS",   "data": ""}

返回码说明

详细参考附录中全局返回码

备注

无

2.1.3 获取上行信息

接口说明

用于用户获取上行

URL

http://sms.51yixun.com:8200/sms/mo

请求方式

get

参数请求格式

url

请求参数

请求示例

http://ip:port/sms/mo?appId=LHW-SMS-2XG&sign=e0be54f095fc72ebe82a70dae44e7a0&timestamp=20190409153345

返回参数

响应示例：请求后有可返回的上行信息时

{   "code": "SUCCESS",   "data": [{                         "mobile":"18313086061",          "addserial":"3",             "content":"收到，谢谢",                "moTime":"2019-04-09 15:34:01"            }]}

异常示例:请求后没有可返回的上行信息时：

{   "code": "SUCCESS",   "data": ""}

返回码说明

详细参考附录中全局返回码

备注

无

2.1.4 获取余额

接口说明

用于用户获取余额

URL

http://sms.51yixun.com:8200/sms/balance

请求方式

get

参数请求格式

url

请求参数

请求示例

http://ip:port/sms/balance?appId=LHW-SMS-2XG&sign=e0be54f095febe82a70dae644e7a0&timestamp=20190409153345

返回参数

响应示例

{   "code": "SUCCESS",   "data":          ｛         "balance":999       ｝}

返回码说明

详细参考附录中全局返回码

备注

无

3. 附录

3.1 提交响应错误码

3.2 状态报告错误码

以上就是小编为大家整理的在线接口文档-在线接口文档管理工具

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。