取得頻道詳細資訊
更新時間:2022-09-02 18:08:07
介面URL
http://api.polyv.net/live/v3/channel/detail/get
介面說明
1、接口用于频道的简单详情信息
2、接口支持https
支援格式
JSON
請求方式
GET
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 管理員的appId |
| timestamp | 是 | long | 13位當前時間戳 |
| sign | 是 | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | 是 | int | 頻道id |
回應成功JSON範例:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"channelId": 101385,
"name": "测试的频道号",
"publisher": "liveTest1",
"startTime": 1500496639000,
"channelPasswd": "abcdefg",
"scene": "ppt",
"maxViewer": 100
}
}
回應失敗JSON範例:
未輸入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正確
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
時間戳錯誤
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
簽名錯誤
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
欄位說明
| 參數名 | 說明 |
|---|---|
| code | 回應代碼,成功為200,失敗為400,簽名錯誤為403,異常錯誤500 |
| status | 成功為success,失敗為error |
| message | 錯誤時為錯誤提示訊息 |
| data.channelId | 頻道號 |
| data.name | 頻道名稱 |
| data.publisher | 頻道主持人 |
| data.startTime | 開始直播時間的時間戳,未設定過回傳0 |
| data.channelPasswd | 頻道密碼 |
| data.scene | 直播場景,alone(活動直播),topclass(大班),ppt(三分屏) |
| data.cnAndEnLiveEnabled | 中英文直播間標識,N不開啟中英直播間 、Y開啟中英直播間 |
| data.englishSettingEnabled | 英文直播間獨立配置,N不開啟、Y開啟 |
| data.channelEnglishName | 直播名稱英文文案 |
| data.publisherEnglishName | 主持人名稱英文文案 |
