建立任務獎勵活動
更新時間:2026-02-02 16:50:11
介面說明
1、创建任务奖励活动
2、接口支持https协议
介面URL
https://api.polyv.net/live/v4/channel/task-reward-activity/save
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
請求體參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | true | Integer | 頻道ID |
| activityName | true | String | 活動名稱,最大長度64個字元 |
| taskRule | true | Integer | 任務規則:1:解鎖任務,2:並行任務 |
| startTime | true | Long | 活動開始時間 |
| endTime | true | Long | 活動結束時間 |
| tasks | true | Array | 任務規則列表 【詳見tasks欄位說明】 |
tasks參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| sort | true | Integer | 排序 |
| reachCondition | true | Object | 達成條件設定 【詳見reachCondition】 |
| rewardSetting | true | Object | 獎勵設定 |
reachCondition參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| type | true | String | 達成條件(sign:簽到,online:線上時長,questionnaire:答題,custom:自訂) |
| amount | true | Integer | 達成數值 |
| templateId | false | Long | 題目ID,達成條件為questionnaire時必填 |
| customEvent | false | String | 自訂任務事件,達成條件為custom時必填 |
| customEventName | false | String | 自訂任務名稱 |
| customIcon | false | String | 自訂任務圖示 |
| customUnit | false | String | 自訂任務單位 |
| customButtonText | false | String | 自訂任務按鈕文案 |
| customReachText | false | String | 自訂任務達成文案,eg: {customEventName}完成:{amount}{customUnit} |
rewardSetting參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| type | true | String | cash:現金,custom:自訂,nothing:無獎勵,externalPoint:外部積分 |
| amount | false | Integer | 獎勵數值(type為cash時,現金單位是分;type為cash、externalPoint時需要傳) |
| limit | false | Integer | 獎勵設定 |
| customReward | false | String | 自訂獎勵,非必填 |
範例
https://api.polyv.net/live/v4/channel/task-reward-activity/save?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB×tamp=1670550787318
請求體json參數:
{
"channelId": 4854808,
"activityName": "测试活动",
"activityMode": 1,
"taskRule": 1,
"startTime": 1722035312584,
"endTime": 1722036312584,
"tasks": [
{
"reachCondition": {
"type": "sign",
"amount": 10
},
"rewardSetting": {
"type": "cash",
"amount": 1,
"limit": 10
}
},
{
"reachCondition": {
"type": "sign",
"amount": 15
},
"rewardSetting": {
"type": "cash",
"amount": 10,
"limit": 10
}
}
]
}
回應體json:
{
"code": 200,
"status": "success",
"requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
"data": 10465,
"success": true
}
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗 |
| status | String | 回應結果,由業務決定,成功返回success,失敗返回error |
| success | Boolean | 回應結果,由業務決定,成功返回true,失敗返回false |
| data | Long | 任務獎勵活動ID |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位說明】 |
| requestId | String | 請求ID,每次請求產生的唯一UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private final Logger log = LoggerFactory.getLogger(getClass());
/**
* 新建任务奖励活动
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void createTaskRewardTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
String url = "https://api.polyv.net/live/v4/channel/task-reward-activity/save";
//业务参数
Integer channelId = 5004544;
String activityName = "demoData";
Integer taskRule = 1;
Long startTime = 1722035312584;
Long endTime = 1722036312584;
List<Task> tasks = new ArrayList();
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("channelId", channelId);
jsonMap.put("activityName", activityName);
jsonMap.put("taskRule", taskRule);
jsonMap.put("startTime", startTime);
jsonMap.put("endTime", endTime);
jsonMap.put("tasks", tasks);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试新建活动结果:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
"data": 10465,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
