# TSRPC API 接口文档

## 通用说明

- 所有请求方法均为 `POST`
- 所有请求均需加入以下 Header :
    - `Content-Type: application/json`

## 目录

- admin
    - [addBuMa](#/admin/addBuMa)
    - [addCode](#/admin/addCode)
    - [addMail](#/admin/addMail)
    - [cacheVer](#/admin/cacheVer)
    - [deleteCode](#/admin/deleteCode)
    - [deleteMail](#/admin/deleteMail)
    - [deleteQuFu](#/admin/deleteQuFu)
    - [deleteSetting](#/admin/deleteSetting)
    - [getCode](#/admin/getCode)
    - [getCodeMa](#/admin/getCodeMa)
    - [getMail](#/admin/getMail)
    - [getNeed](#/admin/getNeed)
    - [getQuFu](#/admin/getQuFu)
    - [getSetting](#/admin/getSetting)
    - [getVer](#/admin/getVer)
    - [huodongAdd](#/admin/huodongAdd)
    - [huodongDelete](#/admin/huodongDelete)
    - [huodongEdit](#/admin/huodongEdit)
    - [huodongFind](#/admin/huodongFind)
    - [updateMail](#/admin/updateMail)
    - [updateQuFu](#/admin/updateQuFu)
    - [updateSetting](#/admin/updateSetting)
    - [xaizai](#/admin/xaizai)
- eps
    - [获取属性信息](#/eps/EpsInfo)
- hc
    - [获取合成信息](#/hc/HcInfo)
    - [点击两个格子合成](#/hc/HcMerge)
- item
    - [获取道具信息](#/item/ItemInfo)
- mail
    - [MailInfo](#/mail/MailInfo)
- plat
    - [平台登录](#/plat/PlatLogin)
- player
    - [账号登录](#/player/PlayerLogin)
- task
    - [获取主线任务](#/task/TaskInfo)
    - [请求领取任务奖励](#/task/TaskRwd)
- user
    - [战斗测试](#/user/UserFight)
    - [角色登录](#/user/UserLogin)
    - [角色改名](#/user/UserSetName)

---

## admin

### addBuMa <a id="/admin/addBuMa"></a>

**路径**
- POST `/admin/addBuMa`

**请求**
```ts
interface ReqaddBuMa {
    id: string,
    addCount: number
}
```

**响应**
```ts
interface ResaddBuMa {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### addCode <a id="/admin/addCode"></a>

**路径**
- POST `/admin/addCode`

**请求**
```ts
interface ReqaddCode {
    param: any
}
```

**响应**
```ts
interface ResaddCode {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### addMail <a id="/admin/addMail"></a>

**路径**
- POST `/admin/addMail`

**请求**
```ts
interface ReqaddMail {
    params: any
}
```

**响应**
```ts
interface ResaddMail {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### cacheVer <a id="/admin/cacheVer"></a>

**路径**
- POST `/admin/cacheVer`

**请求**
```ts
interface ReqcacheVer {

}
```

**响应**
```ts
interface RescacheVer {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### deleteCode <a id="/admin/deleteCode"></a>

**路径**
- POST `/admin/deleteCode`

**请求**
```ts
interface ReqdeleteCode {
    id: string
}
```

**响应**
```ts
interface ResdeleteCode {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### deleteMail <a id="/admin/deleteMail"></a>

**路径**
- POST `/admin/deleteMail`

**请求**
```ts
interface ReqdeleteMail {
    id: string
}
```

**响应**
```ts
interface ResdeleteMail {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### deleteQuFu <a id="/admin/deleteQuFu"></a>

**路径**
- POST `/admin/deleteQuFu`

**请求**
```ts
interface ReqdeleteQuFu {
    sid: string
}
```

**响应**
```ts
interface ResdeleteQuFu {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### deleteSetting <a id="/admin/deleteSetting"></a>

**路径**
- POST `/admin/deleteSetting`

**请求**
```ts
interface ReqdeleteSetting {
    key: string
}
```

**响应**
```ts
interface ResdeleteSetting {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getCode <a id="/admin/getCode"></a>

**路径**
- POST `/admin/getCode`

**请求**
```ts
interface ReqgetCode {

}
```

**响应**
```ts
interface ResgetCode {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getCodeMa <a id="/admin/getCodeMa"></a>

**路径**
- POST `/admin/getCodeMa`

**请求**
```ts
interface ReqgetCodeMa {
    id: string
}
```

**响应**
```ts
interface ResgetCodeMa {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getMail <a id="/admin/getMail"></a>

**路径**
- POST `/admin/getMail`

**请求**
```ts
interface ReqgetMail {

}
```

**响应**
```ts
interface ResgetMail {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getNeed <a id="/admin/getNeed"></a>

**路径**
- POST `/admin/getNeed`

**请求**
```ts
interface ReqgetNeed {
    stime: number,
    timeInterval: number
}
```

**响应**
```ts
interface ResgetNeed {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getQuFu <a id="/admin/getQuFu"></a>

**路径**
- POST `/admin/getQuFu`

**请求**
```ts
interface ReqgetQuFu {

}
```

**响应**
```ts
interface ResgetQuFu {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getSetting <a id="/admin/getSetting"></a>

**路径**
- POST `/admin/getSetting`

**请求**
```ts
interface ReqgetSetting {

}
```

**响应**
```ts
interface ResgetSetting {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### getVer <a id="/admin/getVer"></a>

**路径**
- POST `/admin/getVer`

**请求**
```ts
interface ReqgetVer {

}
```

**响应**
```ts
interface ResgetVer {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### huodongAdd <a id="/admin/huodongAdd"></a>

**路径**
- POST `/admin/huodongAdd`

**请求**
```ts
interface ReqhuodongAdd {
    params: any
}
```

**响应**
```ts
interface ReshuodongAdd {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### huodongDelete <a id="/admin/huodongDelete"></a>

**路径**
- POST `/admin/huodongDelete`

**请求**
```ts
interface ReqhuodongDelete {
    id: string
}
```

**响应**
```ts
interface ReshuodongDelete {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### huodongEdit <a id="/admin/huodongEdit"></a>

**路径**
- POST `/admin/huodongEdit`

**请求**
```ts
interface ReqhuodongEdit {
    id: string,
    params: any
}
```

**响应**
```ts
interface ReshuodongEdit {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### huodongFind <a id="/admin/huodongFind"></a>

**路径**
- POST `/admin/huodongFind`

**请求**
```ts
interface ReqhuodongFind {
    key?: string,
    hdcid?: string
}
```

**响应**
```ts
interface ReshuodongFind {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### updateMail <a id="/admin/updateMail"></a>

**路径**
- POST `/admin/updateMail`

**请求**
```ts
interface RequpdateMail {
    id: string,
    params: any
}
```

**响应**
```ts
interface ResupdateMail {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### updateQuFu <a id="/admin/updateQuFu"></a>

**路径**
- POST `/admin/updateQuFu`

**请求**
```ts
interface RequpdateQuFu {
    sid: string,
    param: { [key: string]: any }
}
```

**响应**
```ts
interface ResupdateQuFu {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### updateSetting <a id="/admin/updateSetting"></a>

**路径**
- POST `/admin/updateSetting`

**请求**
```ts
interface RequpdateSetting {
    key: string,
    param: any
}
```

**响应**
```ts
interface ResupdateSetting {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

### xaizai <a id="/admin/xaizai"></a>

**路径**
- POST `/admin/xaizai`

**请求**
```ts
interface Reqxaizai {
    id: string
}
```

**响应**
```ts
interface Resxaizai {
    order10Back: any
}
```

**配置**
```ts
{
  "connet": "admin"
}
```

---

## eps

### 获取属性信息 <a id="/eps/EpsInfo"></a>

**路径**
- POST `/eps/EpsInfo`

**请求**
```ts
interface ReqEpsInfo {

}
```

**响应**
```ts
interface ResEpsInfo {
    [key: string]: number
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

## hc

### 获取合成信息 <a id="/hc/HcInfo"></a>

**路径**
- POST `/hc/HcInfo`

**请求**
```ts
interface ReqHcInfo {

}
```

**响应**
```ts
interface ResHcInfo {
    chapterId: number,
    tili: number,
    lastTime: number,
    list: {
        [key: string]: {
            type: 0 | 1 | 2 | 3 | 4,
            unlock: 0 | 1,
            correlationId: number
        }
    }
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

### 点击两个格子合成 <a id="/hc/HcMerge"></a>

**路径**
- POST `/hc/HcMerge`

**请求**
```ts
interface ReqHcMerge {
    gzid1: string,
    gzid2: string
}
```

**响应**
```ts
interface ResHcMerge {
    [key: string]: {
        type: 0 | 1 | 2 | 3 | 4,
        unlock: 0 | 1,
        correlationId: number
    }
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

## item

### 获取道具信息 <a id="/item/ItemInfo"></a>

**路径**
- POST `/item/ItemInfo`

**请求**
```ts
interface ReqItemInfo {

}
```

**响应**
```ts
interface ResItemInfo {
    [key: string]: number
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

## mail

### MailInfo <a id="/mail/MailInfo"></a>

**路径**
- POST `/mail/MailInfo`

**请求**
```ts
interface ReqMailInfo {

}
```

**响应**
```ts
interface ResMailInfo {
    [key: string]: {
        id: string,
        title: string,
        content: string,
        items: number[],
        fts: number,
        rts: number,
        ets: number,
        dts: number
    }
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

## plat

### 平台登录 <a id="/plat/PlatLogin"></a>

**路径**
- POST `/plat/PlatLogin`

**请求**
```ts
interface ReqPlatLogin {
    pid: string,
    param: string[]
}
```

**响应**
```ts
interface ResPlatLogin {
    openId: string,
    token: string
}
```

**配置**
```ts
{
  "connet": "http"
}
```

---

## player

### 账号登录 <a id="/player/PlayerLogin"></a>

**路径**
- POST `/player/PlayerLogin`

**请求**
```ts
interface ReqPlayerLogin {
    pid: string,
    openId: string,
    lang: string,
    plat: string,
    device: string,
    parms: string[]
}
```

**响应**
```ts
interface ResPlayerLogin {
    uid: string,
    sid: string,
    list: {
        [key: string]: {
            uuid: string,
            name: string,
            level: number,
            lastlogin: number
        }
    },
    token: string,
    qufuList: {
        [key: string]: {
            sid: string,
            name: string,
            sName: string,
            openAt: number,
            status: string,
            heid: string,
            suofu: string,
            skin: string
        }
    },
    wsUrl: string
}
```

**配置**
```ts
{
  "connet": "http"
}
```

---

## task

### 获取主线任务 <a id="/task/TaskInfo"></a>

**路径**
- POST `/task/TaskInfo`

**请求**
```ts
interface ReqTaskInfo {

}
```

**响应**
```ts
interface ResTaskInfo {
    id: number,
    cons: number
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

### 请求领取任务奖励 <a id="/task/TaskRwd"></a>

**路径**
- POST `/task/TaskRwd`

**请求**
```ts
interface ReqTaskRwd {

}
```

**响应**
```ts
interface ResTaskRwd {
    id: number,
    cons: number
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

## user

### 战斗测试 <a id="/user/UserFight"></a>

**路径**
- POST `/user/UserFight`

**请求**
```ts
interface ReqUserFight {

}
```

**响应**
```ts
interface ResUserFight {
    /** 战斗初始阵容 */
    fightStart: {
        from: string,
        seed: number,
        teams: {
            [key: string]: {
                fid: string,
                eps: { [key: string]: number }
            }
        }
    },
    win: number,
    log: {
        [key: string]: {
            /** 战斗动作类型 */
            aType: "wu" | "0" | "1" | "2" | "3" | "999",
            /** 日志格式 */
            atker: {
                iid: string,
                hp: number,
                buff: [string, number][],
                effect: [string, number][]
            },
            target: {
                iid: string,
                hp: number,
                buff: [string, number][],
                effect: [string, number][]
            }[]
        }[]
    }
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

### 角色登录 <a id="/user/UserLogin"></a>

**路径**
- POST `/user/UserLogin`

**请求**
```ts
interface ReqUserLogin {
    sid: string,
    uid: string,
    token: string
}
```

**响应**
```ts
interface ResUserLogin {
    uuid: string,
    sid: string,
    name: string,
    head: string,
    wxhead: string,
    sex: number,
    level: number,
    exp: number,
    regtime: number,
    loginTime: number,
    lastlogin: number,
    lang: string,
    iscz: number,
    rmbcz: number,
    power: number
}
```

**配置**
```ts
{
  "connet": "ws"
}
```

---

### 角色改名 <a id="/user/UserSetName"></a>

**路径**
- POST `/user/UserSetName`

**请求**
```ts
interface ReqUserSetName {
    name: string
}
```

**响应**
```ts
interface ResUserSetName {
    name: string
}
```

**配置**
```ts
{
  "connet": "ws"
}
```