채널 정보 조회
    • PDF

    채널 정보 조회

    • PDF

    기사 요약

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

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

    요청

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

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

    요청 헤더

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

    이름타입설명필수 여부
    x-prism-access-tokenStringOAuth2.0 인증을 통해 발급한 Access TokenY

    요청 경로 파라미터

    파라미터에 대한 설명은 다음과 같습니다.

    이름타입설명필수 여부
    channelIdString조회 대상 채널 IDY

    응답

    응답 형식을 설명합니다.

    참고

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

    이름타입설명필수 여부
    userNameStringB2B PRISM Live Studio에서 노출될 사용자 이름Y
    channelObjectchannel 객체Y

    channel DTO

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

    이름타입설명필수 여부
    channelIdString
  • 서비스에서 채널을 구분할 수 있는 값
  • 채널을 지원하지 않는 서비스의 경우, userId를 사용
  • Y
    channelNameString
  • B2B PRISM Live Studio에서 노출될 채널 이름
  • 채널을 지원하지 않는 서비스의 경우, userName을 사용
  • Y
    channelEnabledBoolean
  • 현재 채널의 활성화 여부. channelEnabled = false일 경우, 해당 채널에서는 방송을 시작할 수 없음
  • 방송 도중 channelEnabled = false로 바뀔 경우, 방송을 강제로 중단
  • 채널의 상태 외에도, 채널을 소유한 유저가 차단되거나 탈퇴하는 등, 해당 채널로 방송을 할 수 없다면, false를 제공
  • Y
    channelLinkString채널 홈 주소Y
    channelDescriptionString채널 설명N
    channelTagsString채널 태그 목록, ";"로 구분된 문자열N
    channelThumbnailUrlString
  • 채널의 썸네일 주소
  • 해당 채널을 통해 방송을 시작할 때 갱신됨
  • http url 형태로 제공
  • N
    channelFollowerCountNumber채널 구독자 수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": "관리자"
        }
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.