MENU
      채팅 조회
        • PDF

        채팅 조회

        • PDF

        기사 요약

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

        참고
        • 라이브에 채팅을 전송하고 조회하고 삭제합니다.
        • 채팅 조회는 약 5초 간격으로 라이브가 종료될 때까지 조회합니다.
        • 채팅 전송/조회/삭제 API가 제공되지 않을 경우, 채팅 기능을 사용할 수 없습니다.
        • 채팅 전송 API만을 제공할 수 있습니다. 단, 이 경우 채팅을 확인할 수 없습니다.

        요청

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

        POST /prism/v1/service/live/{liveId}/chat
        HTTP

        요청 헤더

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

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

        요청 경로 파라미터

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

        이름타입설명필수 여부
        liveIdString라이브 IDY

        요청 바디

        바디에 대한 설명은 다음과 같습니다.

        이름타입설명필수 여부
        maxResultsNumber
      • 가져올 채팅 메시지 최대 개수
      • 최대값은 100이며, 0이거나 100이상일 경우 100개만 제공
      • 0을 지정할 경우, 모든 메시지를 전달
      • Y
        pageTokenString
      • 이전 페이지에서 가져온 데이터 이후의 데이터를 가져올 때 사용
      • pageToken != null 일 경우, 지정된 pageToken 이후의 채팅 메시지 목록을 전달
      • pageToken = null & maxResults != 0 일 경우, 최근 메시지 - maxCount만큼 제공
      • pageToken = null & maxResults = 0 일 경우, 최근 메시지 - 100만큼 제공
      • Y

        응답

        응답 형식을 설명합니다.

        참고

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

        이름타입설명필수 여부
        liveIdString라이브 IDY
        nextPageTokenString
      • 이전에 API로 조회하여 얻은 nextPageToken을 pageToken에 입력하여 조회하면, 새로 입력된 채팅 메시지부터 조회
      • 만일 새로 입력된 채팅 메시지가 없을 경우, nextPageToken은 요청한 pageToken과 동일한 값을 제공
      • Y
        messagesObject
      • 채팅 메시지 목록
      • 채팅 메시지가 없을 경우, 해당 항목은 empty array로 제공
      • Y

        message dto

        message dto에 대한 설명은 다음과 같습니다.

        이름타입설명필수 여부
        messageIdString
      • 채팅 메시지 ID
      • 만일 채팅 삭제 기능이 제공되지 않는다면, messageId는 제공하지 않아도 가능
      • N
        messageAtDate
      • 채팅 메시지가 입력된 시간
      • ISO 8601 형식으로 제공
      • N
        authorIdString
      • 채팅 메시지를 입력한 userId
      • Y
        authorNameString
      • 채팅 메시지를 입력한 user의 이름
      • 이름이 없는 user의 채팅 메시지는 무시 가능
      • Y
        authorProfileThumbnailString
      • 채팅 메시지를 입력한 user의 Thumbnail 이미지
      • authorProfileThumbnail가 없을 경우, thumbnail은 노출되지 않음
      • N
        isLiveOwnerBoolean
      • 해당 채팅의 유저가 현재 라이브의 스트리머인지 여부
      • 프리즘 내 아이디가 다르게 표시될 수 있음
      • 없는 경우, 일반 채팅과 동일하게 표시
      • N
        isLiveManagerBoolean
      • 매니저 기능을 제공하는 경우, 해당 채팅의 유저가 매니저인지 여부
      • 프리즘 내 아이디가 다르게 표시될 수 있음
      • 없는 경우, 일반 채팅과 동일하게 표시
      • N

        page token 제공 방법

        page token 제공 방법은 다음과 같습니다.

        b2bpls-chats_page-token_ko

        예시

        구문 예시를 소개합니다.

        요청 예시

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

        curl -X POST /prism/v1/service/live/{liveId}/chat
            -H "x-prism-access-token: {access-token}"
        Bash

        응답 예시

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

        {
            "success": true,
            "errorCode": 0,
            "errorName": null,
            "message": null,
            "data": {
                "liveId": 6,
                "nextPageToken": 8239,
                "messages": [
                    {
                        "messageId": 12,
                        "message": "채팅 작성 테스트 2023-09-05 11:10:27",
                        "messageAt": "2023-09-05T11:10:27+09:00",
                        "authorId": "admin",
                        "authorName": "관리자",
                        "authorProfileThumbnail": null,
                        "isLiveOwner": true,
                        "isLiveManager": false
                    },
                    {
                        "messageId": 13,
                        "message": "채팅 작성 테스트 2023-09-05 11:25:11",
                        "messageAt": "2023-09-05T11:25:11+09:00",
                        "authorId": "admin",
                        "authorName": "관리자",
                        "authorProfileThumbnail": null,
                        "isLiveOwner": true,
                        "isLiveManager": false
                    }
                ]
            }
        }
        JSON

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

        What's Next
        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.