알림함

알림함 조회

get

기능설명

• 회원의 알림함 리스트를 조회합니다.

---

상세설명

• 로그인은 필수입니다.

• 최신 등록 순으로 조회합니다.

• 파라미터로 회원알림유형코드(mbrNotiTypCd)이 넘어왔을 경우 해당 알림유형코드의 알림함 정보만 조회합니다.

---

수정번호

• Release v2.00_240401: 알림함 읽음 처리 추가, RequestParam pageIdx 추가

Query parameters

mbrNotiTypCdstring · enumOptional

ME051(회원알림유형코드)

• 01 : 주문
• 02 : 문의
• 03 : 마이페이지
• 04 : 재입고 안내
• 05 : 사은품
• 06 : 고객센터
• 12 : 쿠폰
• 13 : 회원
• 14 : 추천인ID 등록 안내

Example: 01Possible values:

pageIdxinteger · int32Optional

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

알림함 조회 Response

totCntinteger · int64Optional

알림함 조회 총 건수

900

업무처리 오류 내용

*/*

get

/v1/notibox/notiInfo

HTTPcURLJavaScriptPython

GET /api/member/v1/notibox/notiInfo HTTP/1.1
Host: localhost:8091/
Accept: */*

{
  "totCnt": 1,
  "notiList": [
    {
      "mbrNotiDt": "2023-09-12",
      "notiDtlList": [
        {
          "mbrNotiSeq": 1,
          "mbrNotiTypCd": "01",
          "mbrNotiTypNm": "text",
          "mbrNotiDtm": "2026-02-27T19:43:30.598Z",
          "mbrNotiTitle": "text",
          "mbrNotiConts": "text",
          "qryYn": "text",
          "notiBtnList": [
            {
              "mbrNotiBtnSeq": "text",
              "btnNm": "text",
              "btnUrl": "text"
            }
          ]
        }
      ]
    }
  ]
}

알림함 등록

post

기능설명

• 알림함을 등록합니다.

---

상세설명

• 각 모듈에서 처리 로직 후 알림함 등록 API(/api/common/v1/common/sendMessage, /api/common/1/common/sendMessageList)를 통해 해당 API를 호출합니다.

• 알림함 정보에 버튼이 존재할 경우 알림함 버튼리스트를 함께 등록합니다.

• 각 알림함에 대한 정보를 참조값에 저장할 수 있습니다.

Query parameters

notiBoxRegisterRequeststringRequired

NotiBoxRegisterRequest

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

알림함 등록 Request

mbrNostringRequired

회원번호

Example: 100001641

mbrNotiTypCdstring · enumRequired

회원알림유형코드

Example: 01Possible values:

mbrNotiTitlestringRequired

알림함 제목

Example: 알림함 제목

mbrNotiContsstringRequired

알림함 내용

Example: 알림함 내용

ref1ValstringOptional

참조값1

ref2ValstringOptional

참조값2

ref3ValstringOptional

참조값3

ref4ValstringOptional

참조값4

ref5ValstringOptional

참조값5

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post

/v1/notibox/notiInfo

HTTPcURLJavaScriptPython

POST /api/member/v1/notibox/notiInfo?notiBoxRegisterRequest=text HTTP/1.1
Host: localhost:8091/
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "mbrNo": 100001641,
  "mbrNotiTypCd": "01",
  "mbrNotiTitle": "알림함 제목",
  "mbrNotiConts": "알림함 내용",
  "ref1Val": "text",
  "ref2Val": "text",
  "ref3Val": "text",
  "ref4Val": "text",
  "ref5Val": "text",
  "btnList": [
    {
      "mbrNotiSeq": 1,
      "mbrNotiBtnSeq": 1,
      "btnNm": "버튼명",
      "btnUrl": "https://fo.x2bee.com/PM/myQAList"
    }
  ]
}

No content

알림함 읽음처리

put

기능설명

• 알림함 읽음처리를 수정합니다.

---

상세설명

• 알림함을 읽었을 때 조회여부를 Y로 수정합니다.

• 로그인은 필수입니다.

Query parameters

notiBoxModifyRequeststringRequired

NotiBoxModifyRequest

userDetailstringRequired

UserDetail

Header parameters

AuthorizationanyOptional

Access Token

Body

application/json

알림함 수정 Request

mbrNotiSeqstringOptional

회원 알림 순번

Example: 1

qryYnstring · enumOptional

알림 조회여부

Example: YPossible values:

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

put

/v1/notibox/notiInfo

HTTPcURLJavaScriptPython

PUT /api/member/v1/notibox/notiInfo?notiBoxModifyRequest=text&userDetail=text HTTP/1.1
Host: localhost:8091/
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "mbrNotiSeq": 1,
  "qryYn": "Y"
}

No content