API文档

# 新增预约

# 接口说明

项 值
URL /openapi/v1/live/book/add.json
描述 新增预约
请求方式 POST
需要登录 是
注意事项 customerNum 对应的客户必须已存在，否则报错
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
liveId string 短训宝直播间唯一id 是
customerNum string 客户唯一编号 是

# 请求数据

{
    "liveId": "xxxx",
    "customerNum": "HbXuqPHv8h"
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": null
}

# 批量新增预约

# 接口说明

项 值
URL /openapi/v1/live/book/batchAdd.json
描述 批量新增预约
请求方式 POST
需要登录 是
注意事项 customerNums 单次最多200条；客户必须已存在，不存在的客户计入失败明细，不影响其他客户
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
liveId string 短训宝直播间唯一id 是
customerNums array<string> 客户唯一编号列表，最多200条 是

# 请求数据

{
    "liveId": "xxxx",
    "customerNums": ["HbXuqPHv8h", "abcDEfg123"]
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": {
        "successCount": 1,
        "failList": [
            {"customerNum": "abcDEfg123", "reason": "已预约"}
        ]
    }
}

# 取消预约

# 接口说明

项 值
URL /openapi/v1/live/book/cancel.json
描述 取消预约
请求方式 POST
需要登录 是
注意事项 若客户当前未预约，接口幂等返回成功
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
liveId string 短训宝直播间唯一id 是
customerNum string 客户唯一编号 是

# 请求数据

{
    "liveId": "xxxx",
    "customerNum": "HbXuqPHv8h"
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": null
}

# 批量取消预约

# 接口说明

项 值
URL /openapi/v1/live/book/batchCancel.json
描述 批量取消预约
请求方式 POST
需要登录 是
注意事项 customerNumList 单次最多200条；未预约的客户计入失败明细，不影响其他客户
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
liveId string 短训宝直播间唯一id 是
customerNumList array<string> 客户唯一编号列表，最多200条 是

# 请求数据

{
    "liveId": "xxxx",
    "customerNumList": ["HbXuqPHv8h", "abcDEfg123"]
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": {
        "successCount": 2,
        "failList": []
    }
}

# 查询预约列表

# 接口说明

项 值
URL /openapi/v1/live/book/list.json
描述 查询直播间的已预约用户列表
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
liveId string 短训宝直播间唯一id 是

# 请求数据

{
    "liveId": "xxxx"
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "customerNum": "HbXuqPHv8h",
            "bookTime": 1721000000000
        }
    ]
}
字段名 字段类型 说明
customerNum string 客户唯一编号
bookTime long 预约时间戳

← 直播间黑名单 →