자동화 캠페인 - API 발송 v2
에픽의 API 발송 기능을 사용할 때 아래 순서에 따라 세팅해주세요.
에픽 콘솔에서 'API 발송' 옵션을 선택하여 자동화 캠페인을 생성한다.
개발자에게 발송을 요청한다.
API Key
API Key는 에픽 로그인 후 마이페이지에서 확인하실 수 있습니다.
요청 URL
API Header
name | description |
---|---|
Authorization | - Bearer ${accessKey} - 마이페이지에서 확인할 수 있는 accessKey |
Method
POST
요청 Body
Parameters
항목 | 필수여부 | type | 설명 | 비고 |
---|---|---|---|---|
title | 선택 | string | 캠페인 제목 | -캠페인 제목과 캠페인 id 중 하나는 무조건 입력해야 한다. |
autoMessageEventId | 선택 | string | 캠페인 id | -캠페인 제목과 캠페인 id 중 하나는 무조건 입력해야 한다. |
recipient | 선택 | object | 수신자정보 | -아래 항목 참조 -최대 1500개 |
recipient.phone | 선택 | string | 수신자 전화번호 | -xxx-xxxx-xxxx 형식 |
recipient.variables | 선택 | object | 메시지 변수 | -#{key1} 에 들어갈 변수명 variables : { "key1" : "effic" } |
nightFallbackHour | 선택 | string | 야간 대체 발송 시간 | -야간시간대에 알람이 발송이 예정되어있다면 nightFallbackHour 시간으로 변경하여 알람을 예약함 -광고성 문자 및 친구톡 캠페인에서만 설정 가능 |
reservationTime | 선택 | string | 예약 시간 | -한국 시간대(KST) 기준 -ISO8601 형식 -야간시간대 (21:55 ~ 08:00) 에 예약 할 수 없습니다. |
Response
항목 | 필수여부 | type | 설명 | 비고 |
---|---|---|---|---|
autoMessageEventId | 필수 | string | 캠페인 id | |
messages | 필수 | object | 발송된 알람 정보 | -아래 항목 참조 -최대 1500개 |
messages.phone | 필수 | string | 알람 수신 번호 | |
messages.traceId | 필수 | string | 알람의 부여되는 id | -발송된 알람에 부여되는 uuid -발송 여부 확인을 식별 |
Error
항목 | 필수여부 | type | 설명 | 비고 |
---|---|---|---|---|
id | 필수 | string | error id | |
message | 필수 | object | error message | |
statusCode | 필수 | string | http status code |
Last updated