設定頻道詳細資訊
更新時間:2022-09-02 18:08:07
介面URL
http://api.polyv.net/live/v3/channel/detail/update-simple-setting
介面說明
1、接口用于设置频道的简单详情信息
2、接口支持https
支援格式
JSON
請求方式
POST
請求參數
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | 是 | string | 管理員的appId |
| timestamp | 是 | long | 13位當前時間戳 |
| sign | 是 | String | 簽名,為32位大寫的MD5值,生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名生成規則】 |
| channelId | 是 | int | 頻道id |
| publisher | 否 | string | 主持人 |
| name | 否 | string | 頻道名稱 |
| startTime | 否 | long | 開始時間 |
| password | 否 | string | 頻道密碼,長度不能超過16位 |
| maxViewer | 否 | int | 頻道的最大線上人數觀看限制的人數 |
| scene | 否 | string | 直播場景: alone 直播助手 ppt 雲端課堂 topclass 大班課 |
| streamType | 否 | string | 流類型 |
| watchTitle | 否 | string | 觀看頁標題 |
| englishSettingEnabled | 否 | string | 英文獨立配置 Y是、N否 |
| channelEnglishName | 否 | string | 直播英文名稱 |
| publisherEnglishName | 否 | string | 主持人英文名稱 |
回應成功JSON範例:
{
"code": 200,
"status": "success",
"message": "",
"data": ""
}
回應失敗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 | 錯誤時為錯誤提示訊息 |
