# 자동화 캠페인 - API 발송 v2

{% hint style="info" %}
에픽의 API 발송 기능을 사용할 때 아래 순서에 따라 세팅해주세요.

1. 에픽 콘솔에서 'API 발송' 옵션을 선택하여 자동화 캠페인을 생성한다.
2. 개발자에게 발송을 요청한다.
   {% endhint %}

#### API Key

API Key는 에픽 로그인 후 마이페이지에서 확인하실 수 있습니다.

#### 요청 URL

{% code title="HTTP" %}

```
https://api.effic.biz/auto-message-event/v2/template
```

{% endcode %}

#### API Header

| name          | description                                                  |
| ------------- | ------------------------------------------------------------ |
| Authorization | <p>- Bearer ${accessKey}<br>- 마이페이지에서 확인할 수 있는 accessKey</p> |

#### Method

`POST`

#### 요청 Body

```jsx
{
  "title": "새로운 자동화 캠페인",
  "autoMessageEventId" : 123,
  "recipient": [
    {
      "phone": "010-1234-1234",
      "variables" : 
        { 
          "var1" : "변수명"
        }
    }]
  "nightFallbackHour" : "10"
}
```

**Parameters**

<table><thead><tr><th width="212">항목</th><th width="94">필수여부</th><th width="80">type</th><th width="166">설명</th><th>비고</th></tr></thead><tbody><tr><td>title</td><td>선택</td><td>string</td><td>캠페인 제목</td><td>-캠페인 제목과 캠페인 id 중 하나는 무조건 입력해야 한다.</td></tr><tr><td>autoMessageEventId</td><td>선택</td><td>string</td><td>캠페인 id</td><td>-캠페인 제목과 캠페인 id 중 하나는 무조건 입력해야 한다.</td></tr><tr><td>recipient</td><td>선택</td><td>object</td><td>수신자정보</td><td>-아래 항목 참조<br>-최대 300개</td></tr><tr><td>recipient.phone</td><td>선택</td><td>string</td><td>수신자 전화번호</td><td><p>[전화번호 형식]</p><ul><li>국내 번호: <code>010-2831-8088</code> 또는 <code>01028318088</code></li><li>해외 번호: E.164 표준 형식으로 국가 코드를 포함하여 입력 (예: <code>+13074614920</code>)</li></ul><p><strong>*해외 발송은 알림톡과 친구톡 서비스에 한해 지원됩니다.*</strong></p></td></tr><tr><td>recipient.variables</td><td>선택</td><td>object</td><td>메시지 변수</td><td><p>-#{key1} 에 들어갈 </p><p>변수명 variables : </p><p>{ "key1" : "effic" }</p></td></tr><tr><td>nightFallbackHour</td><td>선택</td><td>string</td><td>야간 대체 발송 시간</td><td><p>-야간시간대에 알람이 발송이 예정되어있다면 nightFallbackHour 시간으로 변경하여 알람을 예약함</p><p><br>-광고성 문자 및 친구톡 캠페인에서만 설정 가능</p></td></tr><tr><td>reservationTime</td><td>선택</td><td>string</td><td>예약 시간</td><td>-한국 시간대(KST) 기준<br><br>-ISO8601 형식<br><br>-야간시간대<br>(21:55 ~ 08:00) 에<br>예약 할 수 없습니다.</td></tr></tbody></table>

Response

```jsx
{
  "autoMessageEventId" : 123,
  "messages" : [
    {
      "phone": "010-1234-1234",
      "traceId" : "38b4d872-29a6-423d-8a76-ac721953ab78"
    }]
}
```

<table><thead><tr><th width="212">항목</th><th width="94">필수여부</th><th>type</th><th width="158">설명</th><th>비고</th></tr></thead><tbody><tr><td>autoMessageEventId</td><td>필수</td><td>string</td><td>캠페인 id</td><td></td></tr><tr><td>messages</td><td>필수</td><td>object</td><td>발송된 알람 정보</td><td>-아래 항목 참조<br>-최대 1500개</td></tr><tr><td>messages.phone</td><td>필수</td><td>string</td><td>알람 수신 번호</td><td></td></tr><tr><td>messages.traceId</td><td>필수</td><td>string</td><td>알람의 부여되는 id</td><td>-발송된 알람에 부여되는 uuid<br><br>-발송 여부 확인을 식별</td></tr></tbody></table>

#### Error&#x20;

<table><thead><tr><th width="236">항목</th><th width="94">필수여부</th><th width="99">type</th><th width="155">설명</th><th>비고</th></tr></thead><tbody><tr><td>id</td><td>필수</td><td>string</td><td>error id</td><td></td></tr><tr><td>message</td><td>필수</td><td>object</td><td>error message</td><td></td></tr><tr><td>statusCode</td><td>필수</td><td>string</td><td>http status code</td><td></td></tr></tbody></table>
