MENU
      Viewing channel information
        • PDF

        Viewing channel information

        • PDF

        Article summary

        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}
        HTTP

        Request headers

        The description of the header is as follows:

        NameTypeDescriptionRequired
        x-prism-access-tokenStringAccess Token issued through OAuth2.0 authorizationY

        Request path parameters

        The description of the parameters is as follows:

        NameTypeDescriptionRequired
        channelIdStringTargeted channel ID to viewY

        Responses

        This is a description of the response format.

        Note

        For the basic response format, see the Basic format for API responses.

        NameTypeDescriptionRequired
        userNameStringUser name to be exposed in B2B PRISM Live StudioY
        channelObjectChannel objectY

        channel DTO

        The description of the channel DTO is as follows:

        이름타입설명필수 여부
        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

        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}"
        Bash

        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"
            }
        }
        JSON

        Was this article helpful?

        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.