알림 메시지 관리

알림메시지 등록, 수정

post

기능설명

알림 메세지 정보를 등록, 수정합니다.

상세설명

baseNotiMethodCd 는 한 번 등록 후 수정이 불가능합니다.
등록 시 필수 파라미터
- 사이트번호, 메세지구분코드, 적용시작일자, 적용종료일자, 기본알림방법코드, 템플릿명, 제목, 메세지, 사용여부
기본알림방법코드(baseNotiMethodCd)에 따른 추가 필수 파라미터
- baseNotiMethodCd : 30(카카오톡) : kakaoTmplId
- baseNotiMethodCd : 50(알림함) : mbrNotiTypCd
알림메세지 내에 버튼링크 및 버튼URL 이 존재하면 버튼 정보를 함께 저장합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

알림 메세지 등록, 수정 요청 DTO

siteNostring · min: 1Required

사이트번호

Example: 1

notiMsgSeqstringOptional

알림메세지순번

Example: 282

msgGbCdstring · min: 1Required

메세지구분코드(CH008)

Example: 41

aplyStrDtstring · date · min: 1Required

적용시작일자

Example: 20230711

aplyEndDtstring · date · min: 1Required

적용종료일자

Example: 20230731

baseNotiMethodCdstring · min: 1Required

기본알림방법코드(CH009)

Example: 30

tmplNmstring · min: 1Required

템플릿명

Example: 임시비밀번호안내

ttlstring · min: 1Required

제목

Example: 임시비밀번호 안내

msgstring · min: 1Required

메시지

Example: 템플릿 메세지

useYnstring · enum · min: 1Required

사용여부

Example: YPossible values:

sndNostring · min: 1Required

발송번호

Example: 02-554-4668

sndmnNmstring · min: 1Required

발송자명

Example: 플래티어

tmplIdstringOptional

템플릿ID

Example: PO3F

kakaoTmplIdstringOptional

카카오템플릿ID

Example: PO3F

mbrNotiTypCdstringOptional

회원알림유형코드(ME051)

Example: 01

searchDateTypestringOptional

조회기간구분

Example: R

dateSelectstringOptional

조회기간버튼

Example: all_day

notAvailableUpdatebooleanOptional

Responses

200

성공

*/*

stringOptional

900

업무처리 오류 내용

*/*

post/v2/system/noticeMessageMgmt/saveNoticeMessageInfo

POST /api/bo/v2/system/noticeMessageMgmt/saveNoticeMessageInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 478

{
  "siteNo": 1,
  "notiMsgSeq": 282,
  "msgGbCd": 41,
  "aplyStrDt": 20230711,
  "aplyEndDt": 20230731,
  "baseNotiMethodCd": 30,
  "tmplNm": "임시비밀번호안내",
  "ttl": "임시비밀번호 안내",
  "msg": "템플릿 메세지",
  "useYn": "Y",
  "sndNo": "02-554-4668",
  "sndmnNm": "플래티어",
  "tmplId": "PO3F",
  "kakaoTmplId": "PO3F",
  "mbrNotiTypCd": "01",
  "searchDateType": "R",
  "dateSelect": "all_day",
  "btnList": [
    {
      "notiMsgSeq": "text",
      "notiMsgBtnSeq": "text",
      "btnNm": "text",
      "btnUrl": "text"
    }
  ],
  "notAvailableUpdate": true
}

text

템플릿ID 중복체크

post

기능설명

넘어온 템플릿ID 에 대한 중복 체크를 진행합니다.

상세설명

템플릿ID는 필수입니다.
수정 시 동일 알림메세지순번은 중복체크 범위에서 제외해야하기 때문에 수정 시 알림메세지순번은 필수입니다.
기존에 존재하는 템플릿ID일 시 해당 ID로는 신규 알림메시지를 등록할 수 없습니다.
중복된 템플릿ID 가 존재하면 true를 반환하고, 존재하지 않으면 false를 반환합니다.

수정번호

Release v2.00_240425: 멀티 사이트 확장에 따라, 사이트가 다른 경우 템플릿ID 중복 가능하도록 수정

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tmplIdStringRequired

템플릿ID

notiMsgSeqStringOptional

알림메세지순번

Body

알림 메세지 등록, 수정 요청 DTO

siteNostring · min: 1Required

사이트번호

Example: 1

notiMsgSeqstringOptional

알림메세지순번

Example: 282

msgGbCdstring · min: 1Required

메세지구분코드(CH008)

Example: 41

aplyStrDtstring · date · min: 1Required

적용시작일자

Example: 20230711

aplyEndDtstring · date · min: 1Required

적용종료일자

Example: 20230731

baseNotiMethodCdstring · min: 1Required

기본알림방법코드(CH009)

Example: 30

tmplNmstring · min: 1Required

템플릿명

Example: 임시비밀번호안내

ttlstring · min: 1Required

제목

Example: 임시비밀번호 안내

msgstring · min: 1Required

메시지

Example: 템플릿 메세지

useYnstring · enum · min: 1Required

사용여부

Example: YPossible values:

sndNostring · min: 1Required

발송번호

Example: 02-554-4668

sndmnNmstring · min: 1Required

발송자명

Example: 플래티어

tmplIdstringOptional

템플릿ID

Example: PO3F

kakaoTmplIdstringOptional

카카오템플릿ID

Example: PO3F

mbrNotiTypCdstringOptional

회원알림유형코드(ME051)

Example: 01

searchDateTypestringOptional

조회기간구분

Example: R

dateSelectstringOptional

조회기간버튼

Example: all_day

notAvailableUpdatebooleanOptional

Responses

200

성공

*/*

booleanOptional

900

업무처리 오류 내용

*/*

post/v1/system/noticeMessageMgmt/checkDuplicatedTmpId

POST /api/bo/v1/system/noticeMessageMgmt/checkDuplicatedTmpId?tmplId=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 478

{
  "siteNo": 1,
  "notiMsgSeq": 282,
  "msgGbCd": 41,
  "aplyStrDt": 20230711,
  "aplyEndDt": 20230731,
  "baseNotiMethodCd": 30,
  "tmplNm": "임시비밀번호안내",
  "ttl": "임시비밀번호 안내",
  "msg": "템플릿 메세지",
  "useYn": "Y",
  "sndNo": "02-554-4668",
  "sndmnNm": "플래티어",
  "tmplId": "PO3F",
  "kakaoTmplId": "PO3F",
  "mbrNotiTypCd": "01",
  "searchDateType": "R",
  "dateSelect": "all_day",
  "btnList": [
    {
      "notiMsgSeq": "text",
      "notiMsgBtnSeq": "text",
      "btnNm": "text",
      "btnUrl": "text"
    }
  ],
  "notAvailableUpdate": true
}

true

알림메시지 목록 조회

get

기능설명

화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.

상세설명

화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.

수정번호

Release v2.00_240425: 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

msgGbCdStringOptional

알림항목

baseNotiMethodCdStringOptional

알림방법

tmplIdStringOptional

템플릿ID

tmplNmStringOptional

템플릿명

siteNoStringOptional

사이트번호

pageIdxstringRequired

현재 페이지

Example: 1

rowsPerPagestringRequired

페이지 당 row

Example: 10

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v2/system/noticeMessageMgmt/getNoticeMessageList

GET /api/bo/v2/system/noticeMessageMgmt/getNoticeMessageList?noticeMessageInfoRequest=[object+Object]&pageIdx=text&rowsPerPage=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "siteNo": 1,
      "notiMsgSeq": 282,
      "siteNm": "플래티어닷컴",
      "msgGbCd": 41,
      "msgGbNm": "기타",
      "aplyStrDt": 20230711,
      "aplyEndDt": 20230731,
      "baseNotiMethodCd": 30,
      "baseNotiMethodNm": "카카오톡",
      "ttl": "임시비밀번호 안내",
      "msg": "템플릿 메세지",
      "useYn": "Y",
      "stateCd": "PAST",
      "sndNo": "02-554-4668",
      "sndmnNm": "플래티어",
      "tmplNm": "임시비밀번호안내",
      "tmplId": "PO3F",
      "kakaoTmplId": "PO3F",
      "mbrNotiTypCd": "01",
      "mbrNotiTypNm": "주문",
      "btnList": [
        {
          "notiMsgSeq": "text",
          "notiMsgBtnSeq": "text",
          "btnNm": "text",
          "btnUrl": "text"
        }
      ],
      "hasMultiLang": true,
      "availableMl": true
    }
  ]
}

알림메시지 단건 조회

get

기능설명

넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.

상세설명

넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.
쿠기값의 dataLangCd 기준으로 조회합니다.
알림메세지 순번은 필수입니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

notiMsgSeqStringRequired

알림메세지순번

Responses

200

성공

*/*

알림메세지 조회 응답 DTO

siteNostringOptional

사이트번호

Example: 1

notiMsgSeqstringOptional

알림메세지순번

Example: 282

siteNmstringOptional

사이트명

Example: 플래티어닷컴

msgGbCdstringOptional

메세지구분코드(CH008)

Example: 41

msgGbNmstringOptional

메세지구분명

Example: 기타

aplyStrDtstringOptional

적용시작일자

Example: 20230711

aplyEndDtstringOptional

적용종료일자

Example: 20230731

baseNotiMethodCdstringOptional

기본알림방법코드(CH009)

Example: 30

baseNotiMethodNmstringOptional

기본알림방법

Example: 카카오톡

ttlstringOptional

제목

Example: 임시비밀번호 안내

msgstringOptional

메시지

Example: 템플릿 메세지

useYnstring · enumOptional

사용여부

Example: YPossible values:

stateCdstringOptional

상태코드

Example: PAST

sndNostringOptional

발송번호

Example: 02-554-4668

sndmnNmstringOptional

발송자명

Example: 플래티어

tmplNmstringOptional

템플릿명

Example: 임시비밀번호안내

tmplIdstringOptional

템플릿ID

Example: PO3F

kakaoTmplIdstringOptional

카카오템플릿ID

Example: PO3F

mbrNotiTypCdstringOptional

회원알림유형코드(ME051)

Example: 01

mbrNotiTypNmstringOptional

회원알림유형

Example: 주문

hasMultiLangbooleanOptional

다국어 존재 여부

Example: true

availableMlbooleanOptional

900

업무처리 오류 내용

*/*

get/v2/system/noticeMessageMgmt/getNoticeMessageInfo

GET /api/bo/v2/system/noticeMessageMgmt/getNoticeMessageInfo?noticeMessageInfoRequest=[object+Object]&notiMsgSeq=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "notiMsgSeq": 282,
  "siteNm": "플래티어닷컴",
  "msgGbCd": 41,
  "msgGbNm": "기타",
  "aplyStrDt": 20230711,
  "aplyEndDt": 20230731,
  "baseNotiMethodCd": 30,
  "baseNotiMethodNm": "카카오톡",
  "ttl": "임시비밀번호 안내",
  "msg": "템플릿 메세지",
  "useYn": "Y",
  "stateCd": "PAST",
  "sndNo": "02-554-4668",
  "sndmnNm": "플래티어",
  "tmplNm": "임시비밀번호안내",
  "tmplId": "PO3F",
  "kakaoTmplId": "PO3F",
  "mbrNotiTypCd": "01",
  "mbrNotiTypNm": "주문",
  "btnList": [
    {
      "notiMsgSeq": "text",
      "notiMsgBtnSeq": "text",
      "btnNm": "text",
      "btnUrl": "text"
    }
  ],
  "hasMultiLang": true,
  "availableMl": true
}

이전권한 그룹 관리 다음개별 권한 관리

마지막 업데이트 3일 전