保利威文档中心

幫助中心

建立單一頻道（舊版）

更新時間：2022-12-20 17:27:05

介面說明

1、创建频道并进行相关设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channels/

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS以確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名 必填 類型 說明
appId true String 帳號appId【詳見取得金鑰】
timestamp true Long 目前13位毫秒級時間戳，3分鐘內有效
sign true String 簽名，為32位大寫的MD5值，產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】
userId true String POLYV使用者ID，與保利威官網一致，取得路徑：官網->登入->直播（開發設定）
name true String 頻道名稱，最大長度60
channelPasswd true String 頻道密碼，長度不能超過16位
scene false String 直播場景，預設alone
alone：活動拍攝
ppt：三分屏
topclass：大班課
seminar：研討會
pureRtcEnabled false String 是否為無延遲直播，預設為N
Y：是
N：否
cnAndEnLiveEnabled false String 中英文直播間開關，預設為N
Y：開啟
N：關閉
englishSettingEnabled false String 英文直播間開關，預設為N
Y：開啟
N：關閉
publisherEnglishName false String 英文主持人名稱
channelEnglishName false String 英文頻道名稱
categoryId false Integer 新建頻道的所屬分類，如果不提交，則為預設分類（分類ID可透過「查詢直播分類」介面取得）
maxViewer false Integer 最大同時線上人數，0和-1表示不限制觀看人數
linkMicLimit false Integer 連麥人數，最大16人（範圍大於等於-1，小於等於全域設定的連麥人數），-1：使用全域設定的連麥人數
playerColor false String 播放器控制列顏色，預設：#666666
autoPlay false Integer 是否自動播放
0：不自動播放
1：自動播放，預設1
receive false String 是否為接收轉播頻道，不填或填其他值為發起轉播頻道（註：需開啟頻道轉播功能該參數才生效）
Y：表示是
N：表示否
receiveChannelIds false String 接收轉播頻道號，多個頻道號用半形逗號隔開，如果receive參數值為Y時，此參數無效（註：需開啟頻道轉播功能該參數才生效）
channelObject false String 頻道屬性
doubleEnabled false String 雙師頻道屬性，N不開啟（預設為N）Y為雙師頻道
bookingEnabled false String 預約的功能開關，預設為Y
Y：開啟
N：關閉
streamType false String 直播方式
client：用戶端推流
pull：拉流
thirdpull：第三方拉流
disk：偽直播
audio：音訊直播
aloneWatchLayout false String 普通直播觀看頁佈局配置（普通：normal，直式：portrait），預設普通直播

範例

http://api.polyv.net/live/v2/channels?appId=frlr1zazn3&timestamp=1671527624000&sign=AD7FC9F7F3E55B1145E354FB291590E3&name=%E5%B0%8F%E8%AF%BE%E5%A0%82&userId=1b448be323&channelPasswd=32L8PQC08sg

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status String 回應狀態文字資訊
message String 回應描述資訊，當code為400或500時，輔助描述錯誤原因
data Object 成功回應時返回頻道詳細資訊【詳見data欄位說明】
Data參數說明
參數名 類型 說明
channelId String 直播頻道號
userId String POLYV使用者ID，與保利威官網一致，取得路徑：官網->登入->直播（開發設定）
name String 直播頻道名稱
publisher String 主持人
description String 直播頻道描述
url String 直播流的URL
stream String 直播流名稱
logoImage String LOGO的圖片位址
logoOpacity Double LOGO的透明度
logoPosition String LOGO在播放器上的位置
logoHref String LOGO的外鏈位址
coverImage String 封面圖片位址
coverHref String 封面圖片的外鏈位址
waitImage String 等待直播流的圖片
waitHref String 等待直播流圖片的外部連結
cutoffImage String 斷流圖片的位置
cutoffHref String 斷流圖片的外鏈位址
advertType String 廣告的類型，無廣告、圖片廣告、FLV廣告
advertDuration Integer 廣告時長，單位：秒
advertWidth Integer 廣告的寬，單位：像素
advertHeight Integer 廣告的高，單位：像素
advertImage String 圖片廣告的位置
advertHref String 廣告的外鏈位址
advertFlvVid String FLV廣告在PolyV系統中的videoId
advertFlvUrl String FLV廣告的URL
playerColor String 播放器控制列的顏色
autoPlay Boolean 是否自動播放
warmUpFlv String 暖場影片
passwdRestrict Boolean 是否設定了密碼保護
playCodeRestrict Boolean 是否設定了密碼保護，等同欄位passwdRestrict
passwdEncrypted String MD5加密後的播放密碼
playCodeEncrypted String MD5加密後的播放密碼，等同欄位passwdEncrypted
isOnlyAudio String 是否為音訊直播
isLowLatency String 是否為低延遲直播
m3u8Url String M3U8的URL位址
m3u8Url1 String 標清M3U8位址
m3u8Url2 String 高清M3U8位址
m3u8Url3 String 超清M3U8位址
channelLogoImage String 頻道的logo圖片
scene String 頻道的直播場景
channelViewerPasswd String 參與者密碼
channelPasswd String 頻道密碼
linkMicLimit Integer 連麥人數
streamType String 直播方式
pureRtcEnabled String 是否是純rtc拉流
type String 頻道類型，發起轉播、接收轉播
cnAndEnLiveEnabled String 中英文直播間開關
pushEnUrl String 英文推流位址
closeDanmu String 彈幕開關

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 11667086,
        "userId": "1b448be323",
        "name": "polyv小课堂",
        "publisher": "主持人",
        "description": "",
        "url": "rtmp://push-d1.videocc.net/recordf/1b448be32316715274020016771?auth_key=1671529203-0-0-f6198f001ccf7fca946c90801ef9c504",
        "stream": "1b448be32316715274020016771",
        "logoImage": "https://liveimages.videocc.net/uploaded/images/2021/04/fy3ce1e8uh.png",
        "logoOpacity": 0.37,
        "logoPosition": "tr",
        "logoHref": "",
        "coverImage": "",
        "coverHref": "",
        "waitImage": "",
        "waitHref": "",
        "cutoffImage": "",
        "cutoffHref": "",
        "advertType": "NONE",
        "advertDuration": 0,
        "advertWidth": 0,
        "advertHeight": 0,
        "advertImage": "",
        "advertHref": "",
        "advertFlvVid": "",
        "advertFlvUrl": "",
        "playerColor": "#666666",
        "autoPlay": false,
        "warmUpFlv": "",
        "passwdRestrict": false,
        "playCodeRestrict": false,
        "passwdEncrypted": "",
        "playCodeEncrypted": null,
        "isOnlyAudio": "N",
        "isLowLatency": "N",
        "m3u8Url": "http://pull-d1.videocc.net/recordf/1b448be32316715274020016771.m3u8?auth_key=1671527403-0-0-de8272610bc40f7102dcb880cfde138d",
        "m3u8Url1": "",
        "m3u8Url2": "",
        "m3u8Url3": "",
        "channelLogoImage": "https://liveimages.videocc.net/uploaded/images/2022/11/gffeocwo9n.png",
        "scene": "alone",
        "channelViewerPasswd": null,
        "channelPasswd": "QIbGmAmhMJ1dq",
        "loginCode": null,
        "linkMicLimit": 16,
        "streamType": "client",
        "pureRtcEnabled": "N",
        "type": "normal",
        "cnAndEnLiveEnabled": "N",
        "pushEnUrl": null,
        "closeDanmu": "N",
        "currentTimeMillis": 1671527405150
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服，在线咨询