API docs by Redocly

直播控制台api (0.0.1)

Download OpenAPI specification:Download

直播控制台api

获取七牛上传token

query Parameters
key
required
string

上传七牛时的key

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

获取控制台用户信息

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "name": "string"
}

获取控制台基本信息

Responses

Response samples

Content type
application/json
{
  • "room_id": 0,
  • "title": "string",
  • "start_at": 0,
  • "popularity_rate": 0,
  • "activity_id": 0,
  • "cover": "string",
  • "description": "string",
  • "hoster_name": "string",
  • "hoster_avatar": "string",
  • "notice": "string",
  • "news_ticker": "string",
  • "status": 0,
  • "play_url": "string",
  • "play_url_hls": "string",
  • "play_url_rtmp": "string",
  • "im_id": "string",
  • "can_order": true,
  • "can_withdraw": true,
  • "total_order_count": 0,
  • "total_order_amount": 0,
  • "internal_merchant_id": 0,
  • "internal_merchant_name": "string",
  • "console_im_id": "string",
  • "console_im_token": "string",
  • "gifts": [
    ],
  • "products": [
    ],
  • "merchants": [
    ],
  • "current_product": {
    },
  • "live_days": 0
}

获取活动列表

Responses

Response samples

Content type
application/json
[
  • {
    }
]

选择活动

Request Body schema: multipart/form-data
activity_id
required
number

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取product详情

query Parameters
id
required
integer

产品id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "activity_id": 0,
  • "merchant_id": 0,
  • "merchant_name": "string",
  • "sold_num": 0,
  • "real_sold_num": 0,
  • "earnest": 0,
  • "description": "string",
  • "content": "string",
  • "img_url": "string",
  • "live_price": 0,
  • "market_price": 0,
  • "play_status": 0,
  • "show_price": 0,
  • "visible": 1,
  • "show_description": 1,
  • "sort": 0,
  • "countdown": 0,
  • "inventory": 0,
  • "maximum_buy_number": 1,
  • "category": "common"
}

更新product

Request Body schema: multipart/form-data
id
required
integer

产品id

name
string

产品名字

merchant_id
integer

merchant_id

description
string

产品描述/政策

content
string

产品图文内容

img
string <binary>

产品图片

live_price
integer

直播价格

market_price
integer or null

市场价

show_price
integer

是否显示价格

visible
integer

是否显示产品

show_description
integer

是否显示产品

earnest
integer

产品订金

sort
integer

排序

countdown
integer or null

倒计时（秒）

inventory
integer or null

库存

maximum_buy_number
integer or null

单个用户最大可购单量

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

创建product

Request Body schema: multipart/form-data
name
required
string

产品名字

merchant_id
required
integer

merchant_id

description
string

产品描述/政策

content
string

产品图文内容

img
string <binary>

产品图片

live_price
required
integer

直播价格

market_price
integer or null

市场价

show_price
required
integer

是否显示价格

visible
required
integer

是否显示产品

show_description
required
integer

是否显示产品

earnest
required
integer

产品订金

sort
required
integer

排序

countdown
integer or null

倒计时（秒）

inventory
integer or null

库存

maximum_buy_number
integer or null

单个用户最大可购单量

category
required
string
Enum: "common" "coupon" "seckill"

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

删除product

Request Body schema: multipart/form-data
id
integer

productid

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

播放产品

Request Body schema: multipart/form-data
id
integer or null

productid

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

停止播放产品

Request Body schema: multipart/form-data
id
integer or null

productid

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取阿里云直播拉流用户数

query Parameters
from
required
integer

开始时间

to
required
integer

结束时间

Responses

Response samples

Content type
application/json
{
  • "user_number_info": [
    ]
}

获取抽奖奖品

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

创建抽奖奖品

Request Body schema: multipart/form-data
img
string <binary>

产品图片

name
required
string
merchant_ids
Array of integers
quantity
required
integer

抽奖数量

type
required
string
Enum: "all" "bought_coupons" "bought_seckills" "signed_up" "ordered" "bought_blind"

抽奖资格

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

编辑抽奖奖品

query Parameters
prize_id
required
integer

奖品id

Request Body schema: multipart/form-data
img
string <binary>

产品图片

name
required
string
merchant_ids
Array of integers
quantity
required
integer

抽奖数量

type
required
string
Enum: "all" "bought_coupons" "bought_seckills" "signed_up" "ordered" "bought_blind"

抽奖资格

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

删除抽奖奖品

query Parameters
prize_id
required
integer

奖品id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

直播间抽奖

query Parameters
prize_id
required
integer

奖品id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

product批量排序

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取商户红包详情，例如余额

query Parameters
merchant_id
required
integer

商户id

Responses

Response samples

Content type
application/json
{
  • "balance": 0
}

发红包

Request Body schema: application/x-www-form-urlencoded
merchant_id
integer

商户id

total_amount
integer

发放总额，分

total_num
integer

红包个数

type
string
Enum: "all" "signed_up" "bought_coupons" "bought_prestore_card" "bought_seckills" "ordered"

抽奖资格

countdown
integer

倒计时

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

改变直播状态

Request Body schema: multipart/form-data
status
integer

房间状态

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

更新房间信息

Request Body schema: multipart/form-data
news_ticker
string

滚动公告

description
string

房间简介

popularity_rate
integer

倍率

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

机器人下单

Request Body schema: multipart/form-data
id
integer

产品id

amount
integer

数量

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

刷新直播流

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

清空赞666

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

改变是否可提现状态

Request Body schema: application/x-www-form-urlencoded
can_withdraw
integer

1可提现0不可提现

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

改变是否可下单状态

Request Body schema: multipart/form-data
can_order
integer

1可下单0不可下单

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取黑名单列表

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

加入黑名单列表

Request Body schema: multipart/form-data
user_id
integer

用户id

reason
string

原因

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "activity_id": 0,
  • "nickname": "string",
  • "created_at": 0,
  • "reason": "string"
}

聊天用户加入黑名单

Request Body schema: multipart/form-data
im_id
string

用户imid

content
string

弹幕内容

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "activity_id": 0,
  • "nickname": "string",
  • "created_at": 0,
  • "reason": "string"
}

移除黑名单列表

Request Body schema: multipart/form-data
id
integer

纪录id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取脏词列表

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "system_list": [
    ]
}

加入脏词

Request Body schema: multipart/form-data
word
string

脏词

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

移除脏词

Request Body schema: multipart/form-data
id
integer

纪录id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

发送消息 需要登录态

Request Body schema: multipart/form-data
room_id
required
integer

房间id

content
required
string

发送的聊天信息

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

获取好词列表

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "system_list": [
    ]
}

加入好词

Request Body schema: application/x-www-form-urlencoded
word
string

好词

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

移除好词

Request Body schema: application/x-www-form-urlencoded
id
integer

纪录id

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

列出直播章

Responses

Response samples

Content type
application/json
{
  • "list": [
    ]
}

推送直播章

Request Body schema: multipart/form-data
room_id
required
integer

房间id

medal_id
required
integer

直播章id

Responses

给预约用户推送开播提醒

Request Body schema: multipart/form-data
activity_id
required
integer

活动id

Responses

已推送详情

Responses

Response samples

Content type
application/json
{
  • "push_times": 0,
  • "time_list": [
    ]
}