傳送打賞訊息

更新時間：2022-09-02 18:08:07

介面描述

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	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
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	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
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": ""
}