批量建立角色
更新時間:2025-03-11 15:18:54
介面說明
1、批量创建角色,角色包括Guest(嘉宾)、Assistant(助教)
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/account/batch-create
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、每個直播頻道最多可以建立150個助教,嘉賓最大數量為16
3、建立嘉賓需要設定頻道連麥人數,開啟連麥功能
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
請求體參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| passwd | false | String | 角色密碼 |
| role | false | String | 角色類型,預設為助教, Assistant:助教, Guest:嘉賓 |
| nickname | false | String | 建立的助教或嘉賓暱稱 |
| actor | false | String | 建立的助教或嘉賓頭銜 |
| avatar | false | String | 建立的助教或嘉賓頭像 |
範例
http://api.polyv.net/live/v3/channel/account/batch-create?appId=frlr1zazn3&sign=7D0C4520C6968C948EFA7B5B912FB979&channelId=2191569×tamp=1621841813383
請求體參數
[{
"role": "Guest",
"nickname": "嘉宾",
"passwd": 123456
},
{
"role": "Assistant",
"nickname": "助教",
"passwd": 123456
}
]
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | Array | 回應成功時返回角色資訊【詳見data欄位說明】 |
Data參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| account | String | 助教/嘉賓帳號 |
| userId | String | POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定) |
| channelId | String | 頻道號 |
| passwd | String | 角色密碼 |
| nickname | String | 角色名稱 |
| stream | String | 角色串流名稱(單獨使用無效) |
| status | String | 角色狀態 |
| createdTime | Long | 建立角色時間,13位毫秒級時間戳 |
| lastModified | Long | 角色最後修改時間,13位毫秒級時間戳 |
| channelSessionId | String | 場次號 |
| sort | Integer | 頻道角色序號 |
| avatar | String | 角色頭像 |
| actor | String | 建立的助教或嘉賓頭銜 |
| pageTurnEnabled | String | 助教翻頁權限(只能一個助教有) Y:開啟 N:關閉 |
| notifyEnabled | String | 發布公告權限 Y:開啟 N:關閉 |
| checkinEnabled | String | 開啟簽到權限 Y:開啟 N:關閉 |
| voteEnabled | String | 發起投票權限 Y:開啟 N:關閉 |
| lotteryEnabled | String | 是否擁有抽獎權限 Y:開啟 N:關閉 |
| role | String | 角色 Assistant:助教 Guest:嘉賓 |
| chatListEnabled | String | 助教頁線上列表顯示開關 Y:開啟 N:關閉 |
| chatAuditEnabled | String | 助教聊天審核權限 Y:開啟 N:關閉 |
| monitorEnabled | String | 監播權限開關 Y:開啟 N:關閉 |
| roundTourEnabled | String | 助教輪巡權限開關 Y:開啟 N:關閉 |
| watchLockEnabled | String | 鎖定直播間權限 Y:開啟 N:關閉 |
| loginUrl | String | 子帳號(嘉賓)登入位址 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 批量创建角色
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testBatchCreate() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url="http://api.polyv.net/live/v3/channel/account/batch-create";
String channelId="2191569";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String json = "[{\"role\":\"Guest\",\"nickname\":\"嘉宾\",\"passwd\":123456},{\"role\":\"Assistant\",\"nickname\":\"助教\",\"passwd\":123456}]";
url = HttpUtil.appendUrl(url,requestMap);
String response= HttpUtil.postJsonBody(url,json,null);
log.info("测试批量创建角色,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":[
{
"account":"0052191569",
"userId":"1b448be323",
"channelId":2191569,
"passwd":"******",
"nickname":"嘉宾",
"stream":"kmd6qbz0",
"status":"Y",
"createdTime":1615969860000,
"lastModified":1615969860000,
"channelSessionId":null,
"sort":5,
"avatar":"//s1.videocc.net/default-img/avatar/guest.png",
"actor":"嘉宾",
"pageTurnEnabled":"N",
"notifyEnabled":"N",
"checkinEnabled":"Y",
"voteEnabled":"N",
"lotteryEnabled":"N",
"role":"Guest",
"chatListEnabled":"Y",
"chatAuditEnabled":"N",
"monitorEnabled":"N",
"roundTourEnabled":"N",
"watchLockEnabled":"N",
"loginUrl":null
},
{
"account":"0062191569",
"userId":"1b448be323",
"channelId":2191569,
"passwd":"******",
"nickname":"助教",
"stream":"kmd6qbz3",
"status":"Y",
"createdTime":1615969860000,
"lastModified":1615969860000,
"channelSessionId":null,
"sort":6,
"avatar":"//s1.videocc.net/default-img/avatar/assistant.png",
"actor":"助教",
"pageTurnEnabled":"N",
"notifyEnabled":"Y",
"checkinEnabled":"Y",
"voteEnabled":"Y",
"lotteryEnabled":"Y",
"role":"Assistant",
"chatListEnabled":"Y",
"chatAuditEnabled":"N",
"monitorEnabled":"N",
"roundTourEnabled":"N",
"watchLockEnabled":"N",
"loginUrl":null
}
]
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
