消息
baseUrl :https://www.oauthapp.com
消息表需要使用oauthapp发布工具创建。
消息表集合
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/Tables | :appId 部分需要替换为实际应用的 ID |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 返回一个数组,每个元素代表1个消息表的名称 |
err | 错误信息 |
消息组
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/:table/Categories | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际的消息表名称 |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 返回一个数组,每个元素代表1个分类 |
err | 错误信息 |
消息列表
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/:table?category=&tag=&search=&take=10&skip=0 | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际的消息表名称 |
登陆凭证 | Bearer Token | |
参数说明 |
||
category | 消息组 | |
tag | 消息标签 | |
search | 查询关键词 | |
take | 拉取条数 | 10 |
skip | 跳过条数 | 0 |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | 具体包含total、data 、take 和 skip |
err | 错误信息 |
{
"code": 200,
"data": {
"total": 2,
"data": [
{
"id": 2,
"category": "17_20221123.18.7",
"unionID": "a0bfc6e0d3b03383b0ea9f23673d2c58",
"nickName": "张三",
"avatar": "https://blob.oauthapp.com/4/tenant/4/%E5%BA%94%E7%94%A8.png",
"platform": "dingtalk",
"messageType": "TEXT",
"content": "2121",
"remark": "",
"tags": "",
"showIndex": 0,
"createDate": "2022-11-24 17:08:41",
"lastUpdate": "2022-11-24 17:08:41"
},
{
"id": 1,
"category": "125_20221124.17.39",
"unionID": "a0bfc6e0d3b03383b0ea9f23673d2c58",
"nickName": "张三",
"avatar": "https://blob.oauthapp.com/4/tenant/4/%E5%BA%94%E7%94%A8.png",
"platform": "dingtalk",
"messageType": "TEXT",
"content": "2121",
"remark": "",
"tags": "",
"showIndex": 0,
"createDate": "2022-11-24 17:07:11",
"lastUpdate": "2022-11-24 17:07:11"
}
],
"take": 10,
"skip": 0
},
"err": ""
}
发送消息
描述 | ||
---|---|---|
请求方式 | POST | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/:table | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际的消息表名称 |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | true 或 false |
err | 错误信息 |
删除消息
描述 | ||
---|---|---|
请求方式 | DELETE | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/:table/:id | :appId 部分需要替换为实际应用的 ID;:table 需要替换为实际消息表的名称;:id 需要替换为实际单条数据的id |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | true 或 false |
err | 错误信息 |
修改消息
描述 | ||
---|---|---|
请求方式 | GET | |
请求地址 | {{baseUrl}}/api/AppChatMessages/:appId/:table/:id | :appId 部分需要替换为实际应用的 ID |
登陆凭证 | Bearer Token |
返回示例
描述 | ||
---|---|---|
code | 表示返回结果的状态码 | 200 表示成功,非 200 表示失败 |
data | 表示返回的数据 | true 或 false |
err | 错误信息 |