Skip to content

Latest commit

 

History

History
2297 lines (1772 loc) · 48 KB

接口文档.md

File metadata and controls

2297 lines (1772 loc) · 48 KB
title language_tabs toc_footers includes search code_clipboard highlight_theme headingLevel generator
通天代
shell
Shell
http
HTTP
javascript
JavaScript
ruby
Ruby
python
Python
php
PHP
java
Java
go
Go
true
true
darkula
2
@tarslib/widdershins v4.0.23

通天代

Base URLs:

Authentication

用户

POST 微信用户登录

POST /wx/login

小程序端调用wx.login()传给我code,我返回token等信息

Body 请求参数

{
  "code": "61"
}

请求参数

名称 位置 类型 必选 说明
body body object none
» code body string none

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 测试登录

POST /wx/login/temp

小程序端调用wx.login()传给我code,我返回token等信息

Body 请求参数

{
  "code": "61"
}

请求参数

名称 位置 类型 必选 说明
body body object none
» openid body string 随便传

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": {
    "msg": {
      "id": 0,
      "code": "string",
      "name": "string",
      "major": "string"
    },
    "userInfo": true,
    "wxMsg": {
      "id": "string",
      "username": "string",
      "avatar": "string"
    },
    "userId": 0,
    "isCertificate": true,
    "token": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data object true none none
»» msg object true none 学生信息
»»» id integer true none none
»»» code string true none none
»»» name string true none none
»»» major string true none none
»» userInfo boolean true none 是否有上传微信信息
»» wxMsg object true none 微信信息
»»» id string true none none
»»» username string true none none
»»» avatar string true none none
»» userId integer true none none
»» isCertificate boolean true none 是否学生认证
»» token string true none none

POST 添加收货信息

POST /user/msg

Body 请求参数

{
  "name": "住素间引国",
  "phoneEnd": "1520",
  "building": 25,
  "layer": 3,
  "addressDetail": "Ut id ex ipsum nisi"
}

请求参数

名称 位置 类型 必选 说明
token header string token
body body object none
» name body string 买家名
» phoneEnd body string 手机尾号
» building body integer 楼号
» layer body integer 楼层
» addressDetail body string 详细地址

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "success"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

GET 获得收货信息

GET /user/msg

请求参数

名称 位置 类型 必选 说明
token header string token

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "id": "1",
    "defaultIndex": 0,
    "msgList": [
      {
        "name": "进出南门量",
        "phoneEnd": "6233",
        "building": 11,
        "layer": 2,
        "addressDetail": "amet laboris"
      }
    ]
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» id string true none none
»» defaultIndex integer true none 默认收货信息index
»» msgList [object] true none 收获信息列表
»»» name string false none none
»»» phoneEnd string false none none
»»» building integer false none none
»»» layer integer false none none
»»» addressDetail string false none none

DELETE 删除收货信息

DELETE /user/msg

Body 请求参数

{
  "index": 0
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» index body integer 收货信息索引

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

POST 修改默认收货信息

POST /user/msg/default

Body 请求参数

{
  "index": 2
}

请求参数

名称 位置 类型 必选 说明
token header string token
body body object none
» index body integer 第几个收货信息

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 更新token时间

POST /token/renew

用户第一次进入小程序页面时,如果已存在token则进行更新时间

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "成功更新token时间"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

POST 修改收货信息

POST /user/msg/update

修改指定位置的收货信息

Body 请求参数

{
  "index": 2,
  "msg": {
    "name": "进出南门量",
    "phoneEnd": "6233",
    "building": 11,
    "layer": 2,
    "addressDetail": "amet laboris"
  }
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» index body integer 收货信息位于列表的位置
» msg body object 收货信息
»» name body string 买家名
»» phoneEnd body string 手机尾号
»» building body integer 楼号
»» layer body integer 楼层
»» addressDetail body string 详细地址

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

POST 学号姓名认证

POST /user/certificate

学生认证

Body 请求参数

{
  "code": "100000000",
  "name": "张三1",
  "major": "计算机类"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» code body string 学号
» name body string 姓名
» major body string 专业

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

GET 获得认证信息

GET /user/certificate

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": {
    "id": 0,
    "code": "string",
    "name": "string",
    "major": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» id integer true none none
»» code string true none none
»» name string true none none
»» major string true none none

POST 上传用户头像昵称

POST /user/wxMsg

Body 请求参数

{
  "name": "常书求门起",
  "avatar": "http://dummyimage.com/100x100"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» name body string 微信昵称
» avatar body string 头像url

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

GET 获得用户头像昵称

GET /user/wxMsg

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": {
    "id": "string",
    "username": "string",
    "avatar": "string"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» id string true none none
»» username string true none none
»» avatar string true none none

代快递

POST 修改代取快递任务json

POST /pt/publish/json

像取件码,手机尾号,姓名,送货详细地址,取件身份码这些信息,是有人接受这个代拿任务时再提供给接受放

Body 请求参数

{
  "id": "xxx",
  "type": "快递",
  "company": "韵达快递",
  "from": "邮政",
  "building": 31,
  "layer": 3,
  "size": "",
  "price": 48,
  "remark": "sunt pariatur",
  "incidentalMsg": {
    "name": "力内则系红组克",
    "address": "香港特别行政区柳州市万秀区",
    "code": "6--6-6-",
    "phone": "18128682251"
  }
}

请求参数

名称 位置 类型 必选 说明
token header string token
body body object none
» id body string 任务id
» type body string 快递类型
» company body string 快递公司
» from body string 快递代取点
» building body integer 楼号
» layer body integer 楼层
» elseTo body string 其他地址,发布者可选定宿舍楼或者其他地区,选了其他地区,楼层楼号不用填
» size body string 快递大小
» price body integer 价格
» remark body string 备注
» incidentalMsg body object 隐私信息
»» code body string 取件码(不需要可以不填)
»» phone body string 手机尾号(不需要可以不填)
»» name body string 姓名(不需要可以不填)
»» address body string 送货的详细地址
»» picture body string 取件身份码(不需要可以不填)

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "发布成功"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data string true none 携带信息

POST 任务列表

POST /pt/list

获得待接受任务列表

Body 请求参数

{
  "type": "快递",
  "page": 1,
  "pageSize": 5,
  "building": 31,
  "layer": 2
}

请求参数

名称 位置 类型 必选 说明
body body object none
» type body string 任务类别
» from body string 快递地点
» building body integer 楼号
» layer body integer 楼层
» size body string 快递大小
» elseTo body string 其他地点
» page body integer 第几页
» pageSize body integer 页面大小数量
» minP body number 最小值
» maxP body number 最大值
» priceOrder body integer 价格排序,1升序,0降序
» timeOrder body integer 时间排序,1升序,0降序

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": [
    {
      "id": "656dc368d7e2cd5ba855bcf7",
      "from": "快递站",
      "building": 2,
      "layer": 101,
      "publisherId": 4,
      "elseTo": "",
      "size": "中件",
      "status": "待接单2",
      "remark": "1",
      "price": 3,
      "type": "快递代拿",
      "createTime": "2023-12-04 20:17:44",
      "company": "圆通快递",
      "userAvatar": null
    },
    {
      "id": "6572f6af3d55ea45913bdfb8",
      "from": "快递站",
      "building": 1,
      "layer": 101,
      "publisherId": 12,
      "elseTo": "",
      "size": "中件",
      "status": "待接单2",
      "remark": "你好",
      "price": 3,
      "type": "快递代拿",
      "createTime": "2023-12-08 18:57:51",
      "company": "圆通快递",
      "userAvatar": null
    },
    {
      "id": "657da552ea7d3d5e60c6e0ad",
      "from": "快递站",
      "building": 32,
      "layer": 6,
      "publisherId": 1,
      "elseTo": "est",
      "size": "",
      "status": "待接单",
      "remark": "你很帅",
      "price": 59,
      "type": "快递代拿",
      "createTime": "2023-12-16 21:25:38",
      "company": "中通快递",
      "userAvatar": "https://bucketofpicture.oss-cn-hangzhou.aliyuncs.com/1b82842901bb43998585f07ee75d6385.png"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data [object] true none 任务列表
»» id string true none none
»» from string true none none
»» building integer true none none
»» layer integer true none none
»» elseTo string true none none
»» size string true none none
»» remark string true none none
»» publisherId integer true none 发布方id
»» status string true none none
»» price integer true none none
»» type string true none none
»» createTime string true none none
»» company string true none none
»» userAvatar string¦null true none 用户头像

GET 查看自己发布的任务

GET /pt/list/pub

查看自己发布的任务

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": [
    {
      "id": "652a8c1447c06c3493c1b274",
      "from": "快递站",
      "building": 31,
      "layer": 1,
      "elseTo": "食堂",
      "publisherId": 1,
      "receiverId": null,
      "size": "",
      "status": "待接单",
      "remark": "备注",
      "createTime": "2023-10-14 20:39:47",
      "incidentalMsg": {
        "code": "127-55-8",
        "phone": "2222",
        "name": "张三",
        "address": "222",
        "picture": null
      }
    },
    {
      "id": "652a8c5747c06c3493c1b275",
      "from": "快递站",
      "building": 31,
      "layer": 2,
      "elseTo": "食堂",
      "publisherId": 1,
      "receiverId": null,
      "size": "",
      "status": "待接单",
      "remark": "备注",
      "createTime": "2023-10-14 20:40:55",
      "incidentalMsg": {
        "code": "127-55-8",
        "phone": "2222",
        "name": "张三",
        "address": "222",
        "picture": null
      }
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data [object] true none 任务列表
»» id string true none none
»» from string true none none
»» building integer true none none
»» layer integer true none none
»» elseTo string true none none
»» publisherId integer true none none
»» receiverId null true none none
»» size string true none none
»» status string true none 单子状态:待接单,待接单2(已接过被人取消),已接单,完成
»» remark string true none none
»» createTime integer true none none
»» incidentalMsg object true none none
»»» code string true none none
»»» phone string true none none
»»» name string true none none
»»» address string true none none
»»» picture null true none none

GET 查看自己接受的任务

GET /pt/list/acp

查看自己接受的任务

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": [
    {
      "id": "652a8c1447c06c3493c1b274",
      "from": "快递站",
      "building": 31,
      "layer": 1,
      "elseTo": "食堂",
      "size": "",
      "remark": "备注"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data [object] true none 任务列表
»» id string false none none
»» from string false none none
»» building integer false none none
»» layer integer false none none
»» elseTo string false none none
»» size string false none none
»» remark string false none none

POST 承接任务

POST /pt/acp

承接任务

Body 请求参数

{
  "taskId": "652a8c1447c06c3493c1b274"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "接单成功"
}
{
  "status": 500,
  "message": "该订单已被接走或不存在",
  "data": null
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

POST 取消代取任务

POST /pt/delete

取消任务

Body 请求参数

{
  "taskId": "2"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 承接人员上传已拿到快递图片 json

POST /pt/progress/picture/json

上传快递图片的接口以及确定骑手已拿到快递的接口

image.png

Body 请求参数

{
  "taskId": "2",
  "picture": "http://dummyimage.com/400x400"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id
» picture body string 图片url

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 确认收到快递

POST /pt/confirm

Body 请求参数

{
  "taskId": "2"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 取消承接任务

POST /pt/acp/cancel

Body 请求参数

{
  "taskId": "string",
  "reason": "string",
  "picture": "string"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id
» reason body string 理由
» picture body string 相关图片

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

GET 获得订单进程信息

GET /pt/process/detail

获得订单进程信息

请求参数

名称 位置 类型 必选 说明
taskId query string 任务id
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "role": "receiver",
    "msgList": [
      {
        "type": 1,
        "message": "订单提交",
        "createTime": "2023-11-12 10:53:07"
      },
      {
        "type": 2,
        "message": "有骑手接单",
        "createTime": "2023-11-12 11:23:33"
      },
      {
        "type": 3,
        "message": {
          "msg": "已取货",
          "isSure": true,
          "picture": "http://dummyimage.com/400x400"
        },
        "createTime": "2023-11-27 20:14:00"
      },
      {
        "type": 5,
        "message": "正在派送",
        "createTime": "2023-11-27 20:14:00"
      },
      {
        "type": 4,
        "message": "确认货物",
        "createTime": "2023-11-27 20:15:36"
      }
    ],
    "taskId": "65503e13ce239629c883fbba",
    "status": "确认货物"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» role string true none none
»» msgList [object] true none none
»»» type integer true none none
»»» message object true none none
»»»» msg string true none none
»»»» picture string true none none
»»» createTime string true none none
»» taskId string true none none
»» status string true none none

GET 订单详情

GET /pt/detail

发布方获得订单的详细信息

请求参数

名称 位置 类型 必选 说明
taskId query string 任务id
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "id": "654f004a40f6701360f856e8",
    "from": "快递中心",
    "building": 31,
    "layer": 3,
    "elseTo": null,
    "publisherId": 1,
    "receiverId": null,
    "size": "",
    "status": "待接单",
    "price": 30,
    "type": "快递",
    "remark": "sunt pariatur",
    "createTime": "2023-11-11 12:17:14",
    "company": null,
    "incidentalMsg": {
      "code": "6--6-6-",
      "phone": "18128682251",
      "name": "力内则系红组克",
      "address": "香港特别行政区柳州市万秀区",
      "picture": null
    }
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» id string true none none
»» from string true none none
»» building integer true none none
»» layer integer true none none
»» elseTo null true none none
»» publisherId integer true none none
»» receiverId null true none none
»» size string true none none
»» status string true none none
»» price integer true none none
»» type string true none none
»» remark string true none none
»» createTime string true none none
»» company null true none none
»» incidentalMsg object true none none
»»» code string true none none
»»» phone string true none none
»»» name string true none none
»»» address string true none none
»»» picture null true none none

POST 确认货物

POST /pt/check

确认货物没问题

Body 请求参数

{
  "taskId": "25"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 骑手送达

POST /pt/complete

骑手点击说明已送达快递,同时上传图片

Body 请求参数

{
  "taskId": "98",
  "picture": "http://dummyimage.com/400x400"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id
» picture body string 图片1url

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

POST 给骑手评价

POST /pt/comment

Body 请求参数

{
  "stars": 4,
  "comment": "ea enim Duis esse culpa",
  "taskId": "654f19781a3c76669f0bed08",
  "receiverId": 6
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» stars body integer 星数(1-5)
» comment body string 评价
» taskId body string 任务id
» receiverId body number 骑手id

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": "string"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

GET 获得订单评价

GET /pt/comment

请求参数

名称 位置 类型 必选 说明
taskId query string 订单id
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "stars": 4,
    "comment": "ea enim Duis esse culpa",
    "time": "2023-11-22 19:39:09"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» stars integer true none none
»» comment string true none none
»» time string true none none

POST 投诉对方

POST /complain/add

接收方投诉发布方,或者发布方投诉接收方,不可重复投诉,不可投诉与本单无关的人,否则会显示投诉失败

Body 请求参数

{
  "taskId": "44",
  "complainantId": 18,
  "reason": "ut occaecat"
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 订单id
» reason body string 投诉理由

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "投诉成功"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data string true none none

POST 获得发布方信息

POST /pt/pub/info

Body 请求参数

{
  "id": 31
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» id body integer 发布方id

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "id": 31,
    "score": 4.833333333333333,
    "waitAcpCount": 0,
    "totalCount": 12,
    "complainCount": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» id integer true none none
»» score number true none 评分
»» waitAcpCount integer true none 等待接单订单数量
»» totalCount integer true none 总发布订单数量
»» complainCount integer true none 投诉数量

聊天室

POST 上传文件

POST /file/upload

聊天室中发送文件,获得url再发送消息

Body 请求参数

files:
  - file://D:\Desktop\服外校赛\头像\0CV_N)H]BH)BL1~%73_{M5W.png
  - file://D:\Desktop\服外校赛\头像\1.png
  - file://D:\Desktop\服外校赛\头像\MP~%4LRUXMZ(WHXJD{FLP9O.png

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» files body string(binary) 上传文件数组

返回示例

200 Response

{
  "status": 0,
  "message": "string",
  "data": [
    "string"
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data [string] true none url数组

GET 获得聊天室列表

GET /chat/list

获得用户有哪些聊天室

请求参数

名称 位置 类型 必选 说明
page query integer 页码
pageSize query integer 页大小
token header string none

返回示例

[
  {
    "taskId": "65573eaf4795617ff4a95fee",
    "role": "receiver",
    "isRead": false,
    "msgNum": 1,
    "lastMsg": {
      "type": 3,
      "senderId": 8,
      "msg": {
        "code": "",
        "phone": "2",
        "name": "力内则系红组克",
        "address": "生活二区3号楼103",
        "picture": "https://bucketofpicture.oss-cn-hangzhou.aliyuncs.com/865efb734819416fbe1dd3cc919cb1dc.png"
      }
    },
    "time": "2023-11-25 22:38:14"
  }
]

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» taskId string false none 任务id
» role string false none 在这个订单中的角色
» isRead boolean false none 是否有已读
» msgNum integer false none 未读信息数
» lastMsg object false none 最近一条信息
»» type integer true none none
»» senderId integer true none none
»» msg object true none none
»»» code string true none none
»»» phone string true none none
»»» name string true none none
»»» address string true none none
»»» picture string true none none
» time string false none 更新时间

统计

POST 通过id获取统计信息

POST /statistics/get

通过id获取statistics信息

Body 请求参数

{
  "id": "3"
}

请求参数

名称 位置 类型 必选 说明
body body object none
» userId body integer 骑手id

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "id": "3",
    "escapes": 0,
    "timeouts": 0,
    "totalOrders": 0,
    "completes": 0,
    "positiveReviews": 0,
    "negativeReviews": 0
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» code integer true none none
» errorMsg string true none none
» data object¦null false none none
»» id integer false none none
»» escapes integer false none 逃单数
»» timeouts integer false none 超时数
»» totalOrders integer false none 总接单数
»» completes integer false none 完成单数
»» positiveReviews integer false none 好评数
»» negativeReviews integer false none 差评数

POST 获得骑手评分

POST /statistics/score/get

根据骑手id去获取评分

Body 请求参数

{
  "id": 1
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» id body number 骑手id

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": 5
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data integer true none none

GET 投诉列表

GET /complain/list

客服查看所有投诉,测试阶段谁都能查看

请求参数

名称 位置 类型 必选 说明
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": [
    {
      "id": "65806839e9c6de07f99902c9",
      "taskId": "65503bad08509e42b059ed92",
      "complainantId": 1,
      "respondentId": 6,
      "reason": "不够快"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data [object] true none none
»» id string false none 投诉信息id
»» taskId string false none 订单id
»» complainantId integer false none 投诉方id
»» respondentId integer false none 被投诉方id
»» reason string false none 投诉理由

POST 获得骑手评论列表

POST /statistics/comment/get

Body 请求参数

{
  "receiverId": 12,
  "page": 1,
  "pageSize": 5
}

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» receiverId body number 骑手id
» page body integer 第几页
» pageSize body integer 页面大小

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": [
    {
      "stars": 4,
      "comment": "5",
      "time": "2023-12-20 16:38:14"
    },
    {
      "stars": 5,
      "comment": "639",
      "time": "2023-12-20 16:09:23"
    },
    {
      "stars": 4,
      "comment": "321",
      "time": "2023-12-20 16:07:11"
    },
    {
      "stars": 4,
      "comment": "987",
      "time": "2023-12-17 16:38:36"
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data [object] true none none
»» stars integer true none none
»» comment string true none none
»» time string true none none

废弃接口

POST 发布代取快递任务

POST /pt/publish

像取件码,手机尾号,姓名,送货详细地址,取件身份码这些信息,是有人接受这个代拿任务时再提供给接受放

Body 请求参数

type: 快递
from: 快递站
building: 31
layer: 2
elseTo: 食堂
size: 
price: 2
remark: 备注
code: 127-55-8
phone: "2222"
name: 张三
address: "222"
file: ""

请求参数

名称 位置 类型 必选 说明
token header string token
body body object none
» type body string 任务类型
» from body string 快递代取点
» building body integer 楼号
» layer body integer 楼层
» elseTo body string 其他地址,发布者可选定宿舍楼或者其他地区,选了其他地区,楼层楼号不用填
» size body string 快递大小
» price body number 价格
» remark body string none
» code body string 取件码(不需要可以不填)
» phone body string 手机尾号(不需要可以不填)
» name body string 姓名(不需要可以不填)
» address body string 送货的详细地址
» file body string(binary) 取件身份码(不需要可以不填)

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "发布成功"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data string true none 携带信息

POST 修改代取快递任务

POST /pt/update

像取件码,手机尾号,姓名,送货详细地址,取件身份码这些信息,是有人接受这个代拿任务时再提供给接受放

Body 请求参数

id: "123123"
type: 快递
from: 快递站
building: 31
layer: 2
elseTo: 食堂
size: 
remark: 备注
code: 127-55-8
phone: "2222"
name: 张三
address: "222"
file: ""

请求参数

名称 位置 类型 必选 说明
token header string token
body body object none
» id body string 任务id
» type body string 任务类型
» from body string 快递代取点
» building body integer 楼号
» layer body integer 楼层
» elseTo body string 其他地址,发布者可选定宿舍楼或者其他地区,选了其他地区,楼层楼号不用填
» size body string 快递大小
» remark body string none
» code body string 取件码(不需要可以不填)
» phone body string 手机尾号(不需要可以不填)
» name body string 姓名(不需要可以不填)
» address body string 送货的详细地址
» file body string(binary) 取件身份码(不需要可以不填)

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": "更新成功"
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none 状态码
» message string true none 描述信息
» data string true none 携带信息

POST 承接人员上传已拿到快递图片

POST /pt/progress/picture

Body 请求参数

taskId: xxx
file: ""

请求参数

名称 位置 类型 必选 说明
token header string none
body body object none
» taskId body string 任务id
» file body string(binary) 图片

返回示例

200 Response

{}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

Path

GET getPath

GET /getMediumPath

source,destination∈[1,70)

  • code,location 1,福建省福州市闽侯县福州大学学生公寓|1号楼 2,福建省福州市闽侯县福州大学学生公寓|2号楼 3,福建省福州市闽侯县福州大学学生公寓|3号楼 4,福建省福州市闽侯县福州大学学生公寓|4号楼 5,福建省福州市闽侯县福州大学学生公寓|5号楼 6,福建省福州市闽侯县福州大学学生公寓|6号楼 7,福建省福州市闽侯县福州大学学生公寓|7号楼 8,福建省福州市闽侯县福州大学学生公寓|8 9,福建省福州市闽侯县福州大学学生公寓|9号楼 10,福建省福州市闽侯县福州大学学生公寓|10号楼 11,福建省福州市闽侯县福州大学学生公寓|11号楼 12,福建省福州市闽侯县福州大学学生公寓|12号楼 13,福建省福州市闽侯县福州大学学生公寓|13号楼 14,福建省福州市闽侯县福州大学学生公寓|14号楼 15,福建省福州市闽侯县福州大学学生公寓|15号 16,福建省福州市闽侯县福州大学学生公寓|16号楼 17,福建省福州市闽侯县福州大学学生公寓|17号 18,福建省福州市闽侯县福州大学学生公寓|18号楼 19,福建省福州市闽侯县福州大学学生公寓|19号楼 20,福建省福州市闽侯县福州大学学生公寓|20 21,福建省福州市闽侯县福州大学学生公寓|21号 22,福建省福州市闽侯县福州大学学生公寓|22号楼 23,福建省福州市闽侯县福州大学学生公寓|23号 24,福建省福州市闽侯县福州大学学生公寓|24号 25,福建省福州市闽侯县福州大学学生公寓|25号楼 26,福建省福州市闽侯县福州大学学生公寓|26号楼 27,福建省福州市闽侯县福州大学学生公寓|27号楼 28,福建省福州市闽侯县福州大学学生公寓|28号楼 29,福建省福州市闽侯县福州大学学生公寓|29号楼 30,福建省福州市闽侯县福州大学学生公寓|30号楼 31,福建省福州市闽侯县福州大学学生公寓|31号楼 32,福建省福州市闽侯县福州大学学生公寓|32号楼 33,福建省福州市闽侯县福州大学学生公寓|33号楼 34,福建省福州市闽侯县福州大学学生公寓|34号楼 35,福建省福州市闽侯县福州大学学生公寓|35号楼 36,福建省福州市闽侯县福州大学学生公寓|36号楼 37,福建省福州市闽侯县福州大学学生公寓|37号楼 38,福建省福州市闽侯县福州大学学生公寓|38号楼 39,福建省福州市闽侯县福州大学学生公寓|39号楼 40,福建省福州市闽侯县福州大学学生公寓|40号楼 41,福建省福州市闽侯县福州大学学生公寓|41号楼 42,福建省福州市闽侯县福州大学学生公寓|42号楼 43,福建省福州市闽侯县福州大学学生公寓|43号楼 44,福建省福州市闽侯县福州大学学生公寓|44号楼 45,福建省福州市闽侯县福州大学学生公寓|45号楼 46,福建省福州市闽侯县福州大学|46栋 47,福建省福州市闽侯县福州大学|47号楼 48,福建省福州市闽侯县福州大学|48栋 49,福建省福州市闽侯县福州大学|49栋 50,福建省福州市闽侯县福州大学|50号楼 51,福建省福州市闽侯县福州大学|51栋 52,福建省福州市闽侯县福州大学学生公寓|52号楼 53,福建省福州市闽侯县福州大学学生公寓|53 54,福建省福州市闽侯县福州大学学生公寓|54号楼 55,福建省福州市闽侯县福州大学学生公寓|55 56,福建省福州市闽侯县福州大学学生公寓|56 57,福建省福州市闽侯县福州大学学生公寓|57号楼 58,福建省福州市闽侯县福州大学学生公寓|58号楼 59,福建省福州市闽侯县福州大学学生公寓|59 60,福建省福州市闽侯县福州大学学生公寓|60号 61,福建省福州市闽侯县福州大学学生公寓|61 62,福建省福州市闽侯县福州大学旗山校区|62栋 63,福建省福州市闽侯县福州大学学生公寓|63号 64,福建省福州市闽侯县福大玫瑰园餐厅 65,福建省福州市闽侯县紫荆园 66,福建省福州市闽侯县丁香园 67,福建省福州市闽侯县海棠园 68,福建省福州市闽侯县岐安福大学生街(溪源宫路) 69,福州大学快递服务中心

请求参数

名称 位置 类型 必选 说明
source query integer none
destination query integer none
token header string none

返回示例

{
  "status": 200,
  "message": "操作成功",
  "data": {
    "path": "[福建省福州市闽侯县福州大学学生公寓|1号楼->福建省福州市闽侯县福州大学学生公寓|2号楼->福建省福州市闽侯县福州大学学生公寓|4号楼->福建省福州市闽侯县福州大学学生公寓|6号楼->福建省福州市闽侯县福州大学学生公寓|8->福州大学快递服务中心]"
  }
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK none Inline

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
» status integer true none none
» message string true none none
» data object true none none
»» path string true none none

数据模型