v1.0 用户发送消息的接口文档的初步生成
前言
功能介绍
用户只需要简单的配置后,就可以实现消息的多种方式提醒,同时省去了微信公众号的申请开发等流程,用户通过调用发送消息接口,可以实现手机、微信公众号、企业微信群机器人、钉钉群机器人、邮箱、webhook等方式等全方位消息提醒。不同的提醒方式效果如下:
手机
企业微信群机器人
钉钉群机器人
邮箱
webhook
API文档正文
一、发送消息
请求地址:http://tui.juhe.cn/api/plus/pushApi
请求方式:POST
Content-Type: application/json
请求参数
参数名称 | 参数类型 | 默认值 | 是否必须 | 说明 |
---|---|---|---|---|
token | varchar(32) | - | 是 | 用户令牌 |
title | varchar(32) | - | 是 | 消息标题 |
content | varchar(10000) | - | 是 | 具体消息内容,根据不同template支持不同格式 |
service_id | varchar(6) | - | 是 | 服务id |
doc_type | varchar(6) | - | 否 | 发送消息格式,支持txt、html、json、markdown,默认为txt |
响应参数
字段名称 | 字段类型 | 默认值 | 说明 |
---|---|---|---|
code | int | - | 状态码 |
reason | varchar(32) | - | 响应说明 |
params | object | - | 可忽略 |
result | object | - | 可忽略 |
响应数据示例
{
"code": 200,
"params": null,
"reason": "success",
"result": null
}
响应状态码说明
状态码 | 说明 |
---|---|
0 | 请求成功 |
101 | token错误 |
102 | service_id错误 |
103 | 创建的服务已经被关闭,请核实 |
104 | title长度错误 |
105 | content长度错误 |
106 | 服务异常,系统繁忙 |