发送打赏消息

接口描述

1、发送打赏消息
2、请求成功后，服务器会向聊天室的用户广播打赏消息，详见直播聊天室API接口
3、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/chat/send-reward-msg

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名
必选
类型
说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

channelId

true

String

频道号

nickname

true

String

打赏者昵称

avatar

true

String

打赏者头像

viewerId

true

String

打赏者ID，必须是在线用户的ID，一般搭配白名单观看、自定义授权、外部授权或独立授权使用

donateType

true

String

打赏类型 cash：现金打赏 good：道具打赏

content

true

String

打赏内容：礼物打赏为礼物名称，现金打赏为金额

goodImage

false

String

礼物打赏时为礼物图片，现金打赏时为空

sessionId

false

String

直播场次ID

goodNum

false

String

打赏数量，不传默认为1

needUserImage

false

String

是否socket消息需要用户图片，默认为N（是：Y，否：N）

示例

http://api.polyv.net/live/v3/channel/chat/send-reward-msg

表单参数：

viewerId=1615772956066&goodImage=https%3A%2F%2Fs1.videocc.net%2Fdefault-img%2Fdonate%2Fflower.png&appId=frlr1zazn3&nickname=rock&sign=EB6BB879F2C5962E77324C81A9C453D0&donateType=good&avatar=https%3A%2F%2Flivestatic.videocc.net%2Fuploaded%2Fimages%2Fwebapp%2Favatar%2Fdefault-teacher.png&channelId=2191532&content=%E9%B2%9C%E8%8A%B1&timestamp=1621844118743

响应参数描述

参数名
类型
说明

code

Integer

status

String

响应状态文本信息

message

String

响应描述信息，当code为400或者500的时候，辅助描述错误原因

data

String

请求成功和失败都为空

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
     * 发送打赏消息
     * @throws IOException
     */
    @Test
    public void testSendRewardMsg() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId=super.appId;
        String appSecret=super.appSecret;
        String userId = super.userId;
        String timestamp=String.valueOf(System.currentTimeMillis());
        //业务参数
        String channelId = "2191532";
        String nickname = "rock";
        String avatar = "https://livestatic.videocc.net/uploaded/images/webapp/avatar/default-teacher.png";
        String viewerId = "1615772956066";
        String donateType = "good";
        String content = "鲜花";
        String goodImage = "http://s1.videocc.net/default-img/donate/flower.png";
        String url = "http://api.polyv.net/live/v3/channel/chat/send-reward-msg";
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("viewerId",viewerId);
        requestMap.put("nickname",nickname);
        requestMap.put("avatar",avatar);
        requestMap.put("donateType",donateType);
        requestMap.put("content",content);
        requestMap.put("goodImage",goodImage);

        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url,requestMap);
        log.info("测试发送打赏消息接口返回值：{}",response);
        //do somethings
    }

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
	"code": 200,
	"status": "success",
	"message": "",
	"data": ""
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
Previous发送答题卡Next停止答题卡

Last updated

Was this helpful?