2660 lines
86 KiB
JSON
2660 lines
86 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"title": "mini-chat 接口文档",
|
||
"contact": {},
|
||
"version": "v0.0.1"
|
||
},
|
||
"basePath": "/",
|
||
"paths": {
|
||
"/api/admin/app/create": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "新增小程序",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "新增小程序",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/app.createAppRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.createAppResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/delete": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "删除小程序",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "删除小程序",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/app.deleteAppRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.deleteAppResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/keyword": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "添加意图关键字",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "添加意图关键字",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.createKeywordRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.createKeywordResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/keyword/material/{id}": {
|
||
"put": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "修改意图关键字素材",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "修改意图关键字素材",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "素材编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.modifyKeywordMaterialRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.modifyKeywordMaterialResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "配置意图关键字素材",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "配置意图关键字素材",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.createKeywordMaterialRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.createKeywordMaterialResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/keyword/materials": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "获取意图关键字素材列表",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "获取意图关键字素材列表",
|
||
"parameters": [
|
||
{
|
||
"type": "integer",
|
||
"description": "意图关键字ID",
|
||
"name": "keyword_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.keywordMaterialPageListResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/keyword/{id}": {
|
||
"put": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "修改意图关键字",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "修改意图关键字",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.modifyKeywordRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.modifyKeywordResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"delete": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "删除意图关键字",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "删除意图关键字",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.deleteKeywordResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/keywords": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "获取意图关键字列表",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.意图关键字"
|
||
],
|
||
"summary": "获取意图关键字列表",
|
||
"parameters": [
|
||
{
|
||
"type": "integer",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "意图关键字",
|
||
"name": "keyword",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/keyword.keywordPageListResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/users": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "小程序用户列表",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "小程序用户列表",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "用户昵称",
|
||
"name": "user_name",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "用户ID",
|
||
"name": "user_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.userListResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/app/{id}": {
|
||
"put": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "编辑小程序",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "编辑小程序",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/app.modifyAppRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.modifyAppResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/apps": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "小程序列表",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "小程序列表",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "小程序名称",
|
||
"name": "name",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"description": "客服编号",
|
||
"name": "admin_id",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.listResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/create": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "新增客服",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.客服管理"
|
||
],
|
||
"summary": "新增客服",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.createAdminRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.createAdminResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/delete": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "删除客服",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.客服管理"
|
||
],
|
||
"summary": "删除客服",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.deleteAdminRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.deleteAdminResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/list": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "客服列表",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.客服管理"
|
||
],
|
||
"summary": "客服列表",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "用户名",
|
||
"name": "username",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "昵称",
|
||
"name": "nickname",
|
||
"in": "query"
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.listResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/login": {
|
||
"post": {
|
||
"description": "管理员登录",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.登录"
|
||
],
|
||
"summary": "管理员登录",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.loginRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.loginResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/messages": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "获取消息日志",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "获取消息日志",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "用户ID",
|
||
"name": "user_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.appMessagePageListResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/messages/latest": {
|
||
"get": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "管理端根据appid获取最新消息记录，包含已读未读状态，访问时自动标记为已读",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "根据appid获取最新消息记录",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.latestMessageByAppIdResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/rel_app/{id}": {
|
||
"put": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "客服关联小程序",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.客服管理"
|
||
],
|
||
"summary": "客服关联小程序",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "客服编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.relAppRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.relAppResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/send_message": {
|
||
"post": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "管理员发送消息",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.小程序"
|
||
],
|
||
"summary": "管理员发送消息",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/app.adminSendMessageRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.adminSendMessageResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/upload/image": {
|
||
"post": {
|
||
"description": "上传图片",
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"通用"
|
||
],
|
||
"summary": "上传图片",
|
||
"parameters": [
|
||
{
|
||
"type": "file",
|
||
"description": "选择文件",
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/upload.uploadImageResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/admin/{id}": {
|
||
"put": {
|
||
"security": [
|
||
{
|
||
"LoginVerifyToken": []
|
||
}
|
||
],
|
||
"description": "编辑客服",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"管理端.客服管理"
|
||
],
|
||
"summary": "编辑客服",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "编号ID",
|
||
"name": "id",
|
||
"in": "path",
|
||
"required": true
|
||
},
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.modifyAdminRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/admin.modifyAdminResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/app/messages": {
|
||
"get": {
|
||
"description": "获取消息日志",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"用户端"
|
||
],
|
||
"summary": "获取消息日志",
|
||
"parameters": [
|
||
{
|
||
"type": "string",
|
||
"description": "小程序ID",
|
||
"name": "app_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "string",
|
||
"description": "用户ID",
|
||
"name": "user_id",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 1,
|
||
"description": "当前页码",
|
||
"name": "page",
|
||
"in": "query",
|
||
"required": true
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"default": 20,
|
||
"description": "每页返回的数据量，最多 100 条",
|
||
"name": "page_size",
|
||
"in": "query",
|
||
"required": true
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/message.appMessagePageListResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/app/send_message": {
|
||
"post": {
|
||
"description": "用户发送消息",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"用户端"
|
||
],
|
||
"summary": "用户发送消息",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/message.userSendMessageRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/message.userSendMessageResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/app/user/create": {
|
||
"post": {
|
||
"description": "新增小程序用户",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"用户端"
|
||
],
|
||
"summary": "新增小程序用户",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "RequestBody",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/app.createAppUserRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/app.createAppUserResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/wechat/miniprogram/login": {
|
||
"post": {
|
||
"description": "通过AppID和code获取用户的openid，系统自动生成用户名和头像",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"微信"
|
||
],
|
||
"summary": "小程序登录",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.miniprogramLoginRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.miniprogramLoginResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/wechat/qrcode": {
|
||
"post": {
|
||
"description": "根据 AppID、AppSecret 和页面路径生成微信小程序二维码",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"微信"
|
||
],
|
||
"summary": "生成微信小程序二维码",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.generateQRCodeRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.generateQRCodeResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/wechat/subscribe": {
|
||
"post": {
|
||
"description": "根据模板ID发送订阅消息",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"微信"
|
||
],
|
||
"summary": "发送订阅消息",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.sendSubscribeMessageRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.sendSubscribeMessageResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/wechat/template": {
|
||
"post": {
|
||
"description": "根据 AppID 获取微信小程序的模板ID",
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"tags": [
|
||
"微信"
|
||
],
|
||
"summary": "获取微信小程序模板ID",
|
||
"parameters": [
|
||
{
|
||
"description": "请求参数",
|
||
"name": "request",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.templateRequest"
|
||
}
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "OK",
|
||
"schema": {
|
||
"$ref": "#/definitions/wechat.templateResponse"
|
||
}
|
||
},
|
||
"400": {
|
||
"description": "Bad Request",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"404": {
|
||
"description": "Not Found",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
},
|
||
"500": {
|
||
"description": "Internal Server Error",
|
||
"schema": {
|
||
"$ref": "#/definitions/code.Failure"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"admin.createAdminRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"nickname",
|
||
"password",
|
||
"username"
|
||
],
|
||
"properties": {
|
||
"avatar": {
|
||
"description": "头像",
|
||
"type": "string"
|
||
},
|
||
"mobile": {
|
||
"description": "手机号",
|
||
"type": "string"
|
||
},
|
||
"nickname": {
|
||
"description": "昵称",
|
||
"type": "string"
|
||
},
|
||
"password": {
|
||
"description": "密码",
|
||
"type": "string"
|
||
},
|
||
"username": {
|
||
"description": "用户名",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.createAdminResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.deleteAdminRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"ids"
|
||
],
|
||
"properties": {
|
||
"ids": {
|
||
"description": "编号(多个用,分割)",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.deleteAdminResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.listData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"avatar": {
|
||
"description": "头像",
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "创建时间",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "编号",
|
||
"type": "integer"
|
||
},
|
||
"mobile": {
|
||
"description": "手机号",
|
||
"type": "string"
|
||
},
|
||
"nickname": {
|
||
"description": "昵称",
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"description": "更新时间",
|
||
"type": "string"
|
||
},
|
||
"username": {
|
||
"description": "用户名",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.listResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/admin.listData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"admin.loginRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"password",
|
||
"username"
|
||
],
|
||
"properties": {
|
||
"password": {
|
||
"description": "密码 (MD5加密后的密码)",
|
||
"type": "string"
|
||
},
|
||
"username": {
|
||
"description": "用户名",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.loginResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"is_super": {
|
||
"description": "是否是超级管理员(1:是 0:否)",
|
||
"type": "integer"
|
||
},
|
||
"token": {
|
||
"description": "登录成功后颁发的 Token",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.modifyAdminRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"nickname",
|
||
"password",
|
||
"username"
|
||
],
|
||
"properties": {
|
||
"avatar": {
|
||
"description": "头像",
|
||
"type": "string"
|
||
},
|
||
"mobile": {
|
||
"description": "手机号",
|
||
"type": "string"
|
||
},
|
||
"nickname": {
|
||
"description": "昵称",
|
||
"type": "string"
|
||
},
|
||
"password": {
|
||
"description": "密码",
|
||
"type": "string"
|
||
},
|
||
"username": {
|
||
"description": "用户名",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.modifyAdminResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.relAppRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"ids"
|
||
],
|
||
"properties": {
|
||
"ids": {
|
||
"description": "小程序编号(多个用,分割)",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"admin.relAppResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.adminSendMessageRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"content",
|
||
"msg_type",
|
||
"to_user_id"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"content": {
|
||
"description": "内容",
|
||
"type": "string"
|
||
},
|
||
"msg_type": {
|
||
"description": "消息类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
},
|
||
"to_user_id": {
|
||
"description": "接收用户ID",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.adminSendMessageResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.appMessagePageListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/app.listMessageData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"app.createAppRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"app_secret",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"app_secret": {
|
||
"description": "小程序密钥",
|
||
"type": "string"
|
||
},
|
||
"avatar": {
|
||
"description": "头像",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"description": "描述",
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "名称",
|
||
"type": "string"
|
||
},
|
||
"template_id": {
|
||
"description": "模版ID",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.createAppResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.createAppUserRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"user_id",
|
||
"user_name"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"user_avatar": {
|
||
"description": "用户头像",
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"description": "用户ID",
|
||
"type": "string"
|
||
},
|
||
"user_mobile": {
|
||
"description": "用户手机号",
|
||
"type": "string"
|
||
},
|
||
"user_name": {
|
||
"description": "用户昵称",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.createAppUserResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.deleteAppRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"ids"
|
||
],
|
||
"properties": {
|
||
"ids": {
|
||
"description": "小程序编号(多个用,分割)",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.deleteAppResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.latestMessageByAppIdResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/app.latestMessageData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"app.latestMessageData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "消息内容",
|
||
"type": "string"
|
||
},
|
||
"msg_type": {
|
||
"description": "消息类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
},
|
||
"send_time": {
|
||
"description": "发送时间",
|
||
"type": "string"
|
||
},
|
||
"sender_avatar": {
|
||
"description": "发送人头像",
|
||
"type": "string"
|
||
},
|
||
"sender_id": {
|
||
"description": "发送人ID",
|
||
"type": "string"
|
||
},
|
||
"sender_name": {
|
||
"description": "发送人昵称",
|
||
"type": "string"
|
||
},
|
||
"unread_count": {
|
||
"description": "未读消息数量",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"app.listData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"app_secret": {
|
||
"description": "小程序密钥",
|
||
"type": "string"
|
||
},
|
||
"avatar": {
|
||
"description": "小程序头像",
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "创建时间",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"description": "小程序描述",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "小程序编号",
|
||
"type": "integer"
|
||
},
|
||
"message_total": {
|
||
"description": "消息总数",
|
||
"type": "integer"
|
||
},
|
||
"name": {
|
||
"description": "小程序名称",
|
||
"type": "string"
|
||
},
|
||
"template_id": {
|
||
"description": "模版ID",
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"description": "更新时间",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.listMessageData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "消息内容",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "消息ID",
|
||
"type": "string"
|
||
},
|
||
"msg_type": {
|
||
"description": "消息类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
},
|
||
"receiver_id": {
|
||
"description": "接收人ID",
|
||
"type": "string"
|
||
},
|
||
"send_time": {
|
||
"description": "发送时间",
|
||
"type": "string"
|
||
},
|
||
"sender_id": {
|
||
"description": "发送人ID",
|
||
"type": "string"
|
||
},
|
||
"sender_name": {
|
||
"description": "发送人昵称",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.listResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/app.listData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"app.modifyAppRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"app_secret",
|
||
"name"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"app_secret": {
|
||
"description": "小程序密钥",
|
||
"type": "string"
|
||
},
|
||
"avatar": {
|
||
"description": "头像",
|
||
"type": "string"
|
||
},
|
||
"description": {
|
||
"description": "描述",
|
||
"type": "string"
|
||
},
|
||
"name": {
|
||
"description": "名称",
|
||
"type": "string"
|
||
},
|
||
"template_id": {
|
||
"description": "模版ID",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.modifyAppResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.userListData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"created_at": {
|
||
"description": "创建时间",
|
||
"type": "string"
|
||
},
|
||
"user_avatar": {
|
||
"description": "用户头像",
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"description": "用户ID",
|
||
"type": "string"
|
||
},
|
||
"user_mobile": {
|
||
"description": "用户手机号",
|
||
"type": "string"
|
||
},
|
||
"user_name": {
|
||
"description": "用户昵称",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"app.userListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/app.userListData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"code.Failure": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"description": "业务码",
|
||
"type": "integer"
|
||
},
|
||
"message": {
|
||
"description": "描述信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.createKeywordMaterialRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"material_list"
|
||
],
|
||
"properties": {
|
||
"material_list": {
|
||
"description": "素材列表",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/keyword.keywordMaterial"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"keyword.createKeywordMaterialResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.createKeywordRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"keyword"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"keyword": {
|
||
"description": "关键字",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.createKeywordResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"id": {
|
||
"description": "关键字ID",
|
||
"type": "integer"
|
||
},
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.deleteKeywordResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.keywordListData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "创建时间",
|
||
"type": "string"
|
||
},
|
||
"created_user": {
|
||
"description": "创建人",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "关键字编号",
|
||
"type": "integer"
|
||
},
|
||
"keyword": {
|
||
"description": "意图关键字",
|
||
"type": "string"
|
||
},
|
||
"material_type_count": {
|
||
"description": "素材类型数量",
|
||
"type": "string"
|
||
},
|
||
"updated_at": {
|
||
"description": "更新时间",
|
||
"type": "string"
|
||
},
|
||
"updated_user": {
|
||
"description": "更新人",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.keywordMaterial": {
|
||
"type": "object",
|
||
"required": [
|
||
"content",
|
||
"interval_seconds",
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"content": {
|
||
"description": "素材内容",
|
||
"type": "string"
|
||
},
|
||
"interval_seconds": {
|
||
"description": "发送间隔时间(单位:秒)",
|
||
"type": "integer"
|
||
},
|
||
"type": {
|
||
"description": "素材类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"keyword.keywordMaterialListData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "素材内容",
|
||
"type": "string"
|
||
},
|
||
"created_at": {
|
||
"description": "创建时间",
|
||
"type": "string"
|
||
},
|
||
"created_user": {
|
||
"description": "创建人",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "主键ID",
|
||
"type": "integer"
|
||
},
|
||
"interval_seconds": {
|
||
"description": "素材发送间隔时间(单位:秒)",
|
||
"type": "integer"
|
||
},
|
||
"keyword_id": {
|
||
"description": "意图关键字ID",
|
||
"type": "integer"
|
||
},
|
||
"type": {
|
||
"description": "素材类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"keyword.keywordMaterialPageListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/keyword.keywordMaterialListData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"keyword.keywordPageListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/keyword.keywordListData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"keyword.modifyKeywordMaterialRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"content",
|
||
"interval_seconds",
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"content": {
|
||
"description": "素材内容",
|
||
"type": "string"
|
||
},
|
||
"interval_seconds": {
|
||
"description": "发送间隔时间(单位:秒)",
|
||
"type": "integer"
|
||
},
|
||
"type": {
|
||
"description": "素材类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"keyword.modifyKeywordMaterialResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.modifyKeywordRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"keyword"
|
||
],
|
||
"properties": {
|
||
"keyword": {
|
||
"description": "意图关键字",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"keyword.modifyKeywordResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"message.appMessagePageListResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"list": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/message.listMessageData"
|
||
}
|
||
},
|
||
"page": {
|
||
"description": "当前页码",
|
||
"type": "integer"
|
||
},
|
||
"page_size": {
|
||
"description": "每页返回的数据量",
|
||
"type": "integer"
|
||
},
|
||
"total": {
|
||
"description": "符合查询条件的总记录数",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"message.listMessageData": {
|
||
"type": "object",
|
||
"properties": {
|
||
"content": {
|
||
"description": "消息内容",
|
||
"type": "string"
|
||
},
|
||
"id": {
|
||
"description": "消息ID",
|
||
"type": "integer"
|
||
},
|
||
"msg_type": {
|
||
"description": "消息类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
},
|
||
"receiver_id": {
|
||
"description": "接收人ID",
|
||
"type": "string"
|
||
},
|
||
"send_time": {
|
||
"description": "发送时间",
|
||
"type": "string"
|
||
},
|
||
"sender_id": {
|
||
"description": "发送人ID",
|
||
"type": "string"
|
||
},
|
||
"sender_name": {
|
||
"description": "发送人昵称",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"message.userSendMessageRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"content",
|
||
"from_user_id",
|
||
"from_user_name",
|
||
"msg_type"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序ID",
|
||
"type": "string"
|
||
},
|
||
"content": {
|
||
"description": "内容",
|
||
"type": "string"
|
||
},
|
||
"from_user_id": {
|
||
"description": "发送用户的ID",
|
||
"type": "string"
|
||
},
|
||
"from_user_name": {
|
||
"description": "发送用户的昵称",
|
||
"type": "string"
|
||
},
|
||
"msg_type": {
|
||
"description": "消息类型(1:文本 2:图片)",
|
||
"type": "integer"
|
||
}
|
||
}
|
||
},
|
||
"message.userSendMessageResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"description": "提示信息",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"upload.uploadImageResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"preview_image_url": {
|
||
"description": "可预览图片地址",
|
||
"type": "string"
|
||
},
|
||
"real_image_url": {
|
||
"description": "真实图片地址",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.generateQRCodeRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"app_secret",
|
||
"path"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "微信小程序 AppID",
|
||
"type": "string"
|
||
},
|
||
"app_secret": {
|
||
"description": "微信小程序 AppSecret",
|
||
"type": "string"
|
||
},
|
||
"path": {
|
||
"description": "小程序页面路径",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.generateQRCodeResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"data": {
|
||
"description": "Base64 编码的图片数据",
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"wechat.miniprogramLoginRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"js_code"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序AppID",
|
||
"type": "string"
|
||
},
|
||
"js_code": {
|
||
"description": "登录时获取的code",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.miniprogramLoginResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"openid": {
|
||
"description": "用户唯一标识",
|
||
"type": "string"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"token": {
|
||
"description": "登录token",
|
||
"type": "string"
|
||
},
|
||
"unionid": {
|
||
"description": "用户在开放平台的唯一标识符",
|
||
"type": "string"
|
||
},
|
||
"user_avatar": {
|
||
"description": "用户头像",
|
||
"type": "string"
|
||
},
|
||
"user_id": {
|
||
"description": "用户ID",
|
||
"type": "string"
|
||
},
|
||
"user_name": {
|
||
"description": "用户昵称",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.sendSubscribeMessageRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id",
|
||
"app_secret",
|
||
"template_id",
|
||
"touser"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "微信小程序 AppID",
|
||
"type": "string"
|
||
},
|
||
"app_secret": {
|
||
"description": "小程序 AppSecret",
|
||
"type": "string"
|
||
},
|
||
"template_id": {
|
||
"description": "模板 ID",
|
||
"type": "string"
|
||
},
|
||
"touser": {
|
||
"description": "接收者（用户）的 openid",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.sendSubscribeMessageResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"wechat.templateRequest": {
|
||
"type": "object",
|
||
"required": [
|
||
"app_id"
|
||
],
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "微信小程序 AppID",
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"wechat.templateResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"app_id": {
|
||
"description": "小程序 AppID",
|
||
"type": "string"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"template_id": {
|
||
"description": "模板 ID",
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"securityDefinitions": {
|
||
"LoginVerifyToken": {
|
||
"type": "apiKey",
|
||
"name": "Authorization",
|
||
"in": "header"
|
||
}
|
||
}
|
||
} |