채널 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

사용자 채널 목록을 조회하는 API입니다. B2B PRISM Live Studio에서의 사용 플로우를 확인하려면 방송 시작 프로세스를 참고해 주십시오.

요청

요청 형식은 다음과 같습니다.

GET {serviceApiDomain}/prism/v1/service/channel/list

요청 헤더

헤더에 대한 설명은 다음과 같습니다.

이름 타입 설명 필수 여부
x-prism-access-token String OAuth2.0 인증을 통해 발급한 Access Token Y

응답

응답 형식을 설명합니다.

참고

기본 응답 형식은 API 응답 기본 형식을 참고해 주십시오.

이름 타입 설명 필수 여부
userName String B2B PRISM Live Studio에서 노출될 사용자 이름 Y
channels Object channel 목록 Y

channel DTO

channel DTO에 대한 설명은 다음과 같습니다.

이름 타입 설명 필수 여부
channelId String
  • 서비스에서 채널을 구분할 수 있는 값
  • 채널을 지원하지 않는 서비스의 경우, userId를 사용
    		•  Y
    channelName String
  • B2B PRISM Live Studio에서 노출될 채널 이름
  • 채널을 지원하지 않는 서비스의 경우, userName을 사용
    		•  Y
    channelEnabled Boolean
  • 현재 채널의 활성화 여부. channelEnabled = false일 경우, 해당 채널에서는 방송을 시작할 수 없음
  • 방송 도중 channelEnabled = false로 바뀔 경우, 방송을 강제로 중단
  • 채널의 상태 외에도, 채널을 소유한 유저가 차단되거나 탈퇴하는 등, 해당 채널로 방송을 할 수 없다면, false를 제공
    		•  Y
    channelLink String 채널 홈 주소 Y
    channelDescription String 채널 설명 N
    channelTags String 채널 태그 목록, ";"로 구분된 문자열 N
    channelThumbnailUrl String
  • 채널의 썸네일 주소
  • 해당 채널을 통해 방송을 시작할 때 갱신됨
  • http url 형태로 제공
    		•  N
    channelFollowerCount Number 채널 구독자 수 N

    예시

    구문 예시를 소개합니다.

    요청 예시

    구문 예시는 다음과 같습니다.

    curl -X GET {serviceApiDomain}/prism/v1/service/channel/list
    -H "x-prism-access-token: {access-token}"

    응답 예시

    구문 예시는 다음과 같습니다.

    {
    "success": true,
    "errorCode": 0,
    "errorName": null,
    "message": null,
    "data": {
        "channels": [
            {
                "channelId": 2a7b15c5,
                "channelName": "채널ro4",
                "channelEnabled": true,
                "channelLink": "https://prismlive.com",
                "channelDescription": "채널ro4 채널입니다.",
                "channelTags": "먹방",
                "channelThumbnailUrl": null,
                "channelFollowerCount": 12345
            },
            {
                "channelId": 2e284f3g,
                "channelName": "채널62k",
                "channelEnabled": false,
                "channelLink": "https://prismlive.com",
                "channelDescription": "채널62k 채널입니다.",
                "channelTags": null,
                "channelThumbnailUrl": null,
                "channelFollowerCount": 12345
            },
            {
                "channelId": 18243eab,
                "channelName": "채널iq4",
                "channelEnabled": true,
                "channelLink": "https://prismlive.com",
                "channelDescription": "포스트맨에서 생성한 신규 채널입니다.",
                "channelTags": "먹방",
                "channelThumbnailUrl": null,
                "channelFollowerCount": 0
            }
        ],
        "userName": "관리자"
    }
}