Viewing channel list

Prev Next

Available in Classic and VPC

It is an API to view the user channel list. 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/list

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

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
channels Object Channel list Y

channel DTO

The description of the channel DTO is as follows:

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

    Examples

    Introduces examples of syntax.

    Request examples

    An example of the syntax is as follows:

    curl -X GET {serviceApiDomain}/prism/v1/service/channel/list
    -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": {
        "channels": [
            {
                "channelId": 2a7b15c5,
                "channelName": "Channelro4",
                "channelEnabled": true,
                "channelLink": "https://prismlive.com",
                "channelDescription": "This is the Channelro4 channel.",
                "channelTags": "mukbang",
                "channelThumbnailUrl": null,
                "channelFollowerCount": 12345
            },
            {
                "channelId": 2e284f3g,
                "channelName": "Channel62k",
                "channelEnabled": false,
                "channelLink": "https://prismlive.com",
                "channelDescription": "This is the Channel62k channel.",
                "channelTags": null,
                "channelThumbnailUrl": null,
                "channelFollowerCount": 12345
            },
            {
                "channelId": 18243eab,
                "channelName": "Channeliq4",
                "channelEnabled": true,
                "channelLink": "https://prismlive.com",
                "channelDescription": "This is a new channel created in postman.",
                "channelTags": "mukbang",
                "channelThumbnailUrl": null,
                "channelFollowerCount": 0
            }
        ],
        "userName": "Admin"
    }
}