NAV
json

WE GATHER ADMIN API WIKI 文档

WE GATHER ADMIN API API WIKI 微会议管理后台的API文档

接口调试

可以使用接口中提供的Curl命令进行调试,推荐安装jq来进行Json的序列化显示。

安装方式

Mac os

brew install jq

Windos

官网下载: https://stedolan.github.io/jq/

接口参数格式

目前接口部分使用 HTTPBody 来进行参数传递,接口支持 application/jsonBody 格式

同时也支持 application/x-www-form-urlencoded 的 Body 格式

两种方式均需要在 Header 中注明内容类型的属性。

请勿使用from-data传递Payload

接口返回说明

第一层 http code返回码,目前常见返回码如下

Http code 说明
200 调用成功
400 调用失败,返回自定义错误
401 鉴权失败
403 权限不足,没有调用权限
500 服务器本身出错

第二层 接口返回内容中的status和error字段

对于status,我们有如下规定

错误说明

error(针对于APP端)

为字符串,会给出status的具体错误原因描述,可信赖字段,可直接展示至前端页面

errors (针对于PC端 用于表单验证)

为一个对象,会给出status的具体错误原因描述,这个字段适用于程序开发中的错误调试,不应该把他的返回内容作为代码逻辑判断的条件。也不应直接在前端页面显示。

示例

{
    "status": 1,
    "errors": {
        "account": " account 不能为空",
        "code": " code 不能为空"
    }
}

接口地址说明

http https
线下
预发布
正式 暂无

鉴权

接口使用的是基于 rfc6750Bearer Token 基于JWT来进行鉴权

我们的Bearer Token 使用的是,在实际业务中并不需要每次调用接口前都去获取Token

Token的有效期内可以直接用现有的Token进行接口调用,目前我们的Token 有效期为24小时,过期后则立即失效。此外客户端也可以对Token进行自解,来判断token有效期

访问需要鉴权的接口共需要两步:

  1. 判断当前Token是否存在或过期,若有异常则重新通过登录授权接口获取Token 。(通过账号密码进行验证,移动端额外需要设备唯一标识传至头部信息)
  2. 在Http Header中携带已保存的Token
  3. 头部信息描述 key为Authorization value为登陆接口返回的Token

系统鉴权 access

获取Bearer Token

GET_BEARER_TOKEN

获取系统中所使用的token

curl --request POST \
   --url  '${API_HOST}/api/access/token' \
   --header 'Content-Type: application/json' \
   --data-raw '{"token":"xxxxx"}' | jq
{
    "status": 0,
    "data": {
        "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFjcC1hcGkifQ.eyJjb2RlIjoiM2MwZTMyYTciLCJkZXZpY2UiOiI0NSIsImF1ZCI6MzAzLCJpc3MiOiJhY3AtYXBpLWRldmVsb3BtZW50Iiwic3ViIjoiYWNwX21vYmlsZV91c2VyIiwiaWRlbnQiOiIyMGM2MDRiZCIsImlhdCI6MTY1NTk3ODQ5MywiZXhwIjoxNjU2MDY0ODkzfQ.SOXPoyApPWgmQGEkHBiXEjrjkS0FJ4zJxCFTU2Cpiuw",
        "token_method": "HS256",
        "token_type": "Bearer",
        "expire_time": 1656064893,
        "nickname": "zhusj"
    }
}

HTTP Method

POST

HTTP Request

/api/oauth/access

Request Parameters Body

{
    "token":"xxxxx",
    "state":""
}
Title Description Type Tips
token access token String 从oa获取,用该token获取子系统的token

Request Parameters Query

Response Data

Title Type Description Tips
status int 状态 0 正常 1为失败
token string token字符串
token_method string 加密方式
token_type string token 的类型,目前应该固定为 Bearer
expire_time int 过期时间
nickname string 后台账户昵称

将Token的中段Base64Decode后,可以序列化为一个Payload对象'

Token Payload:

{
    "aud": 13, //用户ID
    "iss":"we-gather-api-{环境变量}", //当前环境
    "sub":"we-gather-user", //颁发方
    "iat":1573116338, //颁发时间
    "exp":1573119938  //过期时间
}

Payload

Title Description Type Tips
aud string 使用管理员ID
iss string 颁发方
sub int 使用方
iat int 颁发时间
exp int 过期时间

Log

日期 作者 内容
2023/03/29 朱思嘉 新增
2023/04/04 荀立强 修改

账号登陆

HTTP Method

POST

HTTP Request

/api/oauth/login

Request Parameters Body

{
    "account":"xxxxx",
    "password":"123456"
}
Title Description Type Tips
account 账号 String 和oa账号一致
password 密码 String 初始密码:123456

Request Parameters Query

Response Data

Title Type Description Tips
status int 状态 0 正常 1为失败
token string token字符串
token_method string 加密方式
token_type string token 的类型,目前应该固定为 Bearer
expire_time int 过期时间
日期 作者 内容
2023/04/14 荀立强 新增
{
  "status": 0,
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6IndnX2FkbWluX2FwaSJ9.eyJpc3MiOiJ3Z19hZG1pbl9hcGkiLCJzdWIiOiJzZGsiLCJpZGVudCI6IjBjYzNjYzBjOGFiZjRiODQ4ZjgxODNkYTllOWY5ZGZjIiwiaWF0IjoxNjgxNDQ1MDg4LCJleHAiOjE2ODIwNDk4ODgsIm5hbWUiOiJcdTgzNDBcdTdhY2JcdTVmM2EifQ.o9Ajx0UdXGcdSVDWaWFpseqJg5dBzoS-MgnKV3TBa3c",
    "token_method": "HS256",
    "token_type": "Bearer",
    "expire_time": 1682049888
  }
}

HTTP Method

GET

HTTP Request

/api/basic/behaviors

Request Parameters Body

暂无

Request Parameters Query

Response Data

Title Type Description Tips
status int 状态 0 正常 1为失败
modules List[Module] Module 组件列表
user_info UserInfo 用户基础信息

Module

Title Description Type Tips
name string 模块名称
label string 注释(一般为中文)
permissions Permission Object 使用方
show bool 是否显示

Permission

Title Description Type Tips
name string 权限名称
label string 注释(一般为中文)

UserInfo

Title Description Type Tips
oa_user_name string 用户鉴权用姓名
level int 用户等级 Enum枚举类型1,2,3 ...

Modules&Permissions Info

Module

Name Label Min Level Tips
guest 嘉宾管理 3
order 订单管理 1
invoice 发票管理 1
sync 同步管理 1

嘉宾管理 Guest Module Permission

Name Label Min Level Tips
guest_search 嘉宾管理 3 需要提供额外的s=base64(${user_info.oa_user_name}) 确定搜索范围
guest_export 嘉宾范围导出 3 需要提供额外的s=base64(${user_info.oa_user_name}) 确定导出范围
guest_import 嘉宾范围导入 2 需要提供额外的s=base64(${user_info.oa_user_name}) 用于将导入人员直接绑定当前操作人
guest_school_info_export 嘉宾校友会信息导出 1
assign_sales 协同销售分配 1
rand_assign_rand 协同销售随机分配 1
guest_audit 嘉宾审核 1
guest_add 嘉宾审核 1
guest_delete 嘉宾删除 1
guest_backout 嘉宾删除恢复 1
guest_attribute_update 嘉宾额外属性更新 1
assign_group 指派加入特定群组(晚宴) 1

订单管理 Order Module Permission

Name Label Min Level Tips
order_search 订单搜索 1 临时填充,当前版本无实际作用

发票管理 Invoice Module Permission

Name Label Min Level Tips
invoice_search 发票搜索 1 临时填充,当前版本无实际作用

同步管理 sync Module Permission

Name Label Min Level Tips
sync 同步 1 临时填充,当前版本无实际作用

Log

日期 作者 内容
2023/04/04 谢宇轩 新增

会议

会议筛选项

HTTP Method

GET

HTTP Request

/api/meeting/search_item

Request Parameters Query

Title Description Type Required Tips
title 会议名称 string

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data SearchItem object

SearchItem

Title Description Type Required Tips
可筛选的key 可筛选的key []Search 可在query中使用

Search 可筛选的值

Title Description Type Required Tips
label 展示文本 string
value 可筛选值 int
num 统计数 int

Response Data Json

{
  "status": 0,
  "data": {
    "status": [
      {
        "label": "全部",
        "value": -1,
        "num": 630
      },
      {
        "label": "待发布",
        "value": 2,
        "num": 64
      },
      {
        "label": "进行中",
        "value": 4,
        "num": 25
      },
      {
        "label": "已结束",
        "value": 5,
        "num": 263
      }
    ]
  }
}

会议列表

HTTP Method

GET

HTTP Request

/api/meeting

Request Parameters Query

Title Description Type Required Tips
title 会议名称 string
status 状态 int

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 object

data

Title Description Type Required Tips
status 接口状态 int 0成功 非0失败
current_page 当前页 int
last_page 最后一页 int
total 总条数 int
data 会议列表 []Meeting

Meeting

Title Description Type Required Tips
title 会议名称 int 0成功 非0失败
cover 封面图 int
start_time 会议开始时间 int
end_time 会议结束时间 int
plan_num 设定人数 int
apply_num 实际参会人数 int
province_name string
city_name 城市 string
county_name string
address 详细地址 string
user_id 用户ID int
create_time 创建时间 string
sync_code 签到系统绑定码 string
status_text 状态展示文本 string
user 发布人信息 UserObject

User

Title Description Type Required Tips
id 发布人ID int
nickname 发布人昵称 string

Response Data Json

{
  "status": 0,
  "current_page": 1,
  "last_page": 316,
  "total": 631,
  "data": [
    {
      "id": 2590090,
      "title": "小小测试【嘉宾管理】",
      "cover": "http://s.laoyaoba.com/jwImg/meeting/2023/04/21/16820577027159.jpg",
      "status": 4,
      "start_time": 1682064811,
      "end_time": 1682576011,
      "apply_num": 1,
      "province_name": "北京市",
      "city_name": "北京",
      "county_name": "海淀区",
      "address": "永丰地铁",
      "user_id": 5182359,
      "create_time": 1682057784,
      "sync_code": null,
      "status_text": "进行中",
      "user": {
        "id": 5182359,
        "nickname": "N_138****5748"
      }
    },
    {
      "id": 2590089,
      "title": "测试会议草稿",
      "cover": "http://s.laoyaoba.com/jwImg/meeting/2023/03/29/16800578002008.jpg",
      "status": 1,
      "start_time": 1680057751,
      "end_time": 1680144151,
      "apply_num": 0,
      "province_name": "河北省",
      "city_name": "秦皇岛市",
      "county_name": "北戴河区",
      "address": "北京海淀",
      "user_id": 5182341,
      "create_time": 1680057824,
      "sync_code": null,
      "status_text": "",
      "user": {
        "id": 5182341,
        "nickname": "账号已注销"
      }
    }
  ]
}

嘉宾 guest

审核状态列表

HTTP Method

GET

HTTP Request

/api/v0/guest/status

Request Parameters Query

Title Description Type Required Tips
meeting_id 会议ID Int
res 资源类型 String 允许值 review synchro time sku apply extra sell header sell_wait_num special_option list_modify list_filter_apply 不在允许值范围将返回全部资源
manager 是否管理员 Int 1-是 0-否 default=0

Request Parameters Body

暂无

Response Json

{
  "code": 0,
  "data": {
    "review": [
      {
        "key": 0,
        "value": "全部",
        "total": 581
      },
      {
        "key": 1,
        "value": "已报名",
        "total": 414
      },
      {
        "key": 2,
        "value": "报名成功",
        "total": 196
      },
      {
        "key": 3,
        "value": "待审核",
        "total": 217
      },
      {
        "key": 4,
        "value": "待支付",
        "total": 0
      },
      {
        "key": 5,
        "value": "审核拒绝",
        "total": 1
      },
      {
        "key": 6,
        "value": "已取消",
        "total": 98
      },
      {
        "key": 7,
        "value": "已删除",
        "total": 69
      }
    ],
    "synchro": [
      {
        "key": 0,
        "value": "全部"
      },
      {
        "key": 1,
        "value": "已同步"
      },
      {
        "key": 2,
        "value": "未同步"
      },
      {
        "key": 3,
        "value": "同步失败"
      }
    ],
    "time": [
      {
        "key": 0,
        "value": "报名时间"
      },
      {
        "key": 1,
        "value": "更新时间"
      }
    ],
    "sku": [
      {
        "key": 877,
        "value": "免费票"
      },
      {
        "key": 878,
        "value": "早鸟票"
      },
      {
        "key": 879,
        "value": "普通票"
      },
      {
        "key": 880,
        "value": "现场票"
      }
    ],
    "apply": [
      {
        "key": 2,
        "value": "姓名",
        "extend": ""
      },
      {
        "key": 3,
        "value": "手机号",
        "extend": ""
      },
      {
        "key": 123,
        "value": "单位类型",
        "extend": "企业,投资机构,园区/政府,科研院所,高校,券商,专家学者"
      },
      {
        "key": 146,
        "value": "公司名称",
        "extend": ""
      },
      {
        "key": 10,
        "value": "职务",
        "extend": ""
      },
      {
        "key": 1,
        "value": "邮箱",
        "extend": ""
      },
      {
        "key": 8,
        "value": "微信",
        "extend": ""
      },
      {
        "key": 106,
        "value": "是否参加园区面对面",
        "extend": "参加,不参加"
      },
      {
        "key": 148,
        "value": "是否参加《出口管制论坛暨手机中国联盟年会》",
        "extend": "是,否"
      },
      {
        "key": 138,
        "value": "调查问卷",
        "extend": "2023集微半导体峰会,人工智能峰会,第六届半导体峰会,集微EDA/工业软件峰会,集微半导体制造峰会,集微之夜,高端通用芯片生态论坛,投融资论坛,第二届集微半导体人力资源大会,校友论坛"
      },
      {
        "key": 116,
        "value": "是否参加分析师大会",
        "extend": "是,否"
      }
    ],
    "extra": [
      {
        "key": 0,
        "value": "是否参加管制论坛会议"
      },
      {
        "key": 1,
        "value": "知识产权论坛暨手机中国联盟年会座位"
      },
      {
        "key": 2,
        "value": "中国半导体投资联盟理事会座位"
      },
      {
        "key": 3,
        "value": "微电子学院校企合作论坛座位"
      },
      {
        "key": 4,
        "value": "上市公司机构交流论坛座位"
      },
      {
        "key": 5,
        "value": "欢迎晚宴座位"
      },
      {
        "key": 7,
        "value": "地区"
      }
    ],
    "sell": [
      {
        "name": "郭阔",
        "children": [
          {
            "name": "于斌"
          },
          {
            "name": "黄霏"
          }
        ]
      },
      {
        "name": "俞思思",
        "children": [
          {
            "name": "廖鹏程"
          },
          {
            "name": "丁宣贵"
          }
        ]
      },
      {
        "name": "邢雪松",
        "children": [
          {
            "name": "林鸿(泓宇)"
          },
          {
            "name": "陈桂爱"
          },
          {
            "name": "贾仲婷"
          },
          {
            "name": "王济君"
          },
          {
            "name": "高尚"
          },
          {
            "name": "刘佳炀"
          },
          {
            "name": "王仕龙"
          },
          {
            "name": "蒋鹏"
          },
          {
            "name": "杨琛君"
          },
          {
            "name": "陈杰"
          },
          {
            "name": "彭斌"
          },
          {
            "name": "龚杨梅"
          },
          {
            "name": "张天楷"
          },
          {
            "name": "李浩"
          },
          {
            "name": "王震"
          }
        ]
      },
      {
        "name": "陈荣",
        "children": [
          {
            "name": "王建伟"
          },
          {
            "name": "柏丽娜"
          },
          {
            "name": "乔赟"
          },
          {
            "name": "刘真良"
          },
          {
            "name": "刘美娜"
          },
          {
            "name": "兰玲玲"
          }
        ]
      },
      {
        "name": "徐伦",
        "children": [
          {
            "name": "汤瑞玲"
          },
          {
            "name": "李凯悦"
          },
          {
            "name": "蒙瑞清"
          },
          {
            "name": "王何"
          }
        ]
      }
    ],
    "sell_wait_num": 176,
    "header": [
      "姓名",
      "手机号",
      "单位类型",
      "公司名称",
      "地区",
      "负责销售",
      "职务",
      "邮箱",
      "微信",
      "是否参加园区面对面",
      "是否参加《出口管制论坛暨手机中国联盟年会》",
      "调查问卷",
      "是否参加分析师大会",
      "是否参加管制论坛会议",
      "知识产权论坛暨手机中国联盟年会座位",
      "中国半导体投资联盟理事会座位",
      "微电子学院校企合作论坛座位",
      "上市公司机构交流论坛座位",
      "欢迎晚宴座位",
      "往届晚宴座位",
      "是否参加校友会",
      "票种名称",
      "嘉宾来源",
      "报名状态",
      "报名时间",
      "更新时间",
      "是否参加晚宴",
      "参会意向"
    ],
    "special_option": [
      "姓名",
      "手机号",
      "单位类型",
      "公司名称",
      "职务",
      "邮箱",
      "微信",
      "是否参加园区面对面",
      "是否参加《出口管制论坛暨手机中国联盟年会》",
      "调查问卷",
      "是否参加分析师大会",
      "是否参加晚宴",
      "审核时间",
      "往届晚宴座位",
      "欢迎晚宴座位",
      "地区",
      "嘉宾来源"
    ],
    "list_modify": [
      {
        "title": "负责销售",
        "key": "sell",
        "tip": "",
        "show_tip": false,
        "type": "intput"
      },
      {
        "title": "是否允许参加管制会议",
        "key": "是否允许参加管制会议",
        "tip": "文本失去焦点可结束编辑",
        "show_tip": true,
        "type": "intput"
      },
      {
        "title": "合同权益",
        "key": "合同权益",
        "tip": "文本失去焦点可结束编辑",
        "show_tip": true,
        "type": "intput"
      },
      {
        "title": "参会意向",
        "key": "参会意向",
        "tip": "请填写嘉宾意向: 参加、不参加、待定 (填写其他文字无效)",
        "show_tip": true,
        "type": "intput"
      },
      {
        "title": "地区",
        "key": "地区",
        "tip": "文本失去焦点可结束编辑",
        "show_tip": true,
        "type": "intput"
      },
      {
        "title": "备注",
        "key": "remark",
        "tip": "文本失去焦点可结束编辑",
        "show_tip": true,
        "type": "textarea"
      }
    ],
    "list_filter_apply": [
      {
        "key": 106,
        "value": "是否参加园区面对面",
        "extend": "参加,不参加"
      },
      {
        "key": 116,
        "value": "是否参加分析师大会",
        "extend": "是,否"
      },
      {
        "key": 148,
        "value": "是否参加《出口管制论坛暨手机中国联盟年会》",
        "extend": "是,否"
      }
    ]
  }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
review 审核状态 Array Object
synchro 同步状态 Array Object
time 时间筛选 Array Object
sku 票券 Array Object
apply 基础报名信息-表单报名项 Array Object
extra 高级报名信息-座位信息 Array Object
sell 销售信息 Array Object
header 表头信息 Array Object
cold_index 冻结列信息 Int 滑动冻结列的key
sell_wait_num 待分配销售 Int
special_option 需要屏蔽的特殊选项 Array Object
list_modify 列表需要修改的特殊项及扩展信息 Array Object
list_filter_apply 列表需要筛选的特殊项 Array Object

review Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 状态名称 String
total 总数 Int

synchro Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 状态名称 String

time Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 状态名称 String

sku Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 状态名称 String

apply Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 选项名称 String
extend 选项扩展信息 String 使用,号分割即可

extra Object

Title Description Type Tips
key 下标 Int
value 座位名称,列表筛选时传入的值 String

sell Object

Title Description Type Tips
title 主管销售 Int
children 下级销售 Array Object 当无下级销售时不返回此字段

header Object

Title Description Type Tips
value 表头信息 String

Special Option Object

Title Description Type Tips
value 特殊选项信息 String

List Modify Object

Title Description Type Tips
title 标题 String
key 键名(每个选项的修改方式不同 用来区分) String
tip 提示 String
show_tip 是否显示提示信息 Bool
type 编辑框类型 String

LIST Filter Apply Object

Title Description Type Tips
key 下标,列表筛选时传入的值 Int
value 选项名称 String
extend 选项扩展信息 String 使用,号分割即可

Log

日期 作者 内容
2023/04/06 朱思嘉
2023/05/19 朱思嘉 增加列表修改列及筛选列

获取列表

HTTP Method

GET

HTTP Request

/api/v0/guest

Request Parameters Query

Title Description Type Required Tips
meeting_id 会议ID Int
page 页数 Int default=1
limit 个数 Int default=20
name 姓名 String 模糊匹配
phone 手机号 String 模糊匹配
company 公司名称 String 模糊匹配
review 审核状态 Int api/mis/guest/status返回信息中review-key
synchro 同步状态 Int api/mis/guest/status返回信息中synchro-key
time 时间筛选 Int api/mis/guest/status 返回信息中time-key 默认为0 即报名时间
start_time 开始时间 String 2023-03-01 13:00:00
end_time 结束时间 String 2023-03-01 17:00:00
sku_id 票券ID Int api/mis/guest/status返回信息中sku-key
apply 表单项 Object 下方详细说明
extra 座位项 Object 下方详细说明
site_name 座位名称 String 搜索某个座位名称
intention 参会意向 String 模糊搜索
before_site 往届座位信息 String
is_past 是否往届用户 Int 0-否 1-是 default=0
pass 审核成功/审核失败 Int 1-成功 2-失败
order_num 订单号 String
sell 销售 String
remark 备注 String 模糊搜索
sell_status 指派销售状态 Int 0-全部 1-已指派 2-未指派 default=0
is_face 是否通过人脸认证 Int 0-否 1-是 default=0
seat 是否有晚宴座位 Int 1-是 2-否 default=all
excel 是否导出 Int 0-否 1-是 default=0 excel=1 header('Content-type:text/csv;charset=utf-8;) |header('Content-type:application/vnd.ms-excel;charset=utf-8;)
demo 导出样例文件 Int 0-否 1-是 默认会导出报名成功的最新的一条数据
export_school 是否导出校友会相关信息 Int 0-否 1-是 default=0
export_park 是否导出园区面对面 Int 0-否 1-是 default=0
excel_suffix 导出格式 Int 允许值"csv xls" default=csv
csv_mime 导出后缀 Int 允许值"csv stream" default=csv stream-便于web端接受返回信息
manager 是否管理员 Int 1-是 0-否 default=0
参数说明:

导出所有参会数据 /api/v0/guest?excel=1

导出所有参会数据并且返回格式为 blob /api/v0/guest?excel=1&csv_mime=stream

导出所有校友会数据 /api/v0/guest?excel=1&export_school=1

导出所有园区面对面数据 /api/v0/guest?excel=1&export_park=1

导出一份导入的样例文件 /api/v0/guest?excel=1&demo=1  默认会导出报名成功的最新的一条数据

site Object 此条件为逻辑'或'条件

Title Description Type Tips
key 座位名称 String 此处的座位名称为api/mis/guest/status返回信息中extra-value
value 座位信息 String
[{"key":"是否参加欢迎晚宴","value":"桌号 1"},{"key":"是否参加集微晚宴2"},{"key":"是否参加集微晚宴3","value":"桌号 3"}]

apply Object 此条件为逻辑'与'条件

Title Description Type Tips
key 选项ID Int 此处的选项ID为api/mis/guest/status返回信息中apply-key 或 list_filter_apply-key
value 填入信息 String
[{"key":2,"value":"朱思嘉"},{"key":3,"value":"18434819907"},{"key":115,"value":"爱集微咨询(厦门)有限公司"}]

Request Parameters Body

暂无

Response Json

{
    "code": 0,
    "data": {
        "current_page": 1,
        "last_page": 218,
        "per_page": 1,
        "total": 218,
        "data": [
            {
                "id": 16595,
                "order_num": "230411905193049009",
                "remark": "测试一下",
                "status": 1,
                "review_time": "0000-00-00 00:00:00",
                "is_review": 0,
                "is_invoice": 0,
                "order_status": 1,
                "order_source": "mis",
                "vip_status": "否",
                "synchro_status": 0,
                "synchro_explain": "",
                "is_face": 0,
                "is_past": 1,
                "base": {
                    "姓名": "朱思嘉测试导入",
                    "手机号": "18434819907",
                    "单位类型": "企业",
                    "公司名称": "爱集微",
                    "职务": "php",
                    "邮箱": "zhusj@ijiwei.com",
                    "微信": "wechat"
                },
                "extend": {
                    "票种名称": "免费票",
                    "报名状态": "已删除",
                    "报名时间": "2023-04-11 13:21:59",
                    "更新时间": "2023-04-12 11:30:28",
                    "是否有参会意向": 1,
                    "是否有晚宴座位": 1,
                    "往届桌号": "桌号111",
                    "负责销售": "朱思嘉"
                },
                "site": {
                    "是否参加知识产权论坛暨手机中国联盟年会": "桌号:1",
                    "是否参加中国半导体投资联盟理事会": "桌号:12",
                    "是否参加微电子学院校企合作论坛": "桌号:13",
                    "是否参加上市公司机构交流论坛": "桌号:14",
                    "是否参加欢迎晚宴": "桌号:15"
                },
                "apply": {
                    "嘉宾身份": "",
                    "毕业院校": "[{\"school\":\"北京理工大学\\r\",\"className\":\"123\",\"alumni\":false},{\"school\":\"北京交通大学\\r\",\"className\":\"1111\",\"alumni\":false},{\"school\":\"山西大学\\r\",\"className\":\"1000\",\"alumni\":false}]",
                    "是否参加园区面对面": "是",
                    "园区面对面信息": null,
                    "调查问卷": "",
                    "是否参加分析师大会": "是"
                }
            }
        ]
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
current_page 当前页码 Int
last_page 最大页码 Int
per_page 每页个数 Int
total 总数 Int
data 嘉宾信息 Array Object

data Object

Title Description Type Tips
id 参会ID Int
order_num 订单号 String
remark 备注 String
synchro_status 同步状态 Int 0-未同步 1-已同步 2-同步失败
synchro_explain 同步失败原因 Sting 当synchro_status=2时
status 参会信息状态 Int 0-删除 1-正常
is_face 人脸认证 Int 0-否 1-是
is_upload_face 是否上传人脸 Int 0-否 1-是
is_subscribe_wx 是否绑定微信平台 Int 0-否 1-是
is_past 往届用户 Int 0-否 1-是
sell 销售名称 String
is_review 审核状态 Int 审核状态:默认0无需审核,1审核中,2审核失败,3审核成功
review_time 审核时间 String
is_invoice 是否开具发票 Int 0-否 1-是
order_status 订单状态 Int 状态(0删除,1待参加,2待支付,3退票失败,4已退票,5退票中,6待评价,7已完成,8已过期,9支付已超时,10支付失败)
order_source 订单来源 Int 下单来源

| base | 基础信息 | Object | | | extend | 扩展信息 | Object | | | site | 座位信息 | Object | | | apply | 表单信息 | Object | |

base extend site apply Object

Title Description Type Tips
index 座位名称 String (并无此字段 此处为简要描述,请注意上方json格式规范)
value 座位信息 String (并无此字段 此处为简要描述,请注意上方json格式规范)
{
    "base": {
        "姓名": "朱思嘉测试导入",
        "手机号": "18434819907",
        "单位类型": "企业",
        "公司名称": "爱集微",
        "职务": "php",
        "邮箱": "zhusj@ijiwei.com",
        "微信": "wechat"
    },
    "extend": {
        "票种名称": "免费票",
        "报名状态": "已删除",
        "报名时间": "2023-04-11 13:21:59",
        "更新时间": "2023-04-12 11:30:28",
        "是否有参会意向": 1,
        "是否有晚宴座位": 1,
        "往届桌号": "桌号111"
    },
    "site": {
        "是否参加知识产权论坛暨手机中国联盟年会": "桌号:1",
        "是否参加中国半导体投资联盟理事会": "桌号:12",
        "是否参加微电子学院校企合作论坛": "桌号:13",
        "是否参加上市公司机构交流论坛": "桌号:14",
        "是否参加欢迎晚宴": "桌号:15"
    },
    "apply": {
        "嘉宾身份": "",
        "毕业院校": "[{\"school\":\"北京理工大学\\r\",\"className\":\"123\",\"alumni\":false},{\"school\":\"北京交通大学\\r\",\"className\":\"1111\",\"alumni\":false},{\"school\":\"山西大学\\r\",\"className\":\"1000\",\"alumni\":false}]",
        "是否参加园区面对面": "是",
        "园区面对面信息": null,
        "调查问卷": "",
        "是否参加分析师大会": "是"
    }
}

Log

日期 作者 内容
2023/04/06 朱思嘉
2023/04/12 朱思嘉 修改列表返回格式

新增

HTTP Method

POST

HTTP Request

/api/v0/guest/store

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
meeting_id 会议ID Int
sku_id 票券ID Int 此处的ID为api/mis/guest/status返回信息中sku-key
force 是否开启强制更新 Int force=1 开启后将会屏蔽姓名手机号重复验证 default=0
send 是否发送短信 Int send=1
apply 表单报名项 Object
extra 额外报名项 Object
sell 销售 String
check 是否开启审核 Int 1-是 0-否 default=0

apply Object

Title Description Type Tips
key 选项ID Int 此处的选项ID为api/mis/guest/status返回信息中apply-key (并无此字段 此处为简要描述,请注意右侧json格式规范)
value 填入信息 String (并无此字段 此处为简要描述,请注意右侧json格式规范)
    {
        "1": "1527543657@qq.com",
        "2": "小居2",
        "3": "18434819907",
        "8": "wechat",
        "10": "php",
        "106": "否",
        "146": "爱集微咨询(厦门)有限公司",
        "123": "企业"
    }

extra Object

Title Description Type Tips
key 座位名称 String 此处的选项ID为api/mis/guest/statusextra-value
value 座位信息,用户输入值 String
    [{
        "key":"是否参加知识产权论坛暨手机中国联盟年会",
        "value":"桌号:123"
    },{
        "key":"是否参加中国半导体投资联盟理事会",
        "value":"桌号:456"
    }]

Response Json

{
    "code": 0,
    "data": {
        "order_num": "230407536848725907"
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
order_num 订单号 String

Response Error

Tips
HttpCode:200 成功
HttpCode:202 已接受。已经接受请求,但未处理完成(添加失败数据重复,是否开启强制添加)
HttpCode:400 错误

Log

日期 作者 内容
2023/04/07 朱思嘉

修改

HTTP Method

PUT

HTTP Request

/api/v0/guest/edit

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 String
remark 订单备注 String
sell 销售 String
join 参会意向 String
apply 表单报名项 Object
extra 座位信息 Object

apply Object

Title Description Type Tips
key 选项ID Int 此处的选项ID为api/mis/guest/status返回信息中apply-key (并无此字段 此处为简要描述,请注意右侧json格式规范)
value 填入信息 String (并无此字段 此处为简要描述,请注意右侧json格式规范)
    {
        "1": "1527543657@qq.com",
        "2": "小居2",
        "3": "18434819907",
        "8": "wechat",
        "10": "php",
        "106": "否",
        "146": "爱集微咨询(厦门)有限公司",
        "123": "企业"
    }

extra Object

Title Description Type Tips
key 座位名称 String 此处的选项ID为api/mis/guest/statusextra-value
value 座位信息,用户输入值 String
    [{
  "key":"是否参加知识产权论坛暨手机中国联盟年会",
  "value":"桌号:123"
},{
  "key":"是否参加中国半导体投资联盟理事会",
  "value":"桌号:456"
}]

Response Json

{
    "code": 0,
    "data": {
        "order_num": "230407536848725907"
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
order_num 订单号 String

Log

日期 作者 内容
2023/04/07 朱思嘉

导入

HTTP Method

POST

HTTP Request

/api/v0/guest/import

Request Parameters Query

暂无

Request Head

multipart/form-data

如果使用application/json需要将文件base64 前后端处理较复杂,故此处使用multipart/form-data

Request Parameters Body

Title Description Type Required Tips
meeting_id 会议ID Int
file 文件 File

Response Json

{
    "code": 0,
    "data": {
        "total": 1,
        "update": 1,
        "add": 0,
        "fail": 0,
        "msg": []
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
update 修改成功数 Int
add 新增成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2023/04/06 朱思嘉

单个或批量同步嘉宾

HTTP Method

POST

HTTP Request

/api/v0/guest/synchro

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
meeting_id 会议ID Int
order_num 订单号 Object 订单号 不传则同步所有会议未同步状态的数据
site_name 额外扩展信息 String 座位信息

OrderNum Object

{
    "meeting_id":890005,
    "order_num":["220923197987120209","12312321"],
    "site_name":"是否参加芯力量评选"
}

Response Json

{
    "code": 0,
    "data": {
        "total": 2,
        "success": 0,
        "fail": 1,
        "msg": [
            "参会信息已同步:220923197987120209",
            "订单号有误:12312321"
        ]
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2023/04/06 朱思嘉

单个或批量更新参会状态

HTTP Method

PUT

HTTP Request

/api/v0/guest/reset

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 Object
revive 恢复嘉宾 Int 0-删除 1-恢复 default=0

OrderNum Object

{
    "order_num":["230227893699866597","344434"],
    "revive":1 
}

Response Json

{
    "code": 0,
    "data": {
        "total": 2,
        "success": 1,
        "fail": 1,
        "msg": [
            "344434 恢复失败:订单号不存在"
        ]
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2023/04/06 朱思嘉

单个或批量修改订单属性

HTTP Method

PUT

HTTP Request

/api/guest/attribute/{meeting_id}

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 Object 订单号 不传则同步所有会议未同步状态的数据
res 资源名称 String 允许值'dinner' dinner-晚宴
close 是否关闭资源 Int 0-否 1-是 default=0

OrderNum Object

{
    "order_num":["230411905193049009","230411902644654570","230411900549028497"],
    "res":"dinner",
    "close":0
}

Response Json

{
    "status": 0,
    "data": {
        "total": 3,
        "success": 2,
        "fail": 1,
        "msg": [
            "订单号错误:23041190054902849712"
        ]
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2023/04/12 朱思嘉

单个或批量恢复嘉宾审核状态

HTTP Method

PUT

HTTP Request

/api/v0/guest/rebirth

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 Object 订单号

OrderNum Object

{
    "order_num":["230411905193049009","230411902644654570","230411900549028497"]
}

Response Json

{
  "code": 0,
  "data": {
    "total": 20,
    "success": 19,
    "fail": 1,
    "msg": [
      "230809611226075618 无法操作付费票审核状态:"
    ],
    "suc_order": [
      "230809609989019104",
      "230809555984443615",
      "230809551006506008",
      "230809550990429498",
      "230809550994575336",
      "230809550978014873",
      "230809550982258989",
      "230809550986266828",
      "230809550970219936",
      "230809550974193414",
      "230809550956591377",
      "230809550962621213",
      "230809550965904030",
      "230809550947051552",
      "230809550953126573",
      "230809550934262146",
      "230809550942875247",
      "230809550930495435",
      "230809550914386110"
    ]
  }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时
suc_order 成功订单号 Array 当success大于0时

Log

日期 作者 内容
2023/05/25 朱思嘉
2023/08/10 朱思嘉 新增成功订单号字段

指派销售

HTTP Method

POST

HTTP Request

/api/guest/dispatch

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
guests 订单号 []int 嘉宾ID列表
sale 资源名称 string 销售名称

Response Json

{
  "status": 0,
  "data": {
    "total": 3,
    "success": 1,
    "fail": 2
  }
}

Response Data

Title Description Type Tips
status 接口状态 int 0成功 非0失败
data 订单数据 DataObject

Data Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int

Log

日期 作者 内容
2023/04/18 荀立强 新增

自动分配嘉宾

HTTP Method

POST

HTTP Request

/api/guest/auto_dispatch/{meeting_id}

Request Parameters Query

Request Parameters Body

Response Json

{
  "status": 0,
  "data": {
    "total": 91,
    "success": 0,
    "fail": 91
  }
}

Response Data

Title Description Type Tips
status 接口状态 int 0成功 非0失败
data 订单数据 DataObject

Data Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int

Log

日期 作者 内容
2023/04/18 荀立强 新增

获取可以批量修改字段

HTTP Method

GET

HTTP Request

/api/guest/batch_fields/{meeting_id}

Request Parameters Query

Request Parameters Body

Response Json

{
  "status": 0,
  "data": [
    "是否参加分析师大会",
    "是否参加第四届中国“芯力量”评选活动",
    "是否参加知识产权论坛暨手机中国联盟年会",
    "是否参加中国半导体投资联盟理事会",
    "是否参加是否参加大咖面对面",
    "是否参加微电子学院校企合作论坛",
    "是否参加上市公司机构交流论坛",
    "是否参加欢迎晚宴"
  ]
}

Response Data

Title Description Type Tips
status 接口状态 int 0成功 非0失败
data 订单数据 []string

Log

日期 作者 内容
2023/09/20 荀立强 新增

批量修改字段

HTTP Method

POST

HTTP Request

/api/guest/batch_modify/{meeting_id}

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
order_nums 订单号列表 []string [220510486969389162]
field 修改字段 string
value 修改值 string

Response Json

{
  "status": 0,
  "data": true
}

Response Data

Title Description Type Tips
status 接口状态 int 0成功 非0失败
data 订单数据 bool

Log

日期 作者 内容
2023/09/20 荀立强 新增

订单

发票筛选项

HTTP Method

GET

HTTP Request

/api/order/invoice/search_item

Request Parameters Query

Title Description Type Required Tips
meeting_id 会议ID integer
type 发票类型 integer -1全部
0增值税普通发票
1增值税专用发票
order_num 订单号 string
user_name 申请人姓名 string
user_phone 申请人电话 string

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 object

data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data SearchItem object

SearchItem

Title Description Type Required Tips
可筛选的key 可筛选的key []Search 可在query中使用

Search 可筛选的值

Title Description Type Required Tips
label 展示文本 string
value 可筛选值 int
num 统计数 int

Response Data Json

{
  "status": 0,
  "data": {
    "type": [
      {
        "label": "全部",
        "value": -1
      },
      {
        "label": "增值税普通发票",
        "value": 0
      },
      {
        "label": "增值税专用发票",
        "value": 1
      }
    ],
    "status": [
      {
        "label": "全部",
        "value": -1,
        "num": 639
      },
      {
        "label": "待开票",
        "value": 0,
        "num": 639
      },
      {
        "label": "已开票",
        "value": 1,
        "num": 0
      },
      {
        "label": "已取消",
        "value": 2,
        "num": 0
      },
      {
        "label": "已作废",
        "value": 3,
        "num": 0
      }
    ]
  }
}

发票列表

HTTP Method

GET

HTTP Request

/api/order/invoice/list/{meeting_id}

Request Parameters Query

Title Description Type Required Tips
type 发票类型 integer -1全部
0增值税普通发票
1增值税专用发票
status 状态 integer
order_num 订单号 string
apply_user 申请人姓名/电话 string
page 当前页码 int
limit 每页最大条数 int

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
current_page 当前页 integer
last_page 最后一页 integer
total 总条数 integer
data InvoiceObject object

Invoice

Title Description Type Required Tips
order_num 订单号 string
is_vat 是否增值税发票 string 0-否1-是
invoice_title 抬头 string
invoice_amount 金额 string
vat_name 联系人 string
vat_company_name 公司名称 string
vat_telphone 联系电话 string
status 状态 string 0 待开票 1已开票 2已取消 3已作废
create_time 申请时间 string
invoice_option 抬头类型 string 0旧数据 1个人 2企业
type 发票类型 string 0-会议发票 1-图文报告发票
is_vat_text 是否增值税发票展示文本 string 是否增值税发票
is_vat_text 发票状态展示文本 string 状态
invoice_option_text 抬头类型沾水文本 string
pay_channel_text 付款渠道 string
out_trade_num 交易号 string

Response Data Json

{
  "status": 0,
  "current_page": 1,
  "last_page": 28,
  "total": 28,
  "data": [
    {
      "id": 682,
      "order_num": "230427767836164319",
      "pay_channel": 2,
      "out_trade_num": "4200001781202304275985153952",
      "is_vat": 0,
      "invoice_title": "Hdhfhfh ",
      "invoice_amount": 0.01,
      "invoice_tax_num": "",
      "vat_mail_address": "caojm@ijiwei.com",
      "vat_name": "Hdhfhfhfh",
      "vat_company_name": "",
      "vat_company_address": "",
      "vat_company_mobile": "",
      "vat_bank_name": "",
      "vat_bank_accoun": "",
      "vat_telphone": "13810875748",
      "status": 0,
      "create_time": "2023-04-27T06:29:40.000000Z",
      "invoice_option": 1,
      "type": 0,
      "is_vat_text": "增值税普通发票",
      "status_text": "待开票",
      "invoice_option_text": "个人",
      "content_type_text": "会议发票",
      "pay_channel_text": "微信APP",
      "user_account": "小小测试",
      "invoice_content": "会议费"
    }
  ]
}

Log

日期 作者 内容
2023/05/04 荀立强 添加字段【out_trade_num、pay_channel_text】

发票导出

HTTP Method

GET

HTTP Request

/api/order/invoice/export/{meeting_id}

Request Parameters Query

Title Description Type Required Tips
type 发票类型 integer -1全部
0增值税普通发票
1增值税专用发票
status 状态 integer
order_num 订单号 string
user_name 申请人姓名 string
user_phone 申请人电话 string

Request Parameters Body

Response Data

octet-stream

发票详情

HTTP Method

GET

HTTP Request

/api/order/invoice/{id}

Request Parameters Query

Title Description Type Required Tips
type 发票类型 integer 0-会议发票 1-图文报告发票
status 状态 integer 0 待开票 1已开票 2已取消 3已作废
order_num 订单号 string
user_name 申请人 integer
phone 申请人手机号 string
meeting_id 会议ID integer

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
current_page 当前页 integer
last_page 最后一页 integer
total 总条数 integer
data InvoiceObject object

Invoice

Title Description Type Required Tips
order_num 订单号 string
is_vat 是否增值税发票 string 0-否1-是
invoice_title 抬头 string
invoice_amount 金额 string
vat_name 联系人 string
invoice_tax_num 税号 string
vat_company_name 公司名称 string
vat_company_address 公司地址 string
vat_mail_address 公司地址 string
vat_company_mobile 注册电话 string
vat_bank_name 开户银行 string
vat_bank_accoun 银行账户 string
vat_telphone 联系电话 string
status 状态 string 0 待开票 1已开票 2已取消 3已作废
create_time 申请时间 string
invoice_option 抬头类型 string 0旧数据 1个人 2企业
type 发票类型 string 0-会议发票 1-图文报告发票
user_name 发票类型 string 申请人
is_vat_text 发票类型展示文本 string 是否增值税发票
status_text 状态展示文本 string 状态
invoice_option_text 抬头类型展示文本 string

Response Data Json

{
  "status": 0,
  "data": {
    "order_num": "230320825842153249",
    "is_vat": "增值税专用发票",
    "invoice_title": "北京地平线机器人技术研发有限公司",
    "invoice_amount": 0.01,
    "vat_name": "小小",
    "invoice_tax_num": "911101083443783306",
    "vat_company_name": "啊u吧",
    "vat_company_address": "啊是的啊",
    "vat_mail_address": "caojm@ijiwei.com",
    "vat_company_mobile": "13810875748",
    "vat_bank_name": "奥萨",
    "vat_bank_accoun": "阿斯顿",
    "vat_telphone": "13810875748",
    "status": 0,
    "create_time": "2023-03-20T03:23:04.000000Z",
    "invoice_option": 2,
    "type": 0,
    "user_name": "",
    "status_text": "待开票",
    "invoice_option_text": "企业"
  }
}

订单筛选项

HTTP Method

GET

HTTP Request

/api/order/search_item

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 object

data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data SearchItem object

SearchItem

Title Description Type Required Tips
可筛选的key 可筛选的key []Search 可在query中使用

Search 可筛选的值

Title Description Type Required Tips
label 展示文本 string
value 可筛选值 int
num 统计数 int

Response Data Json

{
  "status": 0,
  "data": {
    "status": [
      {
        "label": "已删除",
        "value": 0,
        "num": 1261
      },
      {
        "label": "已支付",
        "value": 1,
        "num": 32606
      },
      {
        "label": "待支付",
        "value": 2,
        "num": 159
      },
      {
        "label": "退票失败",
        "value": 3,
        "num": 0
      },
      {
        "label": "已退票",
        "value": 4,
        "num": 11
      },
      {
        "label": "退票中",
        "value": 5,
        "num": 9
      },
      {
        "label": "待评价",
        "value": 6,
        "num": 152
      },
      {
        "label": "已完成",
        "value": 7,
        "num": 124
      },
      {
        "label": "已过期",
        "value": 8,
        "num": 2932
      },
      {
        "label": "支付超时",
        "value": 9,
        "num": 706
      },
      {
        "label": "支付失败",
        "value": 10,
        "num": 0
      }
    ]
  }
}

收入统计

HTTP Method

GET

HTTP Request

/api/order/income_count/{meeting_id}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 object

data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data SearchItem object

SearchItem

Title Description Type Required Tips
可筛选的key 可筛选的key []Search 可在query中使用

Search 可筛选的值

Title Description Type Required Tips
label 展示文本 string
value 可筛选值 int
num 统计数 int

Response Data Json

{
  "status": 0,
  "data": [
    {
      "label": "总收入",
      "value": -1,
      "num": 12
    },
    {
      "label": "支付宝",
      "value": 1,
      "num": 4
    },
    {
      "label": "微信APP",
      "value": 2,
      "num": 8
    }
  ]
}

订单列表

HTTP Method

GET

HTTP Request

/api/order/{meeting_id}

Request Parameters Query

Title Description Type Required Tips
buy_user 发票类型 integer 购买人(支持手机号/用户名)
status 状态 integer 1待参加,2待支付,3退票失败,4已退票,5退票中,6待评价,7已完成,8已过期,9支付已超时,10支付失败
order_num 订单号 string 订单号
out_trade_num 申请人 integer 交易号
created_at 下单时间 [string, string]
payment_time 付款时间 [string, string]
ids ID列表 [id]

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 object

data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data []OrderInfo array

OrderInfo

Title Description Type Required Tips
order_num 订单号 string
create_time 下单时间 int
status 订单状态 int 0删除,1待参加,2待支付,3退票失败,4已退票,5退票中,6待评价,7已完成,8已过期,9支付已超时,10支付失败
total 总金额:单位元 float
pay_channel 付款渠道编号 int 0未支付,1支付宝,2微信APP支付,3银行卡,4微信JSAPI支付,5微信NATIVE支付,6无需支付,7线下支付 ,8浏览器H5支付
payment_time 付款时间 int
is_refund 是否允许退款 int 1允许 2不允许
out_trade_num 第三方订单号 int
is_refund_text 是否允许退款展示文本 int
status_text 状态展示文本 int
pay_channel_text 付款渠道展示文本 int
user Userobject int 付款人信息

User

Title Description Type Required Tips
id 付款人ID string
nickname 付款人名称 int

Response Data Json

{
  "status": 0,
  "data": {
    "current_page": 1,
    "last_page": 125,
    "total": 250,
    "data": [
      {
        "id": 41597,
        "order_num": "230202066012850134",
        "create_time": 1675306601,
        "user_id": 5181749,
        "status": 0,
        "total": 0,
        "pay_channel": 6,
        "payment_time": 1675306601,
        "is_refund": 1,
        "out_trade_num": "",
        "is_refund_text": "允许",
        "status_text": "已删除",
        "pay_channel_text": "无需支付",
        "user": {
          "id": 5181749,
          "nickname": "朱思嘉"
        }
      },
      {
        "id": 41598,
        "order_num": "202302021675320487",
        "create_time": 1675320488,
        "user_id": 5181749,
        "status": 1,
        "total": 0,
        "pay_channel": 6,
        "payment_time": 0,
        "is_refund": 0,
        "out_trade_num": "",
        "is_refund_text": "-",
        "status_text": "已支付",
        "pay_channel_text": "无需支付",
        "user": {
          "id": 5181749,
          "nickname": "朱思嘉"
        }
      }
    ]
  }
}

订单导出

HTTP Method

GET

HTTP Request

/api/order/export/{meeting_id}

Request Parameters Query

Title Description Type Required Tips
buy_user 发票类型 integer 购买人(支持手机号/用户名)
status 状态 integer 1待参加,2待支付,3退票失败,4已退票,5退票中,6待评价,7已完成,8已过期,9支付已超时,10支付失败
order_num 订单号 string 订单号
out_trade_num 申请人 integer 交易号
created_at 下单时间 [string, string]
payment_time 付款时间 [string, string]
ids ID列表 [id]

Request Parameters Body

Response Data

octet-stream

单个或批量审核参会信息

HTTP Method

PUT

HTTP Request

/api/v0/order/review

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 Object
out 是否拒绝 Int 0-否 1-是 default=0

OrderNum Object

{
    "order_num":["230227893699866597","344434"],
    "out":1 
}

Response Json

{
    "code": 0,
    "data": {
        "total": 2,
        "success": 1,
        "fail": 1,
        "msg": [
            "132230227829549607144 未找到相关报名信息"
        ]
    }
}

Response Data

Title Description Type Tips
date 订单数据 Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2023/04/06 朱思嘉

基础设施 basic

获取当前登录用户的权限相关配置信息

AVAILABLE_PERMISSION_BEHAVIOR

获取当前用户的权限集合

curl --request GET \
   --url  '${API_HOST}/api/basic/behaviors' \
   --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImZvcmZvcm0ifQ.eyJpc3MiOiJmb3Jmb3JtIiwic3ViIjoic2RrIiwiaWRlbnQiOiI1YzRlODQ0OTE2NGQ0YmUzODgxNTM4MjhhYjg1NjFkMyIsImlhdCI6MTY4MDI0OTk0MywiZXhwIjoxNjgwODU0NzQzLCJhcHBfaWQiOjEsInJlYWQiOjEsIndyaXRlIjoxfQ.lHh60JBubCVCdSVwa2QOjx5nYyhc_PkYcmmyDq1VIcY' \
   --header 'Content-Type: application/json' \ | jq
{
  "status": 0,
  "modules": [
    {
      "name": "guest",
      "label": "嘉宾管理",
      "permissions": [
        {
          "name": "sales_assign_one",
          "label": "协同销售指定"
        },
        {
          "name": "sales_assign_rand",
          "label": "协同销售自动分配"
        },
        {
          "name": "guest_import",
          "label": "嘉宾导入"
        }
      ],
      "show": true
    },
    {
      "name": "guest",
      "label": "订单管理",
      "permissions": [],
      "show": false
    },
    {
      "name": "invoice",
      "label": "发票管理",
      "permissions": [],
      "show": false
    },
    {
      "name": "sync",
      "label": "同步管理",
      "permissions": [],
      "show": false
    }
  ],
  "user_info": {
    "oa_user_name": "易初",
    "level": 1
  }
}

HTTP Method

GET

HTTP Request

/api/basic/behaviors

Request Parameters Body

暂无

Request Parameters Query

Response Data

Title Type Description Tips
status int 状态 0 正常 1为失败
modules List[Module] Module 组件列表
user_info UserInfo 用户基础信息

Module

Title Description Type Tips
name string 模块名称
label string 注释(一般为中文)
permissions Permission Object 使用方
show bool 是否显示

Permission

Title Description Type Tips
name string 权限名称
label string 注释(一般为中文)

UserInfo

Title Description Type Tips
oa_user_name string 用户鉴权用姓名
level int 用户等级 Enum枚举类型1,2,3 ...

Modules&Permissions Info

Module

Name Label Min Level Tips
guest 嘉宾管理 3
order 订单管理 1
invoice 发票管理 1
sync 同步管理 1

嘉宾管理 Guest Module Permission

Name Label Min Level Tips
guest_search 嘉宾管理 3 需要提供额外的s=base64(${user_info.oa_user_name}) 确定搜索范围
guest_export 嘉宾范围导出 3 需要提供额外的s=base64(${user_info.oa_user_name}) 确定导出范围
guest_import 嘉宾范围导入 1 需要提供额外的s=base64(${user_info.oa_user_name}) 用于将导入人员直接绑定当前操作人
guest_school_info_export 嘉宾校友会信息导出 1
assign_sales 协同销售分配 2
rand_assign_sales 协同销售随机分配 1
guest_audit 嘉宾审核 1
guest_add 嘉宾新增 1
guest_delete 嘉宾删除 1
guest_backout 嘉宾删除恢复 1
guest_attribute_update 嘉宾额外属性更新 1
assign_group 指派加入特定群组(晚宴) 2

订单管理 Order Module Permission

Name Label Min Level Tips
order_search 订单搜索 1 临时填充,当前版本无实际作用

发票管理 Invoice Module Permission

Name Label Min Level Tips
invoice_search 发票搜索 1 临时填充,当前版本无实际作用

同步管理 sync Module Permission

Name Label Min Level Tips
sync_guest 同步 1 临时填充,当前版本无实际作用

协同操作 assign Module Permission

Name Label Min Level Tips
assign 协同列表 1 临时填充,当前版本无实际作用

Log

日期 作者 内容
2023/04/04 谢宇轩 新增
2023/04/010 谢宇轩 修订字段

销售列表

HTTP Method

GET

HTTP Request

/api/basic/sales

Request Parameters Query

暂无

Request Parameters Body

暂无

Response Json

{
    "status":0,
    "data":[
        {
            "name":"俞思思",
            "member":[
                {
                    "name":"廖鹏程"
                },
                {
                    "name":"丁宣贵"
                }
            ]
        },
        {
            "name":"邢雪松",
            "member":[
                {
                    "name":"林鸿(泓宇)"
                },
                {
                    "name":"陈桂爱"
                },
                {
                    "name":"贾仲婷"
                },
                {
                    "name":"王济君"
                },
                {
                    "name":"高尚"
                },
                {
                    "name":"刘佳炀"
                },
                {
                    "name":"王仕龙"
                },
                {
                    "name":"蒋鹏"
                },
                {
                    "name":"杨琛君"
                },
                {
                    "name":"陈杰"
                },
                {
                    "name":"彭斌"
                },
                {
                    "name":"龚杨梅"
                },
                {
                    "name":"张天楷"
                },
                {
                    "name":"李浩"
                },
                {
                    "name":"王震"
                }
            ]
        },
        {
            "name":"陈荣",
            "member":[
                {
                    "name":"王建伟"
                },
                {
                    "name":"柏丽娜"
                },
                {
                    "name":"乔赟"
                },
                {
                    "name":"刘真良"
                },
                {
                    "name":"刘美娜"
                },
                {
                    "name":"兰玲玲"
                }
            ]
        },
        {
            "name":"徐伦",
            "member":[
                {
                    "name":"汤瑞玲"
                },
                {
                    "name":"李凯悦"
                },
                {
                    "name":"蒙瑞清"
                },
                {
                    "name":"王何"
                }
            ]
        }
    ]
}

Response Data

Title Description Type Tips
date 销售成员数据 Sales Object

Sales Object

Title Description Type Tips
name 主管销售名称 String
member 二级销售成员 Array Object 可能没有这个字段

Log

日期 作者 内容
2023/04/10 朱思嘉
2023/04/10 谢宇轩 修改格式定义

销售客户关系导入

HTTP Method

POST

HTTP Request

/api/basic/sales/customer/xls

Request Parameters Query

暂无

Request Parameters Body

Title Description Type Required Tips
upload 文件 File

Response Json

{
  "status": 0,
  "tree": {
    "total": 61,
    "success": 61,
    "fail": 0,
    "msg": []
  }
}

Response Data

Title Description Type Tips
date 销售成员数据 Sales Object

Date Object

Title Description Type Tips
total 总数 Int
success 成功数 Int
fail 失败数 Int
msg 失败原因 Array 当fail大于0时

Log

日期 作者 内容
2024/6/21 朱思嘉

座位

添加桌号

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
table_num 桌数 int 最大值为100
seat_num 每桌人数 int 最大没限制

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool
{
    "status": 0,
    "data": true
}

获取桌子详情

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/table/{table_number}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 Tableobject

Table

Title Description Type Required Tips
meeting_id 会议ID integer
seat 座位数 int
be_seated 入座人数 int
number 桌子序号 int
is_lock 是否锁定 int 0否 1是
is_main 是否是主桌 int 0否 1是
{
  "status": 0,
  "data": {
    "meeting_id": 2590082,
    "seat": 35,
    "be_seated": 0,
    "number": 1,
    "is_lock": 0,
    "is_main": 0
  }
}

桌子列表

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/table

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data Data object

Data

Title Description Type Required Tips
table_count 桌子情况统计 TableCount
attendee_seating_count 嘉宾入座情况统计 AttendeeSeatingCount
current_page 当前页 int
last_page 最后一页 int
total 总条数 int
list 桌子列表 List

TableCount

Title Description Type Required Tips
table_num 总桌数 int
vacancy 空座位数 int
all_seat_num 座位总数 int
seating_num 已入座人数 int

AttendeeSeatingCount

Title Description Type Required Tips
attendee_num 晚宴嘉宾总数 int
has_seat 已入座人数 int
no_seat 未入座人数 int

List 桌子详情

Title Description Type Required Tips
id 桌子ID int
seat 座位数 int
be_seated 已入座人数 int
number 桌子序号 int
is_lock 是否锁定 int 0否 1是
is_main 是否为主桌 int 0否 1是
version 桌号版本 string

Response Data Json

{
  "status": 0,
  "data": {
    "table_count": {
      "table_num": 236,
      "vacancy": "10359",
      "all_seat_num": "10363",
      "seating_num": "4"
    },
    "attendee_seating_count": {
      "attendee_num": 121,
      "has_seat": "4",
      "no_seat": "117"
    },
    "list": [
      {
        "id": 1,
        "seat": 10,
        "be_seated": 4,
        "number": 1,
        "is_lock": 0,
        "is_main": 0,
        "version": "1ac6d8f71f8654ce2bc09d2fb8f00606"
      },
      {
        "id": 2,
        "seat": 2,
        "be_seated": 0,
        "number": 2,
        "is_lock": 1,
        "is_main": 1,
        "version": "c81e728d9d4c2f636f067f89cc14862c"
      }
    ]
  }
}

添加座位

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/seat

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
num 增加座位数(可以为负数) int

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

锁定桌号

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/lock

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
is_lock 锁定标识 int 0解锁 1锁定

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

设为主桌

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/main

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
is_main 主桌 int 0否 1是

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

一键入座

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/quick_seating

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

一键恢复(暂时不做)

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/restore

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
id 桌子ID int
is_main 主桌 int 0否 1是

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

一键清除所有桌嘉宾

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/clear

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

一键清除当前桌嘉宾

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/clear

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
delete 是否删除桌 integer 设置该参数即可,值为不为null的任意值,且该参数只能在最后一桌使用

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

分配座位

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/arrange_seat

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 int
version 当前桌版本号 string
number 桌号 int
force 强制分配 bool 否,桌满后无法分配, 是,桌满后可以继续入座,默认否

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

桌子中嘉宾详情

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/attendee

Request Parameters Query

Title Description Type Required Tips
page 当前页 int
limit 每页条数 int
search 搜索关键字 string
order 排序字段 string 可选值:【before_sitetable_number】默认按table_number正序
order_type 排序方式 string 可选值【ASCDESC】,默认:ASC

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 Data[]

Data

Title Description Type Required Tips
id 嘉宾ID integer
attribute 是否参加晚宴 int 1是
before_site 上届桌号 string
table_number 本届桌号 int
table_number_text 格式化本届桌号 string
order_num 订单号 string
name 嘉宾名称 string
phone 嘉宾手机号 string
company 公司 string
job 职务 string
{
  "status": 0,
  "data": {
    "version": "1ac6d8f71f8654ce2bc09d2fb8f00606",
    "current_page": 1,
    "last_page": 46,
    "total": 92,
    "data": [
      {
        "id": 16549,
        "attribute": 1,
        "site": "",
        "order_num": "230404004481565319",
        "name": "朱思嘉0505",
        "phone": "18434819907",
        "before_site": "桌号:!",
        "company": "",
        "job": ""
      },
      {
        "id": 16549,
        "attribute": 1,
        "site": "",
        "order_num": "230404004481565319",
        "name": "朱思嘉0505",
        "phone": "18434819907",
        "before_site": "桌号:!",
        "company": "",
        "job": ""
      }
    ]
  }
}

更新当前桌的人

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/save_attendee

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
order_num 订单列表 []string
version 桌号版本 string

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 []Data

Data

Title Description Type Required Tips
version 更新后的桌号版本 string
{
  "status": 0,
  "data": {
    "version": "1ac6d8f71f8654ce2bc09d2fb8f00606"
  }
}

将嘉宾移除该桌

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/{table_id}/remove_attendee

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 int

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 bool

本届参加晚宴的嘉宾

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/search_guest

Request Parameters Query

Title Description Type Required Tips
page 当前页 int
limit 每页条数 int
search 搜索关键字 string
order 排序字段 string 可选值:【before_sitetable_number】默认按table_number正序
order_type 排序方式 string 可选值【ASCDESC】,默认:ASC

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 integer
data 数据详情 Data[]

Data

Title Description Type Required Tips
current_page 当前页 integer
last_page 最后一页 integer
total 总条数 integer
before_site_count 往届人数 integer
data 数据列表 Data[]

List

Title Description Type Required Tips
id 嘉宾ID integer
attribute 是否参加晚宴 int 1是
before_site 上届桌号 string
table_number 本届桌号 int
table_id 桌子ID int
table_number_text 格式化本届桌号 string
order_num 订单号 string
name 嘉宾名称 string
phone 嘉宾手机号 string
company 公司 string
job 职务 string
{
  "status": 0,
  "data": {
    "current_page": 1,
    "last_page": 46,
    "total": 92,
    "before_site_count": 16,
    "data": [
      {
        "id": 16549,
        "attribute": 1,
        "site": "",
        "order_num": "230404004481565319",
        "name": "朱思嘉0505",
        "phone": "18434819907",
        "before_site": "桌号:!",
        "company": "",
        "job": ""
      },
      {
        "id": 16549,
        "attribute": 1,
        "site": "",
        "order_num": "230404004481565319",
        "name": "朱思嘉0505",
        "phone": "18434819907",
        "before_site": "桌号:!",
        "company": "",
        "job": ""
      }
    ]
  }
}

导出本届参加晚宴的嘉宾

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/export_guest

Request Parameters Query

Title Description Type Required Tips
page 当前页 int
limit 每页条数 int
search 搜索关键字 string
order 排序字段 string 可选值:【before_sitetable_number】默认按table_number正序
order_type 排序方式 string 可选值【ASCDESC】,默认:ASC

Request Parameters Body

Response Data

octet-stream

上传晚宴图

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table_map

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
customer_uniq_key 用户自定义key string 用来检索文件信息
ext string 文件后缀
fname string 文件名称
fsize int 文件大小
key string 文件唯一标识
link 访问地址

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data File

File

Title Description Type Required Tips
customer_uniq_key 用户自定义key string 用来检索文件信息
ext string 文件后缀
fname string 文件名称
fsize int 文件大小
key string 文件唯一标识
link 访问地址
{
  "status": 0,
  "data": {
    "customer_uniq_key": "1230101122348asd4",
    "ext": ".json",
    "fname": "2.json",
    "fsize": "4351613",
    "key": "lpEdgEptee_tRqchC-NIFHgCY1f2",
    "link": "http://s.laoyaoba.com/lpEdgEptee_tRqchC-NIFHgCY1f2"
  }
}

获取晚宴图列表

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/table_map

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data []File

File

Title Description Type Required Tips
customer_uniq_key 用户自定义key string 用来检索文件信息
ext string 文件后缀
fname string 文件名称
fsize int 文件大小
key string 文件唯一标识
link 访问地址
{
    "status": 0,
    "data": [
        {
            "customer_uniq_key": "1230101122348asd4",
            "ext": ".json",
            "fname": "1.json",
            "fsize": "4351613",
            "key": "lpEdgEptee_tRqchC-NIFHgCY1f2",
            "link": "http://s.laoyaoba.com/lpEdgEptee_tRqchC-NIFHgCY1f2"
        }
    ]
}

删除晚宴图

HTTP Method

DELETE

HTTP Request

/api/meeting/{meeting_id}/table_map

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
index 索引位置 int

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data bool
{
  "status": 0,
  "data": true
}

获取会议最大桌号

HTTP Method

GET

HTTP Request

/api/meeting/{meeting_id}/max_table_number

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data int 最大桌号,没有时为0
{
  "status": 0,
  "data": 1
}

换桌

HTTP Method

POST

HTTP Request

/api/meeting/{meeting_id}/table/exchange

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
old_table 旧桌号 int
new_table 新桌号 int
order_num 嘉宾订单号 string
force 强制入座 bool 默认否,表示座位已满无法入座

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data 成功标识 bool true成功 false 失败
{
  "status": 0,
  "data": true
}

微信

生成二维码

HTTP Method

POST

HTTP Request

/api/wechat/qrcode

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
expire_seconds 二维码有效时间,以秒为单位 int default=604800
action_name 二维码类型 string default=QR_STR_SCENE QR_SCENE为临时的整型参数值,QR_STR_SCENE为临时的字符串参数值,(临时二维码后端会根据来源参数进行7天有效期缓存)QR_LIMIT_SCENE为永久的整型参数值,QR_LIMIT_STR_SCENE为永久的字符串参数值
scense_key 场景值 | string default=local_test case:scense_key=pc scense_key=h5 scense_key=ios

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object

Data object

Title Description Type Tips
ticket 获取的二维码ticket,凭借此ticket可以在有效时间内换取二维码。 string
expire_seconds 该二维码有效时间,以秒为单位。 int
url 二维码图地址 string
{
  "status": 0,
  "data": {
    "ticket": "gQH07zwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyaGZweWh0SzNmckQxU25KYk5BY0UAAgQXM8JkAwSAOgkA",
    "expire_seconds": 604800,
    "url": "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=gQH07zwAAAAAAAAAAS5odHRwOi8vd2VpeGluLnFxLmNvbS9xLzAyaGZweWh0SzNmckQxU25KYk5BY0UAAgQXM8JkAwSAOgkA"
  }
}

Log

日期 作者 内容
2023/07/28 朱思嘉 新增

获取scheme码

适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景 每个独立的URL Scheme被用户访问后,仅此用户可以再次访问并打开对应小程序,其他用户无法再次通过相同URL Scheme打开该小程序.

HTTP Method

POST

HTTP Request

/api/wechat/scheme

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
path 小程序页面路径 string
query 进入小程序时的携带参数 string default:source=wechat
open_id 用户凭据 | string
env_version 版本 | string default:release 要打开的小程序版本。正式版为"release",体验版为"trial",开发版为"develop",仅在微信外打开时生效。
expire_interval 过期时间/天 | string default=1 当open_id不为空时default=10

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object

Data object

Title Description Type Tips
link 生成的小程序 scheme 码 string
{
  "status": 0,
  "data": {
    "link": "weixin://dl/business/?t=lm1AI7TdSGk"
  }
}

获取JSDK

适用于获取微信JSDK 此接口只针对线上地址的调用 如果线上线下同时调用会导致access_token失效

HTTP Method

GET

HTTP Request

/api/wechat/jsdk

Request Parameters Query

Title Description Type Required Tips
url 页面路由 string
js_api_list 需要使用的JS接口列表 string default:[] js_api_list=onMenuShareAppMessage,onMenuShareTimeline
open_tag_list JS开发标签 | string default:[] open_tag_list=onMenuShareAppMessage,onMenuShareTimeline
debug 调试模式| int default:false

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object

Data object

Title Description Type Tips
jsApiList JS列表API array
openTagList JS开发标签 array
debug 调试模式 Bool
url 传入的url信息 string
nonceStr 签名的随机字符串 string
timestamp 生成签名的时间戳 string
appId 公众号标识 string
signature 签名 string
{
  "status": 0,
  "data": {
    "jsApiList": [
      "onMenuShareAppMessage",
      "onMenuShareTimeline"
    ],
    "openTagList": [
      "onMenuShareAppMessage"
    ],
    "debug": false,
    "url": "https://www.laoyaoba.com",
    "nonceStr": "Vcoa5gCIDGQiKHZV",
    "timestamp": 1691650802,
    "appId": "wxc97be07d22a3eeea",
    "signature": "afc62a57b5088b9a82ec34060d663c1745f7eea3"
  }
}

开放平台账户

HTTP Method

GET

HTTP Request

/api/wechat/platform

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object
page 页码 int
limit 个数 int

Data object

Title Description Type Tips
id 平台ID int platform_id
name 标题 string
description 描述 string
app_id app_id string
app_secret app_secret string
{
  "status": 0,
  "data": [
    {
      "id": 1,
      "name": "爱集微APP",
      "description": "爱集微APP服务号",
      "app_id": "wxc97be07d22a3eeea",
      "app_secret": "96ddd3da003b5fa40ef01253c65f1b5b"
    }
  ]
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

用户

HTTP Method

GET

HTTP Request

/api/wechat/user

Request Parameters Query

Title Description Type Required Tips
platform_id 开放平台账户ID string
tag 搜索标签 string
account 集微账户搜索 string
page 页码 int default=1
limit 个数 int default=15

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
current_page 当前页码 integer
last_page 最大页码 integer
per_page 每页条数 integer
total 总数 integer
data 数据详情 Object

Data object

Title Description Type Tips
user 用户基础信息 object
tag tag标签信息 array
status 0-已关注 1-未关注 int
created_at 创建时间 string
updated_at 更新时间 string

User object

Title Description Type Tips
id 用户ID int
name 用户昵称 string
open_id openID string
{
  "status": 0,
  "data": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 5,
    "data": [
      {
        "id": 9,
        "user": {
          "id": 5181880,
          "name": "hanee",
          "open_id": "oDupf6sZrGttNOoNwu4TwjiamjtE"
        },
        "tag": [
          "2023汽车峰会",
          "2023汽车峰会1"
        ],
        "status": 0,
        "created_at": "2023-08-09 15:00:18",
        "updated_at": "2023-08-09 15:00:18"
      },
      {
        "id": 15,
        "user": {
          "id": 5182187,
          "name": "N_136****6427",
          "open_id": "oDupf6lj-WHsHD3mo7B9gUb2qYEk"
        },
        "tag": [
          "2023汽车峰会"
        ],
        "status": 0,
        "created_at": "2023-08-16 14:01:20",
        "updated_at": "2023-08-22 09:46:36"
      },
      {
        "id": 16,
        "user": {
          "id": 5184960,
          "name": "N_185****6427",
          "open_id": "oDupf6lj-WHsHD3mo7B9gUb2qYEk"
        },
        "tag": [],
        "status": 0,
        "created_at": "2023-08-16 14:12:13",
        "updated_at": "2023-08-16 14:12:13"
      },
      {
        "id": 18,
        "user": {
          "id": 5182458,
          "name": "小小测试环境",
          "open_id": "oDupf6g7R4JcxcfF-3xrnmk6cfJ4"
        },
        "tag": [],
        "status": 0,
        "created_at": "2023-08-18 13:59:52",
        "updated_at": "2023-08-21 10:25:21"
      },
      {
        "id": 19,
        "user": {
          "id": 5182458,
          "name": "小小测试环境",
          "open_id": "oDupf6sHXzKV0ybIoyUsB-JKK8Mk"
        },
        "tag": [],
        "status": 0,
        "created_at": "2023-08-22 17:42:30",
        "updated_at": "2023-08-22 18:21:39"
      }
    ]
  }
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

标签

HTTP Method

GET

HTTP Request

/api/wechat/tag

Request Parameters Query

Title Description Type Required Tips
platform_id 开放平台账户ID string
tag 搜索标签 string
page 页码 int default=1
limit 个数 int default=15

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
current_page 当前页码 integer
last_page 最大页码 integer
per_page 每页条数 integer
total 总数 integer
data 数据详情 Object

Data object

Title Description Type Tips
id id int tag_id
title 标题 array
created_at 创建时间 string
updated_at 更新时间 string
count 应用数量 int
meeting 会议信息 object

Meeting object

Title Description Type Tips
id 会议ID int
title 标题 string
{
  "status": 0,
  "data": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 2,
    "data": [
      {
        "id": 1,
        "title": "2023汽车峰会",
        "created_at": "2023-08-29 11:25:08",
        "updated_at": "2023-08-29 11:25:10",
        "count": 3,
        "meeting": {
          "id": 2590111,
          "titie": "2023 汽车半导体生态峰会暨全球汽车电子博览会"
        }
      },
      {
        "id": 2,
        "title": "2023汽车峰会1",
        "created_at": "2023-08-31 11:43:52",
        "updated_at": "2023-08-31 11:43:54",
        "count": 1,
        "meeting": {
          "id": 2590111,
          "titie": "2023 汽车半导体生态峰会暨全球汽车电子博览会"
        }
      }
    ]
  }
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

新增标签

HTTP Method

POST

HTTP Request

/api/wechat/tag

Request Parameters Query

Title Description Type Required Tips
title 标签名称 string
platform_id 平台ID int
meeting_id 会议ID int

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 标签ID int tag_id
{
  "status": 0,
  "data": 1
}

Error Response Data

HTTP CODE 409

{
  "status": 1,
  "errors": "标签已存在"
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

通知模版

HTTP Method

GET

HTTP Request

/api/wechat/notice

Request Parameters Query

Title Description Type Required Tips
tag_id 标签ID int
page 页码 int default=1
limit 个数 int default=10

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object

Data object

Title Description Type Tips
id id int event_id
touch_title 模版触发状态 string
template_title 模版标题 string
event_type 触发方式 int 0-自动 1-手动
link 跳转链接地址 string
created_at 创建时间 string
updated_at 更新时间 string
{
  "status": 0,
  "data": [
    {
      "id": 1,
      "touch_title": "报名成功",
      "template_title": "报名成功通知",
      "event_type": 0,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 10:56:39",
      "updated_at": "2023-08-29 10:56:41"
    },
    {
      "id": 2,
      "touch_title": "待审核",
      "template_title": "待审核通知",
      "event_type": 0,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 10:58:09",
      "updated_at": "2023-08-29 10:58:12"
    },
    {
      "id": 3,
      "touch_title": "审核成功",
      "template_title": "审核通过通知",
      "event_type": 0,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 10:58:37",
      "updated_at": "2023-08-29 10:58:39"
    },
    {
      "id": 4,
      "touch_title": "审核失败",
      "template_title": "审核拒绝通知",
      "event_type": 0,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 10:59:05",
      "updated_at": "2023-08-29 10:59:06"
    },
    {
      "id": 7,
      "touch_title": "晚宴",
      "template_title": "会议议程通知",
      "event_type": 1,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 11:01:45",
      "updated_at": "2023-08-29 11:01:47"
    },
    {
      "id": 8,
      "touch_title": "议程",
      "template_title": "会议晚宴通知",
      "event_type": 1,
      "link": "https://www.laoyaoba.com",
      "created_at": "2023-08-29 11:02:09",
      "updated_at": "2023-08-29 11:02:11"
    }
  ]
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

模版记录

HTTP Method

GET

HTTP Request

api/wechat/notice/record

Request Parameters Query

Title Description Type Required Tips
event_id 通知事件ID int
page 页码 int default=1
limit 个数 int default=10

Request Parameters Body

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data 数据详情 Object

Data object

Title Description Type Tips
id id int
user 用户信息 object
attend 参会信息 object
status 0-成功 1-失败 int
remark 错误原因 string
created_at 创建时间 string

User object

Title Description Type Tips
name 用户昵称 string
open_id openID string

Attend object

Title Description Type Tips
name 参会人姓名 string
phone 电话 string
{
  "status": 0,
  "data": [
    {
      "id": 1,
      "user": {
        "open_id": "oLkPb52HGRXU61_Y_ULpMtq99Vpc",
        "name": "朱思嘉"
      },
      "attend": {
        "name": "朱思嘉-test",
        "phone": "18434819907"
      },
      "status": 0,
      "remark": "发送成功",
      "created_at": "2023-01-01 00:00:00"
    },
    {
      "id": 2,
      "user": {
        "open_id": "oLkPb52HGRXU61_Y_ULpMtq99Vpc",
        "name": "朱思嘉2"
      },
      "attend": {
        "name": "朱思嘉-test1",
        "phone": "18434819907"
      },
      "status": 1,
      "remark": "发送失败 权限不足",
      "created_at": "2023-01-01 00:00:00"
    }
  ]
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增

推送通知

HTTP Method

POST

HTTP Request

/api/wechat/notice/send

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
event_id 通知事件ID int
tag_id 标签ID int

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data ok string 此处无需判断data返回信息

Data object

Title Description Type Tips
total 任务数 int
time 预计耗时 int 单位/分
{
  "status": 0,
  "data": {
    "total": 1,
    "time": 1
  }
}

Log

日期 作者 内容
2023/08/30 朱思嘉 新增
2023/09/05 朱思嘉 修改返回参数

模版任务触发

HTTP Method

POST

HTTP Request

/api/wechat/notice/task

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
order_num 订单号 string
user_id 用户ID int
meeting_id 会议ID int
event_code 触发code string apply_suc-报名成功 review-待审核 review_suc-审核成功 review_err-审核失败 wait_pay-等待支付 out_pay-支付超时 dinner-晚宴 agenda-议程
platform_id 微信开放平台ID int

Response Data

Title Description Type Tips
status 状态:0成功 非0失败 integer
data ok string 此处无需判断data返回信息

Data object

Title Description Type Tips
total 任务数 int
time 预计耗时 int 单位/分
{
  "status": 0,
  "data": {
    "total": 1,
    "time": 1
  }
}

Log

日期 作者 内容
2023/09/05 朱思嘉 新增

座位V2

注意: meetingplace问题兼容,提供统一接口查询座位号,兼容签到和峰会宝

进入编辑状态✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/lock

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
source 锁来源:0桌位设置 1大表格 int 默认:0

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 失败原因 string

退出编辑状态✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/unlock

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
source 锁来源:0桌位设置 1大表格 int 默认:0

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 失败原因 string

获取工作区的锁信息✅

HTTP Method

GET

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/lock

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 锁信息 Data

Data

Title Description Type Required Tips
ident 锁唯一标识 string
source 锁来源 int
name 姓名 string

Response Json

{
    "status": 0,
    "data": {
        "ident": "42bf54912afd46dfa10a4aa174fcfd11",
        "source": 0,
        "name": "郭阔"
    }
}

参加晚宴未入座嘉宾列表✅

HTTP Method

GET

HTTP Request

/api/v2/meeting/{meeting_id}/{agenda_id}/search_guest

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 Data[]

Data

Title Description Type Required Tips
summary 当前页 Summary
list 最后一页 Data[]

Summary

Title Description Type Required Tips
attendee_num 嘉宾总数 int
has_seat 入座人数 string
no_seat 未入座人数 string

Data

Title Description Type Required Tips
id 嘉宾ID int
order_num 订单号 string
name 嘉宾名称 string
phone 嘉宾手机号 string
company 公司 string
job 职务 string
sell 负责销售名称 string
is_candidate_area 是否在待选区 bool false 否 true 是
{
  "status": 0,
  "data": {
    "summary": {
      "attendee_num": 20,
      "has_seat": "0",
      "no_seat": "20"
    },
    "list": [
      {
        "id": 15648,
        "order_num": "220927583746757056",
        "name": "哦婆婆",
        "phone": "13121676702",
        "before_site": "",
        "sell": "",
        "company": null,
        "job": "银色",
        "is_candidate_area": true
      },
      {
        "id": 15649,
        "order_num": "220927587332943893",
        "name": "朱思嘉",
        "phone": "18434819907",
        "before_site": "",
        "sell": "",
        "company": null,
        "job": "php",
        "is_candidate_area": false
      }
    ]
  }
}

销售列表✅

用v1接口即可

生成排桌✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/generate

Request Parameters Query

Request Parameters Body

Body -> []Data

[
  {
    "id": 1,
    "rows": 1,
    "number": 1,
    "be_seated": 1
  },
  {
    "id": 1,
    "rows": 1,
    "number": 2,
    "be_seated": 5
  }
]

Data

Title Description Type Required Tips
id int 桌子ID
rows int 几排
number int 几桌
be_seated int 落座人数

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool
{
    "status": 0,
    "data": true
}

桌子列表🆕

HTTP Method

GET

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data Data object

Data

Title Description Type Required Tips
current_page 当前页 int
last_page 最后一页 int
total 总条数 int
list 桌子列表 List

List 桌子详情

Title Description Type Required Tips
id 桌子ID int
rows 几排 int
number 桌子序号 int
seat 座位数 int
be_seated 已入座人数 int
is_lock 是否有桌号锁 int

Response Data Json

{
  "status": 0,
  "data": {
    "table_count": {
      "table_num": 236,
      "vacancy": 10359,
      "all_seat_num": 10363,
      "seating_num": 4,
      "rows": 10
    },
    "list": [
      {
        "id": 1,
        "rows": 1,
        "number": 1,
        "seat": 10,
        "be_seated": 4,
        "is_lock": 0
      },
      {
        "id": 2,
        "rows": 1,
        "number": 1,
        "seat": 2,
        "be_seated": 0,
        "is_lock": 0
      }
    ]
  }
}

分配座位✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/arrange_seat

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
attendee_id 嘉宾ID int
table_number 桌号 int
force 强制分配 bool 否,桌满后无法分配, 是,桌满后可以继续入座,默认否

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool

清空桌上的人✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/{table_number}/clear

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool

桌中嘉宾列表✅

HTTP Method

GET

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/{table_number}/attendee

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 Data[]

Data

Title Description Type Required Tips
attendee_id 嘉宾ID int
name 嘉宾名称 int
table_number 桌号 int
number 座位号 int
{
  "status": 0,
  "data": [
    {
      "attendee_id": 15648,
      "table_number": 1,
      "number": 1,
      "name": "哦婆婆"
    }
  ]
}

嘉宾详情✅

HTTP Method

GET

HTTP Request

attendee_id 嘉宾ID

/api/v2/attendee/{meeting_id}/{attendee_id}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 Data

Data

Title Description Type Required Tips
id 嘉宾ID int
order_num 订单号 string
name 嘉宾名称 string
phone 嘉宾手机号 string
before_site 往届座位 string
sell 负责销售名称 string
remark 备注 string
company 公司 string
job 职务 string
contract_rights 合同权益 string
dinner_remark 晚宴备注 string
{
  "status": 0,
  "data": {
    "id": 15648,
    "order_num": "220927583746757056",
    "name": "哦婆婆",
    "phone": "13121676702",
    "before_site": "",
    "sell": "",
    "remark": "",
    "company": null,
    "job": "银色",
    "contract_rights": null,
    "dinner_remark": null
  }
}

进入待选区✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/{attendee_id}/candidate_area

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
meeting_id 会议ID int
agenda_id 议程ID int 没有可以不写
attendee_id 嘉宾ID int

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool
{
  "status": 0,
  "data":  true
}

移除待选区✅

HTTP Method

DELETE

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/{attendee_id}/candidate_area

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data bool true

批量清除待选区🔥

HTTP Method

DELETE

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/candidate_area/clear

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
attendees 需要移除的参会人ID array 如果不传则会清空全部
{
  "attendees": [
    15648
  ]
}

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data bool true

锁定某一个桌号🔥

HTTP Method

PUT

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/lock/{table_number}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 是否成功 true

解锁某一个桌号🔥

HTTP Method

PUT

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/unlock/{table_number}

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 是否成功 true

设置嘉宾属性✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/{attendee_id}/attribute

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
color 字体颜色 string 没有可以不写
bg_color 背景颜色 string 没有可以不写

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data bool true

导出大表格✅

HTTP Method

POST

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/attendee/export

Request Parameters Query

Request Parameters Body

Response Data

octet-stream

已入坐嘉宾列表✅

HTTP Method

GET

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/attendee/all

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 Data[]

Summary

Title Description Type Required Tips
name 会议名称 string
table_count 桌数 int
rows_count 排数 int
seat_count 座位数 int
seating_count 入座人数 int
attendee_count 晚宴嘉宾总数 int

Data

Title Description Type Required Tips
id 桌号 int
rows 嘉宾名称 int
number 嘉宾名称 int
seat 座位数 int 如果入座人数小于10,该值为默认座位数10,如果入座人数大于10,则该值为实际入座人数
attendee_list 嘉宾属性 Attendee[] 嘉宾列表

Attendee

Title Description Type Required Tips
attendee_id 嘉宾ID int
name 嘉宾名称 string
table_number 桌号 int
number 座位号 int
attribute 嘉宾属性 string json,前端自定义自用
{
  "status": 0,
  "data": {
    "summary": {
      "table_count": 2,
      "seat_count": 20,
      "seating_count": 2,
      "rows_count": 1,
      "attendee_count": 28
    },
    "list": [
      {
        "id": 2344,
        "rows": 1,
        "number": 1,
        "seat": 10,
        "attendee_list": [
          {
            "attendee_id": 15648,
            "name": "哦婆婆",
            "number": 1,
            "table_number": 1,
            "attribute": null
          },
          {
            "attendee_id": 15649,
            "name": "朱思嘉",
            "number": 2,
            "table_number": 1,
            "attribute": {
              "color": "red"
            }
          }
        ]
      },
      {
        "id": 2345,
        "rows": 1,
        "number": 2,
        "seat": 10,
        "attendee_list": []
      }
    ]
  }
}

人桌关系保存✅

HTTP Method

POST

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/attendee

Request Parameters Query

Title Description Type Required Tips
clear_candidate_area 是否清空待选区 bool 默认否

Request Parameters Body

List

Title Description Type Required Tips
table_number 桌号 string
attendee_id 嘉宾ID string
name 嘉宾名称 string

Request Data EX

[
    {
        "name":"哦婆婆",
        "table_number":1,
        "attendee_id":15648
    },
    {
        "name":"朱思嘉",
        "table_number":1,
        "attendee_id":15649
    }
]

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool

将嘉宾移除该桌✅

HTTP Method

DELETE

HTTP Request

/api/v2/table/{meeting_id}/{agenda_id}/{attendee_id}/attendee/remove

Request Parameters Query

Request Parameters Body

Response Data

Title Description Type Required Tips
status 状态:0成功 非0失败 int
data 数据详情 bool

换桌✅

HTTP Method

POST

HTTP Request

/v2/table/{meeting_id}/{agenda_id}/attendee/exchange

Request Parameters Query

Request Parameters Body

Title Description Type Required Tips
old_table 旧桌号 int
new_table 新桌号 int
attendee_id 嘉宾ID int
force 强制入座 bool 默认否,表示座位已满无法入座

Response Data

Title Description Type Required Tips
status 状态 int 0成功 非0失败
data 成功标识 bool true成功 false 失败
{
  "status": 0,
  "data": true
}

SSE监听事件✅

HTTP Method

GET

HTTP Request

/api/v1/events/listen/{meeting_id}/{agenda_id}

Request Parameters Query

Title Description Type Required Tips
token 授权token string

Request Parameters Body

Response Data

事件数据✅

{
  "seats": [
    {
      "id": 141482,
      "rows": 0,
      "number": 1
    },
    {
      "id": 141483,
      "rows": 0,
      "number": 2
    },
    {
      "id": 141484,
      "rows": 0,
      "number": 3
    }
  ],
  "summary": {
    "seat_count": 156,
    "table_count": 15,
    "rows_count": 5,
    "seating_count": 132,
    "table_max_seat_num": 11
  },
  "data": [
    {
      "id": 2345,
      "table_attendee_list": [
        {
          "attendee_id": 28544,
          "name": "xun1",
          "attribute": {
            "color": "#FFF010"
          }
        }
      ]
    }
  ]
}
Title Description Type Required Tips
seats 座位图 []Seat 当前最新的座位排布
summary 汇总信息 Summary
data 受影响的桌中现有嘉宾列表 []Data

Seat

Title Description Type Required Tips
id 桌ID int
rows 排号 int
number 桌号 桌号

Summary

Title Description Type Required Tips
version 当前数据版本 int 为一个自增的数值,前端可据此判断是否有丢消息
seat_count 座位总数 int
table_count 桌数 int
rows_count 排数 int
seating_count 已入坐人数 int
table_max_seat_num 所有桌中最大人数 int 据此知道表格最多几列

Data

Title Description Type Required Tips
id 桌ID int
table_attendee_list 桌中的人列表 []Attendee 可能位空数组,表示桌中无人

Attendee

Title Description Type Required Tips
name 嘉宾名称 string
attendee_id 桌中的人列表 []Attendee 可能位空数组,表示桌中无人
attribute 嘉宾额外属性 Attribute

Attribute

Title Description Type Required Tips
color 字体颜色 string
bg_color 背景颜色 string