低代码 > API 文档 > 互动直播 > 服务端API参考 > 管理员交互接口 > 礼物配置设计接口

礼物配置设计接口

最近更新时间: 2022-12-15 17:33:21

保存礼物配置

保存礼物配置。

对于原来没有的礼物类型，新增配置。

对于相同的配置类型，覆盖原有的配置。

路径

POST /admin/gift/config

请求头

参数	说明	举例
Authorization	鉴权token

Body 参数

[
    {
        "type": 1,          //礼物类型
        "name": "红包",      //礼物名称
        "amount": 5,        //礼物金额，0 表示自定义金额,
        "img": "",          //礼物图片,
        "animation_type":0, //动态效果类型,
        "animation_img":"", //动态效果图片,
        "order": 0          //排序，从小到大排序，相同order 根据创建时间排序',
    }
]

该接口正确处理请求时返回如下 JSON 数据

{
    "request_id":"xxxxx", //请求ID
    "code": 0,            //错误码：0，成功；其他，失败
    "message": "success" //code 非0 时，错误原因描述
}

删除礼物配置

删除指定的礼物配置。

路径

DELETE /admin/gift/config/{gift_id}

路径参数

参数	类型	必填	说明	举例
gift_id	integer	是	礼物id	3

请求头

参数	说明	举例
Authorization	鉴权token

Body 参数

无。

该接口正确处理请求时返回如下 JSON 数据

{
    "request_id":"xxxxx", //请求ID
    "code": 0,            //错误码：0，成功；其他，失败
    "message": "success" //code 非0 时，错误原因描述
}

查看礼物配置

查看所有的礼物配置。

路径

GET /admin/gift/config/{type}

路径参数

参数	类型	必填	说明	举例
type	int	是	类型 ID，type==-1时表示全部类型

请求头

参数	说明	举例
Authorization	鉴权token

Body 参数

无。

该接口正确处理请求时返回如下 JSON 数据

{
    "request_id":"xxxxx", //请求ID
    "code": 0,            //错误码：0，成功；其他，失败
    "message": "success" //code 非0 时，错误原因描述
    "data": [
        {
            "type": 1,          //礼物类型
            "gift_id":3,        //礼物id
            "name": "红包",      //礼物名称
            "amount": 5,        //礼物金额，0 表示自定义金额,
            "img": "",          //礼物图片,
            "animation_type":0, //动态效果类型,
            "animation_img":"", //动态效果图片,
            "order": 0,         //排序，从小到大排序，相同order 根据创建时间排序',
            "created_at":"2022-09-15 13:00:00",    //创建时间
            "updated_at":"2022-09-20 15:00:00"     //更新时间
        }
    ]
}

以上内容是否对您有帮助？