You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Open-IM-Server/cmd/open_im_api/docs/docs.go

5993 lines
199 KiB

2 years ago
// Package docs GENERATED BY SWAG; DO NOT EDIT
// This file was generated by swaggo/swag
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
2 years ago
"contact": {},
2 years ago
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
2 years ago
"/auth/force_logout": {
2 years ago
"post": {
2 years ago
"description": "对应的平台强制登出",
2 years ago
"consumes": [
"application/json"
],
2 years ago
"produces": [
"application/json"
],
2 years ago
"tags": [
2 years ago
"鉴权认证"
2 years ago
],
2 years ago
"summary": "强制登出",
"operationId": "ForceLogout",
2 years ago
"parameters": [
{
"type": "string",
2 years ago
"description": "im token",
"name": "token",
"in": "header",
2 years ago
"required": true
2 years ago
},
{
2 years ago
"description": "platform为平台ID, fromUserID为要执行强制登出的用户ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ForceLogoutReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ForceLogoutResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ForceLogoutResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ForceLogoutResp"
2 years ago
}
}
}
}
},
2 years ago
"/auth/parse_token": {
2 years ago
"post": {
2 years ago
"description": "解析用户token",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"鉴权认证"
2 years ago
],
2 years ago
"summary": "解析token",
"operationId": "ParseToken",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段, platform为平台ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ParseTokenReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ParseTokenResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ParseTokenResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ParseTokenResp"
2 years ago
}
}
}
}
},
2 years ago
"/auth/user_register": {
2 years ago
"post": {
2 years ago
"description": "用户登录",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"鉴权认证"
2 years ago
],
2 years ago
"summary": "用户登录",
"operationId": "UserRegister",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID \u003cbr\u003e ex为拓展字段",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserRegisterReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserRegisterResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserRegisterResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserRegisterResp"
2 years ago
}
}
}
}
},
2 years ago
"/auth/user_token": {
2 years ago
"post": {
2 years ago
"description": "获取用户的token",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"鉴权认证"
2 years ago
],
2 years ago
"summary": "用户登录",
"operationId": "UserToken",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "secret为openIM密钥, 详细见服务端config.yaml secret字段, platform为平台ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserTokenReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserTokenResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserTokenResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.UserTokenResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/add_black": {
2 years ago
"post": {
2 years ago
"description": "添加黑名单",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "添加黑名单",
"operationId": "AddBlack",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为设置的用户, toUserID为被设置的用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddBlacklistReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddBlacklistResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddBlacklistResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddBlacklistResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/add_friend": {
2 years ago
"post": {
2 years ago
"description": "添加好友",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "添加好友",
"operationId": "AddFriend",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "reqMsg为申请信息, fromUserID为申请用户, toUserID为被添加用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResp"
2 years ago
}
2 years ago
}
2 years ago
}
}
},
2 years ago
"/friend/add_friend_response": {
2 years ago
"post": {
2 years ago
"description": "同意/拒绝好友请求",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "同意/拒绝好友请求",
"operationId": "AddFriendResponse",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID同意/拒绝的用户ID, toUserID为申请用户, handleMsg为处理信息, flag为具体操作, 1为同意, 2为拒绝",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResponseReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResponseResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResponseResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.AddFriendResponseResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/delete_friend": {
2 years ago
"post": {
2 years ago
"description": "删除好友",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "删除好友",
"operationId": "DeleteFriend",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为操作用户, toUserID为被删除用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DeleteFriendReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DeleteFriendResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DeleteFriendResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DeleteFriendResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/get_black_list": {
2 years ago
"post": {
2 years ago
"description": "获取黑名单列表",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "获取黑名单列表",
"operationId": "GetBlacklist",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID要获取黑名单的用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetBlackListReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetBlackListResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetBlackListResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetBlackListResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/get_friend_apply_list": {
2 years ago
"post": {
2 years ago
"description": "删除好友",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "获取好友申请列表",
"operationId": "GetFriendApplyList",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为要获取申请列表的用户ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendApplyListReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendApplyListResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendApplyListResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendApplyListResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/get_friend_list": {
2 years ago
"post": {
2 years ago
"description": "获取用户的好友列表",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "获取用户的好友列表",
"operationId": "GetFriendList",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为要获取好友列表的用户ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendListReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendListResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendListResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetFriendListResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/get_self_friend_apply_list": {
2 years ago
"post": {
2 years ago
"description": "获取自己的好友申请列表",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "获取自己的好友申请列表",
"operationId": "GetSelfFriendApplyList",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为自己的用户ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetSelfApplyListReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetSelfApplyListResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetSelfApplyListResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetSelfApplyListResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/import_friend": {
2 years ago
"post": {
2 years ago
"description": "批量加好友",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "批量加好友",
"operationId": "ImportFriend",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID批量加好友的用户ID, friendUserIDList为",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ImportFriendReq"
2 years ago
}
}
],
"responses": {
"0": {
2 years ago
"description": "data列表中对象的result-1为添加该用户失败, 0为成功",
2 years ago
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ImportFriendResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ImportFriendResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.ImportFriendResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/is_friend": {
2 years ago
"post": {
2 years ago
"description": "检查用户之间是否为好友",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "检查用户之间是否为好友",
"operationId": "IsFriend",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为请求用户, toUserID为要检查的用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.IsFriendReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.IsFriendResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.IsFriendResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.IsFriendResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/remove_black": {
2 years ago
"post": {
2 years ago
"description": "把用户移除黑名单",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "把用户移除黑名单",
"operationId": "RemoveBlack",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID要获取黑名单的用户",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.RemoveBlackListReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.RemoveBlackListResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.RemoveBlackListResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.RemoveBlackListResp"
2 years ago
}
}
}
}
},
2 years ago
"/friend/set_friend_remark": {
2 years ago
"post": {
2 years ago
"description": "设置好友备注",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"好友相关"
2 years ago
],
2 years ago
"summary": "设置好友备注",
"operationId": "SetFriendRemark",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "fromUserID为设置的用户, toUserID为被设置的用户 remark为好友备注",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.SetFriendRemarkReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.SetFriendRemarkResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.SetFriendRemarkResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.SetFriendRemarkResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/cancel_mute_group": {
2 years ago
"post": {
2 years ago
"description": "取消禁言群组",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "取消禁言群组",
"operationId": "CancelMuteGroup",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "groupID为群组ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/cancel_mute_group_member": {
2 years ago
"post": {
2 years ago
"description": "取消禁言群成员",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "取消禁言群成员",
"operationId": "CancelMuteGroupMember",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "groupID为群组ID \u003cbr\u003e userID为要取消禁言的用户ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupMemberReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupMemberResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupMemberResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CancelMuteGroupMemberResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/create_group": {
2 years ago
"post": {
2 years ago
"description": "创建群组",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "创建群组",
"operationId": "CreateGroup",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "ownerUserID为群主ID \u003cbr\u003e ex为群扩展字段 \u003cbr\u003e roleLevel为群员角色,1为普通用户 2为群主 3为管理员",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CreateGroupReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"allOf": [
{
"$ref": "#/definitions/base_info.CreateGroupResp"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/server_api_params.GroupInfo"
}
}
}
]
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CreateGroupResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.CreateGroupResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/dismiss_group": {
2 years ago
"post": {
2 years ago
"description": "解散群组",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "解散群组",
"operationId": "DismissGroup",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "groupID为要解散的群组ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DismissGroupReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DismissGroupResp"
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DismissGroupResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.DismissGroupResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/get_group_all_member_list": {
2 years ago
"post": {
2 years ago
"description": "获取全部群成员列表",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "获取全部群成员列表",
"operationId": "GetGroupAllMemberList",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "GroupID为要获取群成员的群ID",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupAllMemberReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"allOf": [
{
"$ref": "#/definitions/base_info.GetGroupAllMemberResp"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/server_api_params.GroupMemberFullInfo"
}
}
}
}
]
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupAllMemberResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupAllMemberResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/get_group_members_info": {
2 years ago
"post": {
2 years ago
"description": "获取群成员信息",
2 years ago
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
2 years ago
"群组相关"
2 years ago
],
2 years ago
"summary": "获取群成员信息",
"operationId": "GetGroupMembersInfo",
2 years ago
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
2 years ago
"description": "memberList为要获取群成员的群ID列表",
2 years ago
"name": "req",
"in": "body",
"required": true,
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupMembersInfoReq"
2 years ago
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
2 years ago
"allOf": [
{
"$ref": "#/definitions/base_info.GetGroupMembersInfoResp"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/server_api_params.GroupMemberFullInfo"
}
}
}
}
]
2 years ago
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupMembersInfoResp"
2 years ago
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
2 years ago
"$ref": "#/definitions/base_info.GetGroupMembersInfoResp"
2 years ago
}
}
}
}
},
2 years ago
"/group/get_groups_info": {
"post": {
"description": "通过群ID列表获取群信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "通过群ID列表获取群信息",
"operationId": "GetGroupsInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupIDList为群ID列表",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetGroupInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetGroupInfoResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetGroupInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetGroupInfoResp"
}
}
}
}
},
"/group/get_joined_group_list": {
"post": {
"description": "获取用户加入群列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "获取用户加入群列表",
"operationId": "GetJoinedGroupList",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "fromUserID为要获取的用户ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetJoinedGroupListReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"allOf": [
{
"$ref": "#/definitions/base_info.GetJoinedGroupListResp"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/server_api_params.GroupInfo"
}
}
}
}
]
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetJoinedGroupListResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetJoinedGroupListResp"
}
}
}
}
},
"/group/get_recv_group_applicationList": {
"post": {
"description": "获取用户收到的加群信息列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "获取用户收到的加群信息列表",
"operationId": "GetRecvGroupApplicationList",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "fromUserID为要获取的用户ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
}
}
}
},
"/group/get_user_req_group_applicationList": {
"post": {
"description": "获取用户加群申请列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "获取用户加群申请列表",
"operationId": "GetUserReqGroupApplicationList",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "userID为要获取的用户ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUserReqGroupApplicationListReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetGroupApplicationListResp"
}
}
}
}
},
"/group/group_application_response": {
"post": {
"description": "处理加群消息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "处理加群消息",
"operationId": "ApplicationGroupResponse",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupID为要处理的群ID \u003cbr\u003e fromUserID为要处理的用户ID \u003cbr\u003e handleMsg为处理结果信息 \u003cbr\u003e handleResult为处理结果 1为同意加群 2为拒绝加群",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.ApplicationGroupResponseReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.ApplicationGroupResponseResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.ApplicationGroupResponseResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.ApplicationGroupResponseResp"
}
}
}
}
},
"/group/invite_user_to_group": {
"post": {
"description": "将用户拉入群组",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "将用户拉入群组",
"operationId": "InviteUserToGroup",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupID为要拉进的群组ID \u003cbr\u003e invitedUserIDList为要获取群成员的群ID列表 \u003cbr\u003e reason为原因",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.InviteUserToGroupReq"
}
}
],
"responses": {
"0": {
"description": "result为结果码, -1为失败, 0为成功",
"schema": {
"$ref": "#/definitions/base_info.InviteUserToGroupResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.InviteUserToGroupResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.InviteUserToGroupResp"
}
}
}
}
},
"/group/join_group": {
"post": {
"description": "加入群聊",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "加入群聊",
"operationId": "JoinGroup",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "reqMessage为申请进群信息",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.JoinGroupReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.JoinGroupResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.JoinGroupResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.JoinGroupResp"
}
}
}
}
},
"/group/kick_group": {
"post": {
"description": "把用户踢出群组",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "把用户踢出群组",
"operationId": "KickGroupMember",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "GroupID为要操作的群ID \u003cbr\u003e kickedUserIDList为要踢出的群用户ID \u003cbr\u003e reason为原因",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.KickGroupMemberReq"
}
}
],
"responses": {
"0": {
"description": "result为结果码, -1为失败, 0为成功",
"schema": {
"$ref": "#/definitions/base_info.KickGroupMemberResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.KickGroupMemberResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.KickGroupMemberResp"
}
}
}
}
},
"/group/mute_group": {
"post": {
"description": "禁言群组",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "禁言群组",
"operationId": "MuteGroup",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupID为群组ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.MuteGroupReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.MuteGroupResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.MuteGroupResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.MuteGroupResp"
}
}
}
}
},
"/group/mute_group_member": {
"post": {
"description": "禁言群成员",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "禁言群成员",
"operationId": "MuteGroupMember",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupID为群组ID \u003cbr\u003e userID为要禁言的用户ID \u003cbr\u003e mutedSeconds为禁言秒数",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.MuteGroupMemberReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.DismissGroupResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.DismissGroupResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.DismissGroupResp"
}
}
}
}
},
"/group/quit_group": {
"post": {
"description": "退出群聊",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "退出群聊",
"operationId": "QuitGroup",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "groupID为要退出的群ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.QuitGroupReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.QuitGroupResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.QuitGroupResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.QuitGroupResp"
}
}
}
}
},
"/group/set_group_info": {
"post": {
"description": "设置群信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "设置群信息",
"operationId": "SetGroupInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "notification为群介绍 \u003cbr\u003e introduction为群公告 \u003cbr\u003e needVerification为加群验证 0为申请需要同意 邀请直接进 1为所有人进群需要验证除了群主管理员邀请进群 2为直接进群",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.SetGroupInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.SetGroupInfoResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.SetGroupInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.SetGroupInfoResp"
}
}
}
}
},
"/group/set_group_member_info": {
"post": {
"description": "修改群成员信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "修改群成员信息",
"operationId": "SetGroupMemberInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "除了operationID, userID, groupID其他参数可选",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.SetGroupMemberInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.SetGroupMemberInfoResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.SetGroupMemberInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.SetGroupMemberInfoResp"
}
}
}
}
},
"/group/transfer_group": {
"post": {
"description": "转让群主",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"群组相关"
],
"summary": "转让群主",
"operationId": "TransferGroupOwner",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "GroupID为要操作的群ID \u003cbr\u003e oldOwnerUserID为老群主ID \u003cbr\u003e newOwnerUserID为新群主ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.TransferGroupOwnerReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.TransferGroupOwnerResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.TransferGroupOwnerResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.TransferGroupOwnerResp"
}
}
}
}
},
"/msg/clear_msg": {
"post": {
"description": "清空用户消息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息相关"
],
"summary": "清空用户消息",
"operationId": "ClearMsg",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "userID为要清空的用户ID",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.CleanUpMsgReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.CleanUpMsgResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.CleanUpMsgResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.CleanUpMsgResp"
}
}
}
}
},
"/msg/del_msg": {
"post": {
"description": "根据seq列表删除消息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"消息相关"
],
"summary": "根据seq列表删除消息",
"operationId": "DelMsg",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "userID为要删除的用户ID \u003cbr\u003e seqList为seq列表",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.DelMsgReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.DelMsgResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.DelMsgResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.DelMsgResp"
}
}
}
}
},
"/office/comment_one_work_moment": {
"post": {
"description": "评论一条工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "评论一条工作圈",
"operationId": "CommentOneWorkMoment",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.CommentOneWorkMomentReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.CommentOneWorkMomentResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.CommentOneWorkMomentResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.CommentOneWorkMomentResp"
}
}
}
}
},
"/office/create_one_work_moment": {
"post": {
"description": "用户创建一条工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "创建一条工作圈",
"operationId": "CreateOneWorkMoment",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求 atUserList likeUserList permissionGroupList permissionUserList 字段中userName可以不填",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.CreateOneWorkMomentReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.CreateOneWorkMomentResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.CreateOneWorkMomentResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.CreateOneWorkMomentResp"
}
}
}
}
},
"/office/create_tag": {
"post": {
"description": "创建标签",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "创建标签",
"operationId": "CreateTag",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.CreateTagReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.CreateTagResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.CreateTagResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.CreateTagResp"
}
}
}
}
},
"/office/delete_comment": {
"post": {
"description": "删除一条评论",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "删除一条评论",
"operationId": "DeleteComment",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.DeleteCommentReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.DeleteCommentResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.DeleteCommentResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.DeleteCommentResp"
}
}
}
}
},
"/office/delete_one_work_moment": {
"post": {
"description": "根据用户工作圈ID删除一条工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "删除一条工作圈",
"operationId": "DeleteOneWorkMoment",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.DeleteOneWorkMomentReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.DeleteOneWorkMomentResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.DeleteOneWorkMomentResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.DeleteOneWorkMomentResp"
}
}
}
}
},
"/office/delete_tag": {
"post": {
"description": "根据标签ID创建标签",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "删除标签",
"operationId": "DeleteTag",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.DeleteTagReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.DeleteTagResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.DeleteTagResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.DeleteTagResp"
}
}
}
}
},
"/office/get_send_tag_log": {
"post": {
"description": "分页获取发送历史记录",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "获取发送历史记录",
"operationId": "GetTagSendLogs",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetTagSendLogsReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetTagSendLogsResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetTagSendLogsResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetTagSendLogsResp"
}
}
}
}
},
"/office/get_user_friend_work_moments": {
"post": {
"description": "查询用户工作圈页面",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "查询自己大工作圈页面",
"operationId": "GetUserFriendWorkMoments",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUserFriendWorkMomentsResp"
}
}
}
}
},
"/office/get_user_tag_by_id": {
"post": {
"description": "通过标签id获取该用户的标签信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "获取该用户的标签信息",
"operationId": "GetUserTagByID",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUserTagByIDReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagByIDResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagByIDResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagByIDResp"
}
}
}
}
},
"/office/get_user_tags": {
"post": {
"description": "用户获取自己的所有的标签",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "获取用户标签信息",
"operationId": "GetUserTags",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUserTagsReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagsResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagsResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUserTagsResp"
}
}
}
}
},
"/office/get_user_work_moments": {
"post": {
"description": "查询用户工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "查询用户工作圈",
"operationId": "GetUserWorkMoments",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUserWorkMomentsReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUserWorkMomentsResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUserWorkMomentsResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUserWorkMomentsResp"
}
}
}
}
},
"/office/get_work_moment_by_id": {
"post": {
"description": "通过ID获取工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "通过ID获取工作圈",
"operationId": "GetWorkMomentByID",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetWorkMomentByIDReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetWorkMomentByIDResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetWorkMomentByIDResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetWorkMomentByIDResp"
}
}
}
}
},
"/office/like_one_work_moment": {
"post": {
"description": "工作圈ID点赞一条工作圈",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"工作圈"
],
"summary": "点赞一条工作圈",
"operationId": "LikeOneWorkMoment",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.LikeOneWorkMomentReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.LikeOneWorkMomentResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.LikeOneWorkMomentResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.LikeOneWorkMomentResp"
}
}
}
}
},
"/office/send_msg_to_tag": {
"post": {
"description": "对标签用户发送消息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "发送标签消息",
"operationId": "SendMsg2Tag",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.SendMsg2TagReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.SendMsg2TagResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.SendMsg2TagResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.SendMsg2TagResp"
}
}
}
}
},
"/office/set_tag": {
"post": {
"description": "根据标签ID修改标签用户列表, 名称",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"标签"
],
"summary": "修改标签",
"operationId": "SetTag",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.SetTagReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.SetTagResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.SetTagResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.SetTagResp"
}
}
}
}
},
"/third/minio_upload": {
"post": {
"description": "minio上传文件(web api), 请注意本api请求为form并非json",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"第三方服务相关"
],
"summary": "minio上传文件(web api)",
"operationId": "MinioUploadFile",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"type": "file",
"description": "要上传的文件文件",
"name": "file",
"in": "formData",
"required": true
},
{
"type": "integer",
"description": "文件类型",
"name": "fileType",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "操作唯一ID",
"name": "operationID",
"in": "formData",
"required": true
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.MinioUploadFileResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.MinioUploadFileResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.MinioUploadFileResp"
}
}
}
}
},
"/user/account_check": {
"post": {
"description": "传入UserIDList检查列表账户注册状态并且返回结果",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "检查列表账户注册状态,并且返回结果",
"operationId": "AccountCheck",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.AccountCheckReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.AccountCheckResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.AccountCheckResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.AccountCheckResp"
}
}
}
}
},
"/user/get_all_users_uid": {
"post": {
"description": "获取所有用户uid列表",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "获取所有用户uid列表",
"operationId": "GetAllUsersUid",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetAllUsersUidReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetAllUsersUidResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetAllUsersUidResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetAllUsersUidResp"
}
}
}
}
},
"/user/get_self_user_info": {
"post": {
"description": "传入ID获取自己的信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "获取自己的信息",
"operationId": "GetSelfUserInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetSelfUserInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"allOf": [
{
"$ref": "#/definitions/base_info.GetSelfUserInfoResp"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/server_api_params.UserInfo"
}
}
}
]
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetSelfUserInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetSelfUserInfoResp"
}
}
}
}
},
"/user/get_users_info": {
"post": {
"description": "根据用户列表批量获取用户信息",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "获取用户信息",
"operationId": "GetUsersInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUsersInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUsersInfoResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUsersInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUsersInfoResp"
}
}
}
}
},
"/user/get_users_online_status": {
"post": {
"description": "获取用户在线状态",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "获取用户在线状态",
"operationId": "GetUsersOnlineStatus",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.GetUsersOnlineStatusReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.GetUsersOnlineStatusResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.GetUsersOnlineStatusResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.GetUsersOnlineStatusResp"
}
}
}
}
},
"/user/set_global_msg_recv_opt": {
"post": {
"description": "设置全局免打扰",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "设置全局免打扰",
"operationId": "SetGlobalRecvMessageOpt",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.SetGlobalRecvMessageOptResp"
}
}
}
}
},
"/user/update_user_info": {
"post": {
"description": "修改用户信息 userID faceURL等",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"用户相关"
],
"summary": "修改用户信息",
"operationId": "UpdateUserInfo",
"parameters": [
{
"type": "string",
"description": "im token",
"name": "token",
"in": "header",
"required": true
},
{
"description": "请求体",
"name": "req",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/base_info.UpdateSelfUserInfoReq"
}
}
],
"responses": {
"0": {
"description": "",
"schema": {
"$ref": "#/definitions/base_info.UpdateUserInfoResp"
}
},
"400": {
"description": "errCode为400 一般为参数输入错误, token未带上等",
"schema": {
"$ref": "#/definitions/base_info.UpdateUserInfoResp"
}
},
"500": {
"description": "errCode为500 一般为服务器内部错误",
"schema": {
"$ref": "#/definitions/base_info.UpdateUserInfoResp"
}
}
}
}
}
},
"definitions": {
"base_info.AccountCheckReq": {
"type": "object",
"required": [
"checkUserIDList",
"operationID"
],
"properties": {
"checkUserIDList": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string"
}
},
"operationID": {
"type": "string"
}
}
},
"base_info.AccountCheckResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/user.AccountCheckResp_SingleUserStatus"
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.AddBlacklistReq": {
"type": "object",
"required": [
"fromUserID",
"operationID",
"toUserID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
},
"toUserID": {
"type": "string"
}
}
},
"base_info.AddBlacklistResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.AddFriendReq": {
"type": "object",
"required": [
"fromUserID",
"operationID",
"toUserID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
},
"reqMsg": {
"type": "string"
},
"toUserID": {
"type": "string"
}
}
},
"base_info.AddFriendResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.AddFriendResponseReq": {
"type": "object",
"required": [
"flag",
"fromUserID",
"operationID",
"toUserID"
],
"properties": {
"flag": {
"type": "integer",
"enum": [
-1,
0,
1
]
},
"fromUserID": {
"type": "string"
},
"handleMsg": {
"type": "string"
},
"operationID": {
"type": "string"
},
"toUserID": {
"type": "string"
}
}
},
"base_info.AddFriendResponseResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.ApplicationGroupResponseReq": {
"type": "object",
"required": [
"fromUserID",
"groupID",
"handleResult",
"operationID"
],
"properties": {
"fromUserID": {
"description": "application from FromUserID",
"type": "string"
},
"groupID": {
"type": "string"
},
"handleResult": {
"type": "integer",
"enum": [
-1,
1
]
},
"handledMsg": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.ApplicationGroupResponseResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CancelMuteGroupMemberReq": {
"type": "object",
"required": [
"groupID",
"operationID",
"userID"
],
"properties": {
"groupID": {
"type": "string"
},
"operationID": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.CancelMuteGroupMemberResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CancelMuteGroupReq": {
"type": "object",
"required": [
"groupID",
"operationID"
],
"properties": {
"groupID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.CancelMuteGroupResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CleanUpMsgReq": {
"type": "object",
"required": [
"operationID",
"userID"
],
"properties": {
"operationID": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.CleanUpMsgResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.Comment": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"contentID": {
"type": "string"
},
"createTime": {
"type": "integer"
},
"replyUserID": {
"type": "string"
},
"replyUserName": {
"type": "string"
},
"userID": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"base_info.CommentOneWorkMomentReq": {
"type": "object",
"required": [
"content",
"operationID",
"workMomentID"
],
"properties": {
"content": {
"type": "string"
},
"operationID": {
"type": "string"
},
"replyUserID": {
"type": "string"
},
"workMomentID": {
"type": "string"
}
}
},
"base_info.CommentOneWorkMomentResp": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CreateGroupReq": {
"type": "object",
"required": [
"operationID"
],
"properties": {
"ex": {
"type": "string"
},
"faceURL": {
"type": "string"
},
"groupID": {
"type": "string"
},
"groupName": {
"type": "string"
},
"groupType": {
"type": "integer"
},
"introduction": {
"type": "string"
},
"memberList": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.GroupAddMemberInfo"
}
},
"notification": {
"type": "string"
},
"operationID": {
"type": "string"
},
"ownerUserID": {
"type": "string"
}
}
},
"base_info.CreateGroupResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CreateOneWorkMomentReq": {
"type": "object",
"properties": {
"operationID": {
"type": "string"
},
"workMoment": {
"$ref": "#/definitions/office.WorkMoment"
}
}
},
"base_info.CreateOneWorkMomentResp": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.CreateTagReq": {
"type": "object",
"required": [
"operationID",
"tagName",
"userIDList"
],
"properties": {
"operationID": {
"type": "string"
},
"tagName": {
"description": "tag名称",
"type": "string"
},
"userIDList": {
"description": "用户ID列表",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"base_info.CreateTagResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DelMsgReq": {
"type": "object",
"required": [
"operationID",
"seqList",
"userID"
],
"properties": {
"operationID": {
"type": "string"
},
"seqList": {
"type": "array",
"items": {
"type": "integer"
}
},
"userID": {
"type": "string"
}
}
},
"base_info.DelMsgResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DeleteCommentReq": {
"type": "object",
"required": [
"contentID",
"operationID",
"workMomentID"
],
"properties": {
"contentID": {
"type": "string"
},
"operationID": {
"type": "string"
},
"workMomentID": {
"type": "string"
}
}
},
"base_info.DeleteCommentResp": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DeleteFriendReq": {
"type": "object",
"required": [
"fromUserID",
"operationID",
"toUserID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
},
"toUserID": {
"type": "string"
}
}
},
"base_info.DeleteFriendResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DeleteOneWorkMomentReq": {
"type": "object",
"required": [
"operationID",
"workMomentID"
],
"properties": {
"operationID": {
"type": "string"
},
"workMomentID": {
"type": "string"
}
}
},
"base_info.DeleteOneWorkMomentResp": {
"type": "object",
"properties": {
"data": {
"type": "object"
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DeleteTagReq": {
"type": "object",
"required": [
"operationID",
"tagID"
],
"properties": {
"operationID": {
"type": "string"
},
"tagID": {
"type": "string"
}
}
},
"base_info.DeleteTagResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.DismissGroupReq": {
"type": "object",
"required": [
"groupID",
"operationID"
],
"properties": {
"groupID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.DismissGroupResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.ForceLogoutReq": {
"type": "object",
"required": [
"fromUserID",
"operationID",
"platform"
],
"properties": {
"fromUserID": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"operationID": {
"type": "string"
},
"platform": {
"type": "integer",
"maximum": 8,
"minimum": 1
}
}
},
"base_info.ForceLogoutResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetAllUsersUidReq": {
"type": "object",
"required": [
"operationID"
],
"properties": {
"operationID": {
"type": "string"
}
}
},
"base_info.GetAllUsersUidResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetBlackListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetBlackListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetFriendApplyListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetFriendApplyListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetFriendListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetFriendListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetGroupAllMemberReq": {
"type": "object",
"required": [
"groupID",
"operationID"
],
"properties": {
"groupID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetGroupAllMemberResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetGroupApplicationListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"description": "作为管理员或群主收到的 进群申请",
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetGroupApplicationListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetGroupInfoReq": {
"type": "object",
"required": [
"groupIDList",
"operationID"
],
"properties": {
"groupIDList": {
"type": "array",
"items": {
"type": "string"
}
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetGroupInfoResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetGroupMembersInfoReq": {
"type": "object",
"required": [
"groupID",
"memberList",
"operationID"
],
"properties": {
"groupID": {
"type": "string"
},
"memberList": {
"type": "array",
"items": {
"type": "string"
}
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetGroupMembersInfoResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetJoinedGroupListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetJoinedGroupListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetSelfApplyListReq": {
"type": "object",
"required": [
"fromUserID",
"operationID"
],
"properties": {
"fromUserID": {
"type": "string"
},
"operationID": {
"type": "string"
}
}
},
"base_info.GetSelfApplyListResp": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetSelfUserInfoReq": {
"type": "object",
"required": [
"operationID",
"userID"
],
"properties": {
"operationID": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.GetSelfUserInfoResp": {
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetTagSendLogsReq": {
"type": "object",
"required": [
"operationID",
"pageNumber",
"showNumber"
],
"properties": {
"operationID": {
"type": "string"
},
"pageNumber": {
"type": "integer"
},
"showNumber": {
"type": "integer"
}
}
},
"base_info.GetTagSendLogsResp": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"currentPage": {
"type": "integer"
},
"logs": {
"type": "array",
"items": {
"$ref": "#/definitions/office.TagSendLog"
}
},
"showNumber": {
"type": "integer"
}
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetUserFriendWorkMomentsReq": {
"type": "object",
"required": [
"operationID",
"pageNumber",
"showNumber"
],
"properties": {
"operationID": {
"type": "string"
},
"pageNumber": {
"type": "integer"
},
"showNumber": {
"type": "integer"
}
}
},
"base_info.GetUserFriendWorkMomentsResp": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"currentPage": {
"type": "integer"
},
"showNumber": {
"type": "integer"
},
"workMoments": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.WorkMoment"
}
}
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetUserReqGroupApplicationListReq": {
"type": "object",
"required": [
"operationID",
"userID"
],
"properties": {
"operationID": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.GetUserTagByIDReq": {
"type": "object",
"required": [
"operationID",
"tagID"
],
"properties": {
"operationID": {
"type": "string"
},
"tagID": {
"type": "string"
}
}
},
"base_info.GetUserTagByIDResp": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"tag": {
"$ref": "#/definitions/office.Tag"
}
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.GetUserTagsReq": {
"type": "object",
"required": [
"operationID"
],
"properties": {
"operationID": {
"type": "string"
}
}
},
"base_info.GetUserTagsResp": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/office.Tag"
}
}
}
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
2 years ago
}
}
},
2 years ago
"base_info.GetUserWorkMomentsReq": {
2 years ago
"type": "object",
2 years ago
"required": [
"operationID",
"pageNumber",
"showNumber"
],
2 years ago
"properties": {
2 years ago
"operationID": {
2 years ago
"type": "string"
},
2 years ago
"pageNumber": {
2 years ago
"type": "integer"
},
2 years ago
"showNumber": {
"type": "integer"
2 years ago
},
"userID": {
"type": "string"
2 years ago
}
}
},
"base_info.GetUserWorkMomentsResp": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"currentPage": {
"type": "integer"
},
"showNumber": {
"type": "integer"
},
"workMoments": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.WorkMoment"
}
}
}
2 years ago
},
2 years ago
"errCode": {
"type": "integer"
},
"errMsg": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.GetUsersInfoReq": {
2 years ago
"type": "object",
"required": [
"operationID",
2 years ago
"userIDList"
2 years ago
],
"properties": {
"operationID": {
"type": "string"
},
2 years ago
"userIDList": {
"type": "array",
"items": {
"type": "string"
}
2 years ago
}
}
},
2 years ago
"base_info.GetUsersInfoResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.GetUsersOnlineStatusReq": {
2 years ago
"type": "object",
2 years ago
"required": [
"operationID",
"userIDList"
],
2 years ago
"properties": {
"operationID": {
"type": "string"
},
2 years ago
"userIDList": {
"type": "array",
"maxItems": 200,
"items": {
"type": "string"
}
2 years ago
}
}
},
2 years ago
"base_info.GetUsersOnlineStatusResp": {
2 years ago
"type": "object",
"properties": {
"data": {
2 years ago
"type": "array",
"items": {
"$ref": "#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessResult"
}
2 years ago
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.GetWorkMomentByIDReq": {
2 years ago
"type": "object",
"required": [
"operationID",
2 years ago
"workMomentID"
2 years ago
],
"properties": {
"operationID": {
"type": "string"
},
2 years ago
"workMomentID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.GetWorkMomentByIDResp": {
2 years ago
"type": "object",
"properties": {
2 years ago
"data": {
"type": "object",
"properties": {
"workMoment": {
"$ref": "#/definitions/base_info.WorkMoment"
}
}
},
2 years ago
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.GroupAddMemberInfo": {
2 years ago
"type": "object",
"required": [
2 years ago
"roleLevel",
"userID"
2 years ago
],
"properties": {
2 years ago
"roleLevel": {
"type": "integer"
},
"userID": {
2 years ago
"type": "string"
2 years ago
}
}
},
"base_info.ImportFriendReq": {
"type": "object",
"required": [
"friendUserIDList",
"fromUserID",
"operationID"
],
"properties": {
"friendUserIDList": {
"type": "array",
"items": {
"type": "string"
}
2 years ago
},
2 years ago
"fromUserID": {
2 years ago
"type": "string"
},
2 years ago
"operationID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.ImportFriendResp": {
2 years ago
"type": "object",
"properties": {
"data": {
2 years ago
"type": "array",
"items": {
"$ref": "#/definitions/base_info.UserIDResult"
}
2 years ago
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.InviteUserToGroupReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
"invitedUserIDList",
"operationID"
2 years ago
],
"properties": {
2 years ago
"groupID": {
"type": "string"
},
"invitedUserIDList": {
"type": "array",
"items": {
"type": "string"
}
},
2 years ago
"operationID": {
"type": "string"
},
2 years ago
"reason": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.InviteUserToGroupResp": {
2 years ago
"type": "object",
"properties": {
"data": {
2 years ago
"type": "array",
"items": {
"$ref": "#/definitions/base_info.UserIDResult"
}
2 years ago
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.IsFriendReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"fromUserID",
2 years ago
"operationID",
2 years ago
"toUserID"
2 years ago
],
"properties": {
2 years ago
"fromUserID": {
"type": "string"
},
2 years ago
"operationID": {
"type": "string"
},
2 years ago
"toUserID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.IsFriendResp": {
2 years ago
"type": "object",
"properties": {
2 years ago
"data": {
"$ref": "#/definitions/base_info.Response"
},
2 years ago
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.JoinGroupReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
2 years ago
"operationID"
],
"properties": {
2 years ago
"groupID": {
"type": "string"
},
2 years ago
"operationID": {
"type": "string"
2 years ago
},
"reqMessage": {
"type": "string"
2 years ago
}
}
},
2 years ago
"base_info.JoinGroupResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.KickGroupMemberReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
"kickedUserIDList",
"operationID"
2 years ago
],
"properties": {
2 years ago
"groupID": {
"type": "string"
},
"kickedUserIDList": {
"type": "array",
"items": {
"type": "string"
}
},
2 years ago
"operationID": {
"type": "string"
},
2 years ago
"reason": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.KickGroupMemberResp": {
2 years ago
"type": "object",
"properties": {
"data": {
2 years ago
"type": "array",
"items": {
"$ref": "#/definitions/base_info.UserIDResult"
}
2 years ago
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.LikeOneWorkMomentReq": {
2 years ago
"type": "object",
"required": [
"operationID",
2 years ago
"workMomentID"
2 years ago
],
"properties": {
"operationID": {
"type": "string"
},
2 years ago
"workMomentID": {
"type": "string"
2 years ago
}
}
},
2 years ago
"base_info.LikeOneWorkMomentResp": {
2 years ago
"type": "object",
"properties": {
"data": {
2 years ago
"type": "object"
2 years ago
},
"errCode": {
"type": "integer"
},
2 years ago
"errMsg": {
"type": "string"
}
}
},
"base_info.MinioUploadFileResp": {
"type": "object",
"properties": {
"URL": {
"type": "string"
},
"newName": {
"type": "string"
},
"snapshotName": {
"type": "string"
},
"snapshotURL": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.MuteGroupMemberReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
"mutedSeconds",
2 years ago
"operationID",
2 years ago
"userID"
2 years ago
],
"properties": {
2 years ago
"groupID": {
2 years ago
"type": "string"
},
2 years ago
"mutedSeconds": {
2 years ago
"type": "integer"
},
2 years ago
"operationID": {
"type": "string"
},
"userID": {
"type": "string"
2 years ago
}
}
},
2 years ago
"base_info.MuteGroupReq": {
2 years ago
"type": "object",
2 years ago
"required": [
"groupID",
"operationID"
],
2 years ago
"properties": {
2 years ago
"groupID": {
"type": "string"
2 years ago
},
2 years ago
"operationID": {
"type": "string"
}
}
},
"base_info.MuteGroupResp": {
"type": "object",
"properties": {
2 years ago
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.ParseTokenReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"operationID"
2 years ago
],
"properties": {
"operationID": {
"type": "string"
}
}
},
2 years ago
"base_info.ParseTokenResp": {
2 years ago
"type": "object",
"properties": {
"data": {
"type": "object",
2 years ago
"additionalProperties": true
2 years ago
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.QuitGroupReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
2 years ago
"operationID"
],
"properties": {
2 years ago
"groupID": {
"type": "string"
},
2 years ago
"operationID": {
"type": "string"
}
}
},
2 years ago
"base_info.QuitGroupResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.RemoveBlackListReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"fromUserID",
2 years ago
"operationID",
2 years ago
"toUserID"
2 years ago
],
"properties": {
2 years ago
"fromUserID": {
2 years ago
"type": "string"
},
2 years ago
"operationID": {
"type": "string"
2 years ago
},
2 years ago
"toUserID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.RemoveBlackListResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.Response": {
"type": "object",
"properties": {
"isFriend": {
"type": "boolean"
}
}
},
"base_info.SendMsg2TagReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"content",
2 years ago
"operationID",
2 years ago
"senderPlatformID"
2 years ago
],
"properties": {
2 years ago
"content": {
"type": "string"
},
"groupList": {
"type": "array",
"items": {
"type": "string"
}
},
2 years ago
"operationID": {
"type": "string"
},
2 years ago
"senderPlatformID": {
"type": "integer"
},
"tagList": {
"type": "array",
"items": {
"type": "string"
}
},
"userList": {
2 years ago
"type": "array",
"items": {
"type": "string"
}
}
}
},
2 years ago
"base_info.SendMsg2TagResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.SetFriendRemarkReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"fromUserID",
2 years ago
"operationID",
2 years ago
"remark",
"toUserID"
2 years ago
],
"properties": {
2 years ago
"fromUserID": {
"type": "string"
},
2 years ago
"operationID": {
"type": "string"
},
2 years ago
"remark": {
"type": "string"
},
"toUserID": {
"type": "string"
2 years ago
}
}
},
2 years ago
"base_info.SetFriendRemarkResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.SetGlobalRecvMessageOptReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"operationID"
2 years ago
],
"properties": {
2 years ago
"globalRecvMsgOpt": {
"type": "integer",
"enum": [
0,
1,
2
]
2 years ago
},
2 years ago
"operationID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.SetGlobalRecvMessageOptResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.SetGroupInfoReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
"operationID"
2 years ago
],
"properties": {
2 years ago
"ex": {
2 years ago
"type": "string"
},
2 years ago
"faceURL": {
"type": "string"
},
"groupID": {
"type": "string"
},
"groupName": {
"type": "string"
},
"introduction": {
"type": "string"
},
"needVerification": {
"type": "integer"
},
"notification": {
"type": "string"
},
"operationID": {
2 years ago
"type": "string"
}
}
},
2 years ago
"base_info.SetGroupInfoResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.SetGroupMemberInfoReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
2 years ago
"operationID",
2 years ago
"userID"
2 years ago
],
"properties": {
2 years ago
"ex": {
2 years ago
"type": "string"
},
2 years ago
"groupID": {
"type": "string"
},
"nickname": {
"type": "string"
2 years ago
},
"operationID": {
"type": "string"
},
2 years ago
"roleLevel": {
"type": "integer",
"maximum": 3,
"minimum": 1
},
"userGroupFaceUrl": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.SetGroupMemberInfoResp": {
"type": "object",
"properties": {
"errCode": {
2 years ago
"type": "integer"
},
2 years ago
"errMsg": {
"type": "string"
}
}
},
"base_info.SetTagReq": {
"type": "object",
"required": [
"operationID",
"tagID"
],
"properties": {
"increaseUserIDList": {
2 years ago
"type": "array",
"items": {
"type": "string"
}
},
2 years ago
"newName": {
"type": "string"
},
"operationID": {
"type": "string"
},
"reduceUserIDList": {
2 years ago
"type": "array",
"items": {
"type": "string"
2 years ago
}
2 years ago
},
"tagID": {
"type": "string"
2 years ago
}
}
2 years ago
},
2 years ago
"base_info.SetTagResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.TransferGroupOwnerReq": {
2 years ago
"type": "object",
"required": [
2 years ago
"groupID",
"newOwnerUserID",
"oldOwnerUserID",
2 years ago
"operationID"
],
"properties": {
2 years ago
"groupID": {
"type": "string"
},
"newOwnerUserID": {
"type": "string"
},
"oldOwnerUserID": {
"type": "string"
2 years ago
},
"operationID": {
"type": "string"
}
}
},
2 years ago
"base_info.TransferGroupOwnerResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.UpdateSelfUserInfoReq": {
2 years ago
"type": "object",
"required": [
"operationID",
2 years ago
"userID"
2 years ago
],
"properties": {
2 years ago
"birth": {
"type": "integer"
2 years ago
},
2 years ago
"email": {
"type": "string",
"maxLength": 64
},
"ex": {
"type": "string",
"maxLength": 1024
},
"faceURL": {
"type": "string",
"maxLength": 1024
},
"gender": {
"type": "integer",
"enum": [
0,
1,
2
]
},
"nickname": {
"type": "string",
"maxLength": 64,
"minLength": 1
2 years ago
},
"operationID": {
"type": "string"
},
2 years ago
"phoneNumber": {
"type": "string",
"maxLength": 32
2 years ago
},
2 years ago
"userID": {
"type": "string",
"maxLength": 64,
"minLength": 1
2 years ago
}
}
},
2 years ago
"base_info.UpdateUserInfoResp": {
2 years ago
"type": "object",
"properties": {
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
2 years ago
"base_info.UserIDResult": {
"type": "object",
"properties": {
"result": {
"type": "integer"
},
"userID": {
"type": "string"
}
}
},
"base_info.UserRegisterReq": {
2 years ago
"type": "object",
"required": [
"operationID",
2 years ago
"platform",
"secret",
2 years ago
"userID"
],
"properties": {
"birth": {
"type": "integer"
},
"email": {
"type": "string",
"maxLength": 64
},
"ex": {
"type": "string",
"maxLength": 1024
},
"faceURL": {
"type": "string",
"maxLength": 1024
},
"gender": {
"type": "integer",
"enum": [
0,
1,
2
]
},
"nickname": {
"type": "string",
"maxLength": 64,
"minLength": 1
},
"operationID": {
"type": "string"
},
"phoneNumber": {
"type": "string",
"maxLength": 32
},
2 years ago
"platform": {
"type": "integer",
"maximum": 7,
"minimum": 1
},
"secret": {
"type": "string",
"maxLength": 32
},
2 years ago
"userID": {
"type": "string",
"maxLength": 64,
"minLength": 1
}
}
},
2 years ago
"base_info.UserRegisterResp": {
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/base_info.UserTokenInfo"
},
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
},
"base_info.UserTokenInfo": {
"type": "object",
"properties": {
"expiredTime": {
"type": "integer"
},
"token": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
"base_info.UserTokenReq": {
"type": "object",
"required": [
"operationID",
"platform",
"secret",
"userID"
],
"properties": {
"operationID": {
"type": "string"
},
"platform": {
"type": "integer",
"maximum": 8,
"minimum": 1
},
"secret": {
"type": "string",
"maxLength": 32
},
"userID": {
"type": "string",
"maxLength": 64,
"minLength": 1
}
}
},
"base_info.UserTokenResp": {
2 years ago
"type": "object",
"properties": {
2 years ago
"data": {
"$ref": "#/definitions/base_info.UserTokenInfo"
},
2 years ago
"errCode": {
"type": "integer"
},
"errMsg": {
"type": "string"
}
}
2 years ago
},
"base_info.WorkMoment": {
"type": "object",
"properties": {
"atUsers": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.WorkMomentUser"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.Comment"
}
},
"content": {
"type": "string"
},
"createTime": {
"type": "integer"
},
"faceURL": {
"type": "string"
},
"likeUsers": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.WorkMomentUser"
}
},
"permission": {
"type": "integer"
},
"permissionUsers": {
"type": "array",
"items": {
"$ref": "#/definitions/base_info.WorkMomentUser"
}
},
"userID": {
"type": "string"
},
"userName": {
"type": "string"
},
"workMomentID": {
"type": "string"
}
}
},
"base_info.WorkMomentUser": {
"type": "object",
"properties": {
"userID": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"office.Comment": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"contentID": {
"type": "string"
},
"createTime": {
"type": "integer"
},
"faceURL": {
"type": "string"
},
"replyUserID": {
"type": "string"
},
"replyUserName": {
"type": "string"
},
"userID": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"office.PermissionGroup": {
"type": "object",
"properties": {
"groupID": {
"type": "string"
},
"groupName": {
"type": "string"
}
}
},
"office.Tag": {
"type": "object",
"properties": {
"tagID": {
"type": "string"
},
"tagName": {
"type": "string"
},
"userList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.TagUser"
}
}
}
},
"office.TagSendLog": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"sendTime": {
"type": "integer"
},
"userList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.TagUser"
}
}
}
},
"office.TagUser": {
"type": "object",
"properties": {
"userID": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"office.WorkMoment": {
"type": "object",
"properties": {
"atUserList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.WorkMomentUser"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/definitions/office.Comment"
}
},
"content": {
"type": "string"
},
"createTime": {
"type": "integer"
},
"faceURL": {
"type": "string"
},
"likeUserList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.WorkMomentUser"
}
},
"permission": {
"type": "integer"
},
"permissionGroupList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.PermissionGroup"
}
},
"permissionUserList": {
"type": "array",
"items": {
"$ref": "#/definitions/office.WorkMomentUser"
}
},
"userID": {
"type": "string"
},
"userName": {
"type": "string"
},
"workMomentID": {
"type": "string"
}
}
},
"office.WorkMomentUser": {
"type": "object",
"properties": {
"userID": {
"type": "string"
},
"userName": {
"type": "string"
}
}
},
"pbRelay.GetUsersOnlineStatusResp_SuccessDetail": {
"type": "object",
"properties": {
"platform": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"pbRelay.GetUsersOnlineStatusResp_SuccessResult": {
"type": "object",
"properties": {
"detailPlatformStatus": {
"type": "array",
"items": {
"$ref": "#/definitions/pbRelay.GetUsersOnlineStatusResp_SuccessDetail"
}
},
"status": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
2 years ago
"server_api_params.GroupInfo": {
"type": "object",
"properties": {
"createTime": {
"type": "integer"
},
"creatorUserID": {
"type": "string"
},
"ex": {
"type": "string"
},
"faceURL": {
"type": "string"
},
"groupID": {
"type": "string"
},
"groupName": {
"type": "string"
},
"groupType": {
"type": "integer"
},
"introduction": {
"type": "string"
},
"memberCount": {
"type": "integer"
},
"needVerification": {
"$ref": "#/definitions/wrapperspb.Int32Value"
},
"notification": {
"type": "string"
},
"ownerUserID": {
"type": "string"
},
"status": {
"type": "integer"
}
}
},
"server_api_params.GroupMemberFullInfo": {
"type": "object",
"properties": {
"appMangerLevel": {
"type": "integer"
},
"ex": {
"type": "string"
},
"faceURL": {
"type": "string"
},
"groupID": {
"type": "string"
},
"joinSource": {
"type": "integer"
},
"joinTime": {
"type": "integer"
},
"muteEndTime": {
"type": "integer"
},
"nickname": {
"type": "string"
},
"operatorUserID": {
"type": "string"
},
"roleLevel": {
"type": "integer"
},
"userID": {
"type": "string"
}
}
},
"server_api_params.UserInfo": {
"type": "object",
"properties": {
"appMangerLevel": {
"type": "integer"
},
"birth": {
"type": "integer"
},
"createTime": {
"type": "integer"
},
"email": {
"type": "string"
},
"ex": {
"type": "string"
},
"faceURL": {
"type": "string"
},
"gender": {
"type": "integer"
},
"globalRecvMsgOpt": {
"type": "integer"
},
"nickname": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"userID": {
"type": "string"
}
}
},
2 years ago
"user.AccountCheckResp_SingleUserStatus": {
"type": "object",
"properties": {
"accountStatus": {
"type": "string"
},
"userID": {
"type": "string"
}
}
2 years ago
},
"wrapperspb.Int32Value": {
"type": "object",
"properties": {
"value": {
"description": "The int32 value.",
"type": "integer"
}
}
2 years ago
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
2 years ago
Version: "",
Host: "",
BasePath: "",
2 years ago
Schemes: []string{},
2 years ago
Title: "",
Description: "",
2 years ago
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}