# api_document

**Repository Path**: atiana/api_document

## Basic Information

- **Project Name**: api_document
- **Description**: 接口API
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-05-15
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Api_Document

#### 项目介绍
接口API

# 规格说明**

| /    | 说明                                
| ---- | ----------------------------------
| 版本   | v1.0                              
| 协议版本 | v1.0                              
| 调用方式 | HTTP RESTFUL [GET POST PUT DELETE]
| 返回格式 | 二进制加密数据                           
| 返回数据 | {data:{}, message:{}, error:{}}    |


## **返回状态码**
| status值 | 说明                                 
| ------- | -----------------------------------
| 200     | get请求成功                            
| 201     | post请求成功，并创建服务器资源                  
| 301     | 原url已废弃，跳转至资源所在处url（永久）            
| 302     | 重定向url，并发起get请求（暂时）                
| 303     | 允许post请求                           
| 304     | 请求成功，但不更新内容                        
| 400     | 请求错误，当header参数格式错误或body解析错误        
| 401     | 请求未授权                              
| 403     | 请求被拒绝                              
| 404     | 找不到资源                              
| 405     | 请求方式错误                             
| 408     | 请求超时                               
| 413     | 请求body实体太大                         
| 414     | 请求url太长                            
| 422     | 参数错误，返回error信息                     
| 500     | 服务器出错                              
| 502     | 无法链接服务器                            
| 503     | 服务器维护中，header会有服务器恢复时间Retry-After参数
| 504     | 网关超时                                |


## **接口**


### 1.用户登陆

请求地址：{api_host}/login

| Request     | Method : GET        |     
 

具体返回数据结构
```
| 参数名          | 类型     | 说明                                 
| -------------- | ------ | -----------------------------------
| id             | int    | 用户ID    
| token          | string | 用户token                         
| department     | string | 所属部门                               
| nickName       | string | 用户昵称                                                         
| icon           | string | 头像                                                                                        
| lastLoginTime  | string | 最后一次登陆时间


```


### 2.获取会话列表

请求地址：{api_host}/chatInfo

| Request     | Method : GET        |     
  

具体返回数据结构
```
| 参数名          | 类型     | 说明                                 
| -------------- | ------ | -----------------------------------
| id             | int    | 会话ID                               
| msgType        | int | 消息类型                               
| belongId       | string | 所属ID
| unreadMsgCount | int | 未读消息条数                               
| stickState     | boolean | 置顶状态                            
| icon           | string    | 头像                              
| targetId       | string | 目标ID                               
| content        | string    | 消息内容                              
| isError        | boolean | 是否发送错误                             
| messageId      | string | 消息ID                               
| opTime         | string | 最后一次操作时间

```






### 3.消息列表
请求地址：{api_host}/msgInfo

| Request     | Method : GET        |     


 具体返回数据结构
```
| 参数名          | 类型     | 说明                                 
| -------------- | ------ | -----------------------------------
| messageId      | int    | 消息ID                               
| nickName       | string | 昵称                               
| belongId       | string | 所属ID
| belongIcon     | string | 当前用户头像                               
| targetNickName | string | 目标昵称                            
| targetIcon     | string | 头像                              
| targetId       | string | 目标ID                                                           
| isError        | boolean| 是否发送错误                             
| messageId      | string | 消息ID                               
| type           | int | 消息类型：聊天类型：单聊，群聊
| chatType       | int | 聊天类型：好友聊，陌生人聊，临时聊,
| sendTime       | string | 发送时间
| subType        | int | 消息类型：文字,语音,表情,视频,小视频,文件,音视频,系统,新消息,...
| sendStatus     | boolean | 发送状态
| isRead         | boolean | 是否已读
| body           | object | 具体消息对象
| subType        | string | 发送时间

        
```



 4.消息类型说明
```
文本消息：0；
图片消息：1；
语音消息：2；
事件消息：3；


群聊：4；
单聊：5；



        
```