go-common/app/service/live/xuser/api/grpc/v1/guard.guard.md
2019-04-22 18:49:16 +08:00

8.1 KiB
Raw Blame History

/live.xuser.v1.Guard/Buy

Buy 购买大航海

方法GET

请求参数

参数名 必选 类型 描述
order_id string
uid integer
ruid integer
guard_level integer
num integer
platform integer
source string

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "status": 0
    }
}

/live.xuser.v1.Guard/GetByUIDTargetID

GetByUIDTargetID 获取我与目标用户守护关系,不支持批量(P0级)

方法GET

请求参数

参数名 必选 类型 描述
uid integer
target_id integer
sort_type integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "data": {
            "1": {
                //  主键
                "id": 0,
                //  uid
                "uid": 0,
                //  target_id
                "target_id": 0,
                //  守护类型 1为总督2为提督3为舰长
                "privilege_type": 0,
                //  start_time
                "start_time": "",
                //  expired_time
                "expired_time": "",
                //  ctime
                "ctime": "",
                //  utime
                "utime": ""
            }
        }
    }
}

/live.xuser.v1.Guard/GetByTargetIdsBatch

GetByTargetIdsBatch 获取我与目标用户守护关系,支持批量(P2级,必要时刻降级)

方法GET

请求参数

{
    "targetIDs": [
        {
            "target_id": 0,
            "sort_type": 0
        }
    ]
}

响应

{
    "code": 0,
    "message": "ok",
    "data": {
    }
}

/live.xuser.v1.Guard/GetByUIDTargetIds

GetByUIDTargetIds 根据uids批量获取所有守护关系,粉丝勋章使用

方法GET

请求参数

{
    "uid": 0,
    "targetIDs": [
        {
            "target_id": 0,
            "sort_type": 0
        }
    ]
}

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "data": {
            "1": {
                //  主键
                "id": 0,
                //  uid
                "uid": 0,
                //  target_id
                "target_id": 0,
                //  守护类型 1为总督2为提督3为舰长
                "privilege_type": 0,
                //  start_time
                "start_time": "",
                //  expired_time
                "expired_time": "",
                //  ctime
                "ctime": "",
                //  utime
                "utime": ""
            }
        }
    }
}

/live.xuser.v1.Guard/GetByUIDForGift

GetByUID 获取我所有的守护,不支持批量(P0级)

方法GET

请求参数

参数名 必选 类型 描述
uid integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "data": {
            "1": {
                //  主键
                "id": 0,
                //  uid
                "uid": 0,
                //  target_id
                "target_id": 0,
                //  守护类型 1为总督2为提督3为舰长
                "privilege_type": 0,
                //  start_time
                "start_time": "",
                //  expired_time
                "expired_time": "",
                //  ctime
                "ctime": "",
                //  utime
                "utime": ""
            }
        }
    }
}

/live.xuser.v1.Guard/GetByUIDBatch

GetByUIDBatch 根据uids获取所有的守护,支持批量(P2级)

方法GET

请求参数

参数名 必选 类型 描述
uids 多个integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "data": {
            "1": {
                "list": [
                    {
                        //  主键
                        "id": 0,
                        //  uid
                        "uid": 0,
                        //  target_id
                        "target_id": 0,
                        //  守护类型 1为总督2为提督3为舰长
                        "privilege_type": 0,
                        //  start_time
                        "start_time": "",
                        //  expired_time
                        "expired_time": "",
                        //  ctime
                        "ctime": "",
                        //  utime
                        "utime": ""
                    }
                ]
            }
        }
    }
}

/live.xuser.v1.Guard/GetAnchorRecentTopGuard

GetAnchorRecentTopGuard 获取最近的提督弹窗提醒

方法GET

请求参数

参数名 必选 类型 描述
uid integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        //  主键
        "cnt": 0,
        "list": [
            {
                "uid": 0,
                "end_time": 0,
                "is_open": 0
            }
        ]
    }
}

/live.xuser.v1.Guard/GetTopListGuard

GetTopListGuard 获取某个up主的守护排行榜

方法GET

请求参数

参数名 必选 类型 描述
uid integer
page integer
page_size integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        //  守护总数量
        "num": 0,
        "page": 0,
        "now": 0,
        "list": [
            {
                "uid": 0,
                "ruid": 0,
                "rank": 0,
                "guard_level": 0
            }
        ],
        "top3": [
            {
                "uid": 0,
                "ruid": 0,
                "rank": 0,
                "guard_level": 0
            }
        ]
    }
}

/live.xuser.v1.Guard/GetTopListGuardNum

GetTopListGuardNum 获取某个up主所有的守护数量,和GetTopListGuard接口的区别是此接口用于房间页首屏,逻辑比较简单,因此拆分开来

方法GET

请求参数

参数名 必选 类型 描述
uid integer

响应

{
    "code": 0,
    "message": "ok",
    "data": {
        "total_count": 0
    }
}

/live.xuser.v1.Guard/ClearUIDCache

ClearUIDCache 清除cache

方法GET

请求参数

参数名 必选 类型 描述
uid integer
magic_key string

响应

{
    "code": 0,
    "message": "ok",
    "data": {
    }
}