API 캠페인 발송하기

API 캠페인 발송 방법에 대해 알아봅니다.

API 캠페인이란?

  • 이벤트 기반 또는 즉시성이 중요한 경우 사용됩니다.

  • 캠페인별로 API 연동 개발 작업이 필요합니다.

  • 워크스페이스별로 권한을 개별 부여하고 있습니다. API 발송 기능 사용을 원하시는 경우, 에픽 담당자에게 문의해 주세요.


API 캠페인 생성

  1. CRM 자동화 메뉴를 클릭하고 [새로운 자동화 캠페인]을 클릭합니다.

  1. 발송 매체를 선택합니다.

STEP 1. 발송 내용

  • 제목, 내용, 이미지, 광고 여부 등을 설정할 수 있습니다.

  • 입력 내용은 발송 매체별로 상이하니 매체별 가이드를 참고해 주세요 .

  • 변수

    • 제목, 내용 등 콘텐츠에 변수를 사용할 수 있습니다.

    • API 캠페인의 경우, 테스트 발송 시 변수는 실제 값으로 치환되지 않고 #{변수명} 형태로 발송됩니다.

  • 광고 메시지 여부

    • 정보통신망법상 표기의무 준수를 위해 메시지 내용에 '(광고)' 안내 문구가 자동으로 입력됩니다.

      광고 메시지 가이드 확인하기

    • API 캠페인의 경우, 야간 시간대에 발송된 광고 메시지는 발송 요청 실패 처리됩니다.

STEP 2. 개발자 세팅

에픽에서 캠페인 세팅을 완료하신 후, 아래 정보를 개발자에게 전달해주세요.

  • 캠페인 ID

캠페인 ID는 어디서 확인하나요?

캠페인 생성이 완료된 후, 발송 상세 화면 좌측 상단에서 확인할 수 있어요.

  • 발송 대상

  • 발송 시점

    • 특정 이벤트 발생 시, 즉시 발송 또는 예약 발송이 가능합니다.

    • 예약 발송은 현재 시점으로부터 최소 10분 후, 최대 10일 이내로 설정할 수 있습니다.

  • 사용한 변수명과 치환될 값

개발 요청 TIP

개발 요청 시 API 발송 가이드를 함께 전달하면 더 원활하게 커뮤니케이션할 수 있어요.

캠페인 수정

  • 캠페인 수정은 캠페인 비활성화 상태에만 가능합니다.

  • 최대 30초간 캠페인 변경 사항이 반영되지 않을 수 있습니다.

구분
수정 가능 여부

발송 매체

X

발송 내용

O (단, 친구톡 유형 수정 불가)

발송 히스토리

  • 발송 성공/실패 여부는 ‘발송 히스토리’에서 확인할 수 있습니다.

  • 단, 요청이 성공한 메시지에 한해서만 히스토리에 기록됩니다. (요청 자체가 실패한 경우에는 개발자를 통해 성공/실패 여부를 확인해야 합니다.)

  • 에픽 콘솔에서는 최대 최근 7일간의 발송 내역만 확인할 수 있습니다. API 조회의 경우, 최대 90일 이내의 기록을 7일 단위로 나누어 조회할 수 있습니다.

Last updated