고객 지원 공지 목록 조회

Prev Next
This content is currently unavailable in Ja - 日本語. You are viewing the default (Korean) version.

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

고객 지원 화면의 공지 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /v2/stories/{boardId}

요청 헤더

GAMEPOT 3.0 API에서 공통으로 사용하는 헤더에 대한 정보는 GAMEPOT 3.0 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

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

필드 타입 필수 여부 설명
boardId String Required 보드 아이디
  • cs_notice (유효 값)

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
filter String Required 필터링 조건
  • 응답 바디의 일부 필드를 기준으로 필터링
  • 전체 일치하는 값만 필터링
  • 조건이 없는 경우, 빈 값 {} 입력
  • <예시> {"author_id":"{작성자아이디}"}, {"id":"{공지아이디}"}, {"required":false}
sort String Optional 정렬 기준
  • {기준:방식} 형태로 입력
    • 기준: 응답 바디의 String 타입 필드
    • 방식: -1 | 1
      • -1: 내림차순
      • 1: 오름차순
  • <예시> {"createdAt":"-1"}: 생성 일시 기준 내림차순
option String Optional 추가 옵션: Option
  • <예시> {"offset":0,"per_page":20}: 첫 번째 항목부터 20개 표시

Option

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

필드 타입 필수 여부 설명
offset Integer Optional 조회 시작 오프셋
  • 0~N
per_page Integer Optional 페이지당 항목 수
  • 1~100

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.gamepot.ntruss.com/v2/stories/cs_notice?filter=%7B%22required%22%3Afalse%7D&sort=%7B%22createdAt%22%3A%20%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
totalCount Integer - 전체 응답 수
stories Array - 공지 목록: stories

stories

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

필드 타입 필수 여부 설명
required Boolean - 필수 여부
  • true | false
    • true: 필수
    • false: 필수 아님
hit Integer - 조회 수
_id String - 객체 아이디
title Array - 공지 제목: title
category_id String - 보드 아이디
status Integer - 공지 사용 여부
  • 1 | 0
    • 1: 사용 중
    • 0: 사용 안 함
text Array - 공지 내용: text
project_id String - 프로젝트 아이디
author_id String - 작성자 아이디
id String - 공지 아이디
createdAt String - 공지 생성 일시
  • ISO 8601 형식
updatedAt String - 공지 수정 일시
  • ISO 8601 형식
__v Integer - 버전 키
참고

_id, __v는 응답 결과에 노출될 수 있으나 서비스 사용에 영향을 주지 않는 필드입니다.

title

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

필드 타입 필수 여부 설명
lang String - 언어 코드
value String - 공지 제목
default Boolean - 기본 언어 여부
  • true | false
    • true: 기본 언어
    • false: 기본 언어 아님

text

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

필드 타입 필수 여부 설명
lang String - 언어 코드
value String - 공지 내용
default Boolean - 기본 언어 여부
  • true | false
    • true: 기본 언어
    • false: 기본 언어 아님

응답 상태 코드

GAMEPOT 3.0 API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 GAMEPOT 3.0 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "totalCount": 2,
  "stories": [
    {
      "required": false,
      "hit": 0,
      "_id": "68d5d78991f09a68dbbf908a",
      "title": [
        {
          "lang": "ko",
          "value": "[테스트 공지] 고객 지원 페이지 공지사항 기능 확인",
          "default": true
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p data-start=\"141\" data-end=\"239\"><span style=\"color: rgb(185, 106, 217);\">이 글은 <strong data-start=\"146\" data-end=\"159\">내부 QA 테스트</strong>를 위해 등록된 게시글입니다.</span><br data-start=\"175\" data-end=\"178\"><span style=\"color: rgb(185, 106, 217);\">실제 서비스 공지와는 무관하며, 공지사항 등록&middot;조회&middot;삭제 기능이 정상적으로 작동하는지 확인하는 목적입니다.</span></p>\n<p data-start=\"241\" data-end=\"249\"><span style=\"color: rgb(185, 106, 217);\">감사합니다.</span></p>",
          "default": true
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "a5500dbf-****-****-****-eb2329918aa5",
      "createdAt": "2025-09-26T00:00:09.954Z",
      "updatedAt": "2025-09-26T00:00:09.954Z",
      "__v": 0
    },
    {
      "required": false,
      "hit": 0,
      "_id": "68d096fdc9abf71dd89dacac",
      "title": [
        {
          "lang": "ko",
          "value": "Announcement",
          "default": true
        },
        {
          "lang": "en",
          "value": "Announcement",
          "default": false
        }
      ],
      "category_id": "cs_notice",
      "status": 1,
      "text": [
        {
          "lang": "ko",
          "value": "<p>Dear users,</p>\n<p>&nbsp;</p>\n<p>Hi. This is the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": true
        },
        {
          "lang": "en",
          "value": "<p>Dear User,</p>\n<p>&nbsp;</p>\n<p>Hello. This article is about the announcement.</p>\n<p>&nbsp;</p>\n<p>Thank you.</p>",
          "default": false
        }
      ],
      "project_id": "fccec9bc-****-****-****-d2df78e0d987",
      "author_id": "b2dfa23b-****-****-****-0f392a4175fb",
      "id": "e5d72544-****-****-****-b9cbbfd0859b",
      "createdAt": "2025-09-22T00:23:25.230Z",
      "updatedAt": "2025-09-26T00:05:32.708Z",
      "__v": 0
    }
  ]
}