채널 정보 조회
- 인쇄
- PDF
채널 정보 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
사용자 채널 정보를 조회하는 API입니다. B2B PRISM Live Studio에서의 사용 플로우를 확인하려면 방송 시작 프로세스를 참고해 주십시오.
요청
요청 형식은 다음과 같습니다.
GET {serviceApiDomain}/prism/v1/service/channel/{channelId}
요청 헤더
헤더에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| x-prism-access-token | String | OAuth2.0 인증을 통해 발급한 Access Token | Y |
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| channelId | String | 조회 대상 채널 ID | Y |
응답
응답 형식을 설명합니다.
참고
기본 응답 형식은 API 응답 기본 형식을 참고해 주십시오.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| userName | String | B2B PRISM Live Studio에서 노출될 사용자 이름 | Y |
| channel | Object | channel 객체 | Y |
channel DTO
channel DTO에 대한 설명은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| channelId | String | Y | |
| channelName | String | Y | |
| channelEnabled | Boolean | Y | |
| channelLink | String | 채널 홈 주소 | Y |
| channelDescription | String | 채널 설명 | N |
| channelTags | String | 채널 태그 목록, ";"로 구분된 문자열 | N |
| channelThumbnailUrl | String | N | |
| channelFollowerCount | Number | 채널 구독자 수 | N |
예시
구문 예시를 소개합니다.
요청 예시
구문 예시는 다음과 같습니다.
curl -X GET {serviceApiDomain}/prism/v1/service/channel/{channelId}
-H "x-prism-access-token: {access-token}"
응답 예시
구문 예시는 다음과 같습니다.
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"channel": {
"channelId": 1,
"channelName": "어드민TV",
"channelEnabled": true,
"channelLink": "https://prismlive.com",
"channelDescription": "어드민어드민",
"channelTags": "먹방;토크",
"channelThumbnailUrl": "https://thumbnail123.png",
"channelFollowerCount": 999
},
"userName": "관리자"
}
}
이 문서가 도움이 되었습니까?