캠페인 관리

캠페인 등록(발동)

post

기능설명

캠페인을 등록하고 그 자리에서 발송을 요청합니다. 저장과 발송이 분리돼 있지 않습니다.

상세설명

세그먼트의 최종 계산 결과를 발송 대상자로 적재하고, 발송 헤더를 발송대기(20)로 만듭니다.
커밋되는 순간 batch-mbod 가 집어가 실제 발송을 수행합니다.
사용 상태가 아니거나 대상자 계산이 없는 세그먼트, 대상자 0건이면 거부합니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

캠페인 등록 요청

siteNostring · min: 1Required

사이트번호

Example: 1

cmpgnNmstring · max: 100Required

캠페인명

cmpgnDescstring · max: 1000Optional

캠페인설명

sgmtNostring · min: 1Required

대상 세그먼트번호

Example: SG00000001

actTypCdstring · min: 1Required

액션유형코드(ME025) 10 SMS / 20 이메일

Example: 10Pattern: 10|20

msgTitlestring · max: 1000Optional

메시지 제목 — 이메일 필수, SMS 미사용

msgContsstring · min: 1Required

메시지 본문. SMS 는 4000자 상한(ST_MSG_SND_BASE.MSG_CONTS)

msgTypCdstringOptional

메시지유형코드(CM021) COMM 정보성 / AD 광고성 — SMS 필수

Example: AD

msgSndTypCdstringOptional

메시지발송유형코드(CM020) SMS / LMS / MMS — SMS 필수

Example: SMS

recvmnVetoNoCdstringOptional

회신거부번호코드(ST019) — SMS 선택

emailTypCdstringOptional

이메일유형코드 — 이메일 필수

emailTrgmnTypCdstringOptional

이메일수신자유형코드 — 이메일 필수

Responses

200

성공

*/*

캠페인 등록(발동) 결과

cmpgnNostringOptional

채번된 캠페인번호

Example: CP00000001

sndNostringOptional

생성된 발송번호

trgtCntinteger · int64Optional

적재한 대상자수

900

업무처리 오류 내용

*/*

post/v1/marketing/campaignMgmt/saveCampaign

POST /api/bo/v1/marketing/campaignMgmt/saveCampaign HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "siteNo": 1,
  "cmpgnNm": "text",
  "cmpgnDesc": "text",
  "sgmtNo": "SG00000001",
  "actTypCd": 10,
  "msgTitle": "text",
  "msgConts": "text",
  "msgTypCd": "AD",
  "msgSndTypCd": "SMS",
  "recvmnVetoNoCd": "text",
  "emailTypCd": "text",
  "emailTrgmnTypCd": "text"
}

{
  "cmpgnNo": "CP00000001",
  "sndNo": "text",
  "trgtCnt": 1
}

캠페인 발송취소

post

기능설명

캠페인의 발송을 취소합니다. 캠페인의 유일한 상태 변경입니다.

상세설명

발송대기(20) 상태일 때만 가능합니다. 이미 발송중이거나 완료됐으면 거부합니다.
액션유형에 따라 SMS · 이메일 발송 헤더를 서버가 골라 바꿉니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

캠페인 발송취소 요청

cmpgnNostring · min: 1Required

캠페인번호

Example: CP00000001

Responses

200

성공

No content

900

업무처리 오류 내용

*/*

post/v1/marketing/campaignMgmt/cancelCampaign

POST /api/bo/v1/marketing/campaignMgmt/cancelCampaign HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "cmpgnNo": "CP00000001"
}

No content

캠페인 상세 조회

get

기능설명

캠페인 상세와 발송현황(성공 · 미발송 · 대기)을 조회합니다.

상세설명

발송 성공 건수는 대상자수보다 작을 수 있습니다. 배치가 수신동의로 걸러내기 때문입니다.
미발송은 수신거부 · 연락처없음 등으로 배치가 제외한 건입니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cmpgnNoStringRequired

캠페인번호

Example: CP00000001

Responses

200

성공

*/*

캠페인 상세

cmpgnNostringOptional

캠페인번호

Example: CP00000001

cmpgnNmstringOptional

캠페인명

cmpgnDescstringOptional

캠페인설명

sgmtNostringOptional

세그먼트번호

sgmtNmstringOptional

세그먼트명 — LEFT JOIN 결과

calcNostringOptional

발동에 사용한 계산번호

actTypCdstringOptional

액션유형코드(ME025)

sndNostringOptional

발송번호

trgtCntinteger · int64Optional

대상자수 — 발동 시점 스냅샷

sndStatCdstringOptional

발송상태코드(CM018) — 이 값이 곧 캠페인 상태다

sndStrDtmstring · date-timeOptional

발송 시작일시

sndEndDtmstring · date-timeOptional

발송 종료일시

msgTitlestringOptional

메시지 제목

msgContsstringOptional

메시지 본문

sndSuccCntinteger · int64Optional

발송 성공 건수 — 수신동의로 걸러진 만큼 대상자수보다 작다

sndImpsCntinteger · int64Optional

미발송 건수 — 수신거부·연락처없음 등으로 배치가 제외한 건

sndWaitCntinteger · int64Optional

발송 대기 건수

900

업무처리 오류 내용

*/*

get/v1/marketing/campaignMgmt/getCampaign

GET /api/bo/v1/marketing/campaignMgmt/getCampaign?cmpgnNo=null HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cmpgnNo": "CP00000001",
  "cmpgnNm": "text",
  "cmpgnDesc": "text",
  "sgmtNo": "text",
  "sgmtNm": "text",
  "calcNo": "text",
  "actTypCd": "text",
  "sndNo": "text",
  "trgtCnt": 1,
  "sndStatCd": "text",
  "sndStrDtm": "2026-01-01T00:00:00.000Z",
  "sndEndDtm": "2026-01-01T00:00:00.000Z",
  "msgTitle": "text",
  "msgConts": "text",
  "sndSuccCnt": 1,
  "sndImpsCnt": 1,
  "sndWaitCnt": 1
}

캠페인 목록 조회

get

기능설명

캠페인 목록을 조회합니다. 각 행에 세그먼트명과 발송상태가 함께 나옵니다.

상세설명

발송상태(CM018)가 곧 캠페인 상태입니다. 캠페인에는 별도 상태 컬럼이 없습니다.
대상자수는 발동 시점 스냅샷입니다. 세그먼트를 재계산해도 변하지 않습니다.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchConditionstringOptional

조회조건 — cmpgnNm 캠페인명 / cmpgnNo 캠페인번호

Example: cmpgnNm

searchConditionContentsstringOptional

조회조건 내용. 비어 있으면 조건 자체가 빠진다

actTypCdstringOptional

액션유형코드(ME025) 10 SMS / 20 이메일

Example: 10

sndStatCdstringOptional

발송상태코드(CM018). 발송 테이블 조인 결과로 거른다

Example: 20

regDtmFrstringOptional

등록일 시작(yyyy-MM-dd)

Example: 2026-08-01

regDtmTostringOptional

등록일 종료(yyyy-MM-dd) — 해당일 24시까지 포함한다

Example: 2026-08-31

Responses

200

성공

*/*

totalCountinteger · int32Optional

900

업무처리 오류 내용

*/*

get/v1/marketing/campaignMgmt/getCampaignList

GET /api/bo/v1/marketing/campaignMgmt/getCampaignList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "payloads": [
    {
      "cmpgnNo": "CP00000001",
      "cmpgnNm": "text",
      "sgmtNo": "SG00000001",
      "sgmtNm": "text",
      "actTypCd": 10,
      "trgtCnt": 1,
      "sndStatCd": "text"
    }
  ]
}

이전이벤트 댓글 관리

다음이벤트 응모이력

마지막 업데이트 2일 전