Get Channel Details
Updated: 2022-09-02 18:08:07
API URL
http://api.polyv.net/live/v3/channel/detail/get
API Description
1、接口用于频道的简单详情信息
2、接口支持https
Supported Format
JSON
Request Method
GET
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Admin's appId |
| timestamp | Yes | long | 13-digit current timestamp |
| sign | Yes | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data. See signature generation rules |
| channelId | Yes | int | Channel ID |
Successful Response JSON Example:
{
"code": 200,
"status": "success",
"message": "",
"data": {
"channelId": 101385,
"name": "测试的频道号",
"publisher": "liveTest1",
"startTime": 1500496639000,
"channelPasswd": "abcdefg",
"scene": "ppt",
"maxViewer": 100
}
}
Failed Response JSON Example:
No appId provided
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
Incorrect appId
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
Timestamp error
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
Signature error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Field Description
| Parameter | Description |
|---|---|
| code | Response code: 200 for success, 400 for failure, 403 for signature error, 500 for exception error |
| status | "success" for success, "error" for failure |
| message | Error message when an error occurs |
| data.channelId | Channel number |
| data.name | Channel name |
| data.publisher | Channel host |
| data.startTime | Timestamp of live stream start time; returns 0 if not set |
| data.channelPasswd | Channel password |
| data.scene | Live stream scene: alone (event live), topclass (large class), ppt (three-screen) |
| data.cnAndEnLiveEnabled | Bilingual live room flag: N (disabled), Y (enabled) |
| data.englishSettingEnabled | Independent English live room configuration: N (disabled), Y (enabled) |
| data.channelEnglishName | Live stream name in English |
| data.publisherEnglishName | Host name in English |
