赠礼系统API

获取群收入

GetGiftAccount

接口

地址版本方式权限
/api/v2/gift/account/infov2POST高级权限-超级管理员

描述

用于获取指定群的群收入信息

提示

只对开通了赠礼系统的群有效

入参

字段类型必传说明
islandSourceIdstring群ID

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
totalIncomedecimal总收入(里程)
settlableIncomedecimal待结算收入(里程)
transferableIncomedecimal可转账收入(里程)

入参示例

{
    "islandSourceId": "101566"
}

出参示例

{
    "data": {
        "totalIncome": 2412.00,
        "settlableIncome": 0.00,
        "transferableIncome": 2412.00
    },
    "message": "success",
    "status": 0
}

获取成员分成管理

GetGiftShareRatioInfo

接口

地址版本方式权限
/api/v2/gift/share/ratio/infov2POST高级权限-超级管理员

描述

用于获取指定群的成员分成管理信息

提示

只对开通了赠礼系统的群有效

入参

字段类型必传说明
islandSourceIdstring群ID

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
defaultRatioobject默认抽成
roleRatioListlist<object>身份组抽成列表

默认抽成

字段类型说明
islandRatiodecimal群抽成
userRatiodecimal被打赏用户抽成
platformRatiodecimal平台抽成

身份组抽成列表项

字段类型说明
roleIdstring身份组ID
roleNamestring身份组名称
islandRatiodecimal群抽成
userRatiodecimal被打赏用户抽成
platformRatiodecimal平台抽成

入参示例

{
    "islandSourceId": "101566"
}

出参示例

{
    "data": {
        "defaultRatio": {
            "islandRatio": 3.00,
            "userRatio": 87.00,
            "platformRatio": 10.00
        },
        "roleRatioList": [{
                "roleId": "106568",
                "roleName": "超级管理员",
                "islandRatio": 20.00,
                "userRatio": 70.00,
                "platformRatio": 10.00
            }, {
                "roleId": "106858",
                "roleName": "小号专用",
                "islandRatio": 30.00,
                "userRatio": 60.00,
                "platformRatio": 10.00
            }
        ]
    },
    "message": "success",
    "status": 0
}

获取内容礼物列表

GetGiftList

接口

地址版本方式权限
/api/v2/gift/listv2POST通用权限-查看频道

描述

用于获取指定内容的礼物列表

提示

只对开通了赠礼系统的群有效

入参

字段类型必传说明
targetTypeint内容类型,1:消息,2:帖子
targetIdstring内容ID

出参

字段类型说明
statusint返回码
messagestring返回信息
datalist<object>数据列表

数据

字段类型说明
giftIdstring礼物ID
giftCountlong礼物数量
giftTotalAmountdecimal礼物总价值(铃钱)

入参示例

{
    "targetType": 1,
    "targetId": "377470609502158848"
}

出参示例

{
    "data": [{
            "giftId": "1",
            "giftCount": 301,
            "giftTotalAmount": 301.00
        }, {
            "giftId": "2",
            "giftCount": 221,
            "giftTotalAmount": 2210.00
        }
    ],
    "message": "success",
    "status": 0
}

获取内容礼物内成员列表

GetGiftMemberList

接口

地址版本方式权限
/api/v2/gift/member/listv2POST通用权限-查看频道

描述

用于获取指定内容的成员列表

提示

只对开通了赠礼系统的群有效

入参

字段类型必传说明
targetTypeint内容类型,1:消息,2:帖子
targetIdstring内容ID
giftIdstring礼物ID
pageSizeint页大小,最大100
maxIdlong上一页最大ID值,为提升分页查询性能,需要传入上一页查询记录中的最大ID值,首页请传0

数据

字段类型说明
maxIdobject最大ID值
listlist<object>数据列表

列表项

字段类型说明
dodoSourceIdstringDoDoID
nickNamestring群昵称
giftCountlong礼物数量

入参示例

{
    "targetType": 1,
    "targetId": "377470609502158848",
    "giftId": "1",
    "pageSize": 20,
    "maxId": 0,
}

出参示例

{
    "data": {
        "list": [{
                "dodoSourceId": "5868",
                "nickName": "测试群昵称",
                "giftCount": 301
            },
            {
                "dodoSourceId": "5869",
                "nickName": "测试群昵称2",
                "giftCount": 100
            }
        ],
        "maxId": 2
    },
    "message": "success",
    "status": 0
}

获取内容礼物总值列表

GetGiftGrossValueList

接口

地址版本方式权限
/api/v2/gift/gross/value/listv2POST通用权限-查看频道

描述

用于获取指定内容的礼物总值列表

提示

只对开通了赠礼系统的群有效

入参

字段类型必传说明
targetTypeint内容类型,1:消息,2:帖子
targetIdstring内容ID
pageSizeint页大小,最大100
maxIdlong上一页最大ID值,为提升分页查询性能,需要传入上一页查询记录中的最大ID值,首页请传0

数据

字段类型说明
maxIdobject最大ID值
listlist<object>数据列表

列表项

字段类型说明
dodoSourceIdstringDoDoID
nickNamestring群昵称
giftTotalAmountdecimal赠礼总值(铃钱)

入参示例

{
    "targetType": 1,
    "targetId": "377470609502158848",
    "pageSize": 20,
    "maxId": 0,
}

出参示例

{
    "data": {
        "list": [{
                "dodoSourceId": "5868",
                "nickName": "测试群昵称",
                "giftTotalAmount": 2511.00
            },
            {
                "dodoSourceId": "5869",
                "nickName": "测试群昵称2",
                "giftTotalAmount": 1211.00
            }
        ],
        "maxId": 2
    },
    "message": "success",
    "status": 0
}