lotteryActivityService

1. Query Lottery Activity

Description

查询抽奖活动
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/lottery-activity/get

Call Constraints

1. The API call has a frequency limit. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testGetLotteryActivity() throws Exception, NoSuchAlgorithmException {
        LiveLotteryActivityRequest liveLotteryActivityRequest = new LiveLotteryActivityRequest();
        LiveLotteryActivityResponse liveLotteryActivityResponse;
        try {
            liveLotteryActivityRequest.setChannelId(super.createChannel()).setId(30632L);
            liveLotteryActivityResponse = new LiveLotteryActivityServiceImpl().getLotteryActivity(
                    liveLotteryActivityRequest);
            Assert.assertNotNull(liveLotteryActivityResponse);
            if (liveLotteryActivityResponse != null) {
                //to do something ......
                log.debug("测试查询抽奖活动成功，{}", JSON.toJSONString(liveLotteryActivityResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Testing Instructions

1. If the request is correct, a LiveLotteryActivityResponse object is returned. The B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

CustomGroup Parameter Description

ReceiveInfo Parameter Description

ReceiveInfo Parameter Description

PrizeInfo Parameter Description

ReceiveInfo Parameter Description

2. Creating a Lucky Draw Event

Description

创建抽奖活动
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/lottery-activity/create

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testCreateLotteryActivity() throws Exception, NoSuchAlgorithmException {
        LiveCreateLotteryActivityRequest liveCreateLotteryActivityRequest = new LiveCreateLotteryActivityRequest();
        LiveCreateLotteryActivityResponse liveCreateLotteryActivityResponse;
        try {
            liveCreateLotteryActivityRequest.setChannelId(super.createChannel())
                    .setActivityName("polyv抽奖活动")
                    .setLotteryCondition("none")
                    .setAmount(1)
                    .setPrizeName("一等奖")
                    .setPrice(BigDecimal.valueOf(12.1))
                    .setRealPrice(BigDecimal.valueOf(200.33));
            liveCreateLotteryActivityResponse = new LiveLotteryActivityServiceImpl().createLotteryActivity(
                    liveCreateLotteryActivityRequest);
            Assert.assertNotNull(liveCreateLotteryActivityResponse);
            if (liveCreateLotteryActivityResponse != null) {
                //to do something ......
                log.debug("测试创建抽奖活动成功，{}", JSON.toJSONString(liveCreateLotteryActivityResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Testing Instructions

1. If the request is correct, a LiveCreateLotteryActivityResponse object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found in PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

ReceiveInfo Parameter Description

ReceiveInfo Parameter Description

PrizeInfo Parameter Description

ReceiveInfo Parameter Description

Return Object Description

CustomGroup Parameter Description

ReceiveInfo Parameter Description

ReceiveInfo Parameter Description

PrizeInfo Parameter Description

ReceiveInfo Parameter Description

3. Update Lottery Activity

Description

更新抽奖活动
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/lottery-activity/update

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testUpdateLotteryActivity() throws Exception, NoSuchAlgorithmException {
        LiveUpdateLotteryActivityRequest liveUpdateLotteryActivityRequest = new LiveUpdateLotteryActivityRequest();
        Boolean liveUpdateLotteryActivityResponse;
        try {
            liveUpdateLotteryActivityRequest.setChannelId(super.createChannel())
                    .setId(30951L)
                    .setActivityName("polyv抽奖活动")
                    .setLotteryCondition("none")
                    .setAmount(2)
                    .setPrizeName("2等奖");
            liveUpdateLotteryActivityResponse = new LiveLotteryActivityServiceImpl().updateLotteryActivity(
                    liveUpdateLotteryActivityRequest);
            Assert.assertNotNull(liveUpdateLotteryActivityResponse);
            if (liveUpdateLotteryActivityResponse != null) {
                //to do something ......
                log.debug("更新抽奖活动成功，{}", JSON.toJSONString(liveUpdateLotteryActivityResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, refer to PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

ReceiveInfo Parameter Description

ReceiveInfo Parameter Description

PrizeInfo Parameter Description

ReceiveInfo Parameter Description

Return Object Description

null

4. Delete Lottery Activity

Description

删除抽奖活动
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/lottery-activity/delete

Call Constraints

1. The API call is subject to rate limits. For details, please refer to [/live/java/limit.md]. For common call exceptions, please refer to [/live/java/exceptionDoc].

Unit Testing

    @Test
    public void testDeleteLotteryActivity() throws Exception, NoSuchAlgorithmException {
        LiveDeleteLotteryActivityRequest liveDeleteLotteryActivityRequest = new LiveDeleteLotteryActivityRequest();
        Boolean liveDeleteLotteryActivityResponse;
        try {
            liveDeleteLotteryActivityRequest.setChannelId(super.createChannel())
                    .setId(30951L);
            liveDeleteLotteryActivityResponse = new LiveLotteryActivityServiceImpl().deleteLotteryActivity(
                    liveDeleteLotteryActivityRequest);
            Assert.assertNotNull(liveDeleteLotteryActivityResponse);
            if (liveDeleteLotteryActivityResponse != null) {
                //to do something ......
                log.debug("删除抽奖活动成功，{}", JSON.toJSONString(liveDeleteLotteryActivityResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

Unit Testing Instructions

1. If the request is correct, a Boolean object is returned, and the B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. The error message can be found via PloyvSdkException.getMessage(), for example: [ Input parameter [xxx.chat.LivexxxRequest] object validation failed, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

null

5. Query Lottery Activity List

Description

查询抽奖活动列表
接口地址（仅做说明使用）：https://api.polyv.net/live//v4/channel/lottery-activity/list

Call Constraints

1. The API call has a frequency limit. For details, see here. For common call exceptions, see here.

Unit Testing

    @Test
    public void testListLotteryActivity() throws IOException, NoSuchAlgorithmException {
        LiveLotteryActivityListRequest liveLotteryActivityListRequest = new LiveLotteryActivityListRequest();
        LiveLotteryActivityListPageResponse liveLotteryActivityListPageResponse;
        try {
            liveLotteryActivityListRequest.setChannelId(super.createChannel()).setPageSize(2);
            liveLotteryActivityListPageResponse = new LiveLotteryActivityServiceImpl().listLotteryActivity(
                    liveLotteryActivityListRequest);
            Assert.assertNotNull(liveLotteryActivityListPageResponse);
            if (liveLotteryActivityListPageResponse != null) {
                //to do something ......
                log.debug("查询抽奖活动列表成功，{}", JSON.toJSONString(liveLotteryActivityListPageResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }
}

Unit Testing Instructions

1. If the request is correct, a LiveLotteryActivityListPageResponse object is returned. The B-side processes business logic based on this object.

2. If request parameter validation fails, a PloyvSdkException is thrown. See PloyvSdkException.getMessage() for error details, e.g., [ Validation failed for input parameter [xxx.chat.LivexxxRequest] object, failed field [pic cannot be empty / msg cannot be empty] ]

3. The server encountered an exception and threw a PloyvSdkException. For error details, see PloyvSdkException.getMessage(), e.g., [ Polyv request returned data error, request serial number: 66e7ad29fd04425a84c2b2b562d2025b, error reason: invalid signature. ]

Request Parameter Description

Return Object Description

LiveLotteryActivityList Parameter Description

CustomGroup Parameter Description

ReceiveInfo Parameter Description

ReceiveInfo Parameter Description

PrizeInfo Parameter Description

ReceiveInfo Parameter Description