Viewing channel information
- Print
- PDF
Viewing channel information
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
It is an API to view the user channel information. For the use flow of B2B PRISM Live Studio, see Go live process.
Requests
The request format is as follows:
GET {serviceApiDomain}/prism/v1/service/channel/{channelId}
Request headers
The description of the header is as follows:
| Name | Type | Description | Required |
|---|---|---|---|
| x-prism-access-token | String | Access Token issued through OAuth2.0 authorization | Y |
Request path parameters
The description of the parameters is as follows:
| Name | Type | Description | Required |
|---|---|---|---|
| channelId | String | Targeted channel ID to view | Y |
Responses
This is a description of the response format.
Note
For the basic response format, see the Basic format for API responses.
| Name | Type | Description | Required |
|---|---|---|---|
| userName | String | User name to be exposed in B2B PRISM Live Studio | Y |
| channel | Object | Channel object | Y |
channel DTO
The description of the channel DTO is as follows:
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| channelId | String | Y | |
| channelName | String | Y | |
| channelEnabled | Boolean | Y | |
| channelLink | String | 채널 홈 주소 | Y |
| channelDescription | String | 채널 설명 | N |
| channelTags | String | 채널 태그 목록, ";"로 구분된 문자열 | N |
| channelThumbnailUrl | String | N | |
| channelFollowerCount | Number | 채널 구독자 수 | N |
Examples
Introduces examples of syntax.
Request examples
An example of the syntax is as follows:
curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}
-H "x-prism-access-token: {access-token}"
Response examples
An example of the syntax is as follows:
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"channel": {
"channelId": 1,
"channelName": "AdminTV",
"channelEnabled": true,
"channelLink": "https://prismlive.com",
"channelDescription": "Adminadmin",
"channelTags": "mukbang;talk",
"channelThumbnailUrl": "https://thumbnail123.png",
"channelFollowerCount": 999
},
"userName": "Admin"
}
}
Was this article helpful?