일회성 메시지 - API 발송

에픽의 API 발송 기능을 사용할 때 아래 순서에 따라 세팅해주세요.

1. 에픽 콘솔에서 'API 발송' 옵션을 선택하여 자동화 캠페인을 생성한다.

2. 개발자에게 발송을 요청한다.

API Key

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

요청 URL

HTTP

https://api.effic.biz/one-time-message/template

API Header

name	description
Authorization	- Bearer ${accessKey} - 마이페이지에서 확인할 수 있는 accessKey

Method

POST

요청 Body

{
  "messageContent" : "문자 내용",
  "hostNumber": "010-1234-1234",
  "recipient": [
    {
      "phone": "010-1234-1234",
      "variables" : 
        { 
          "var1" : "변수명"
        }
    }],
  "messageTitle": "문자 제목",
  "nightFallbackHour" : "10",
  "reservationTime" : "2024-09-06T00:55:02.508881+09:00",
  "advertiserInfo": true,
  "advertiseTitle": "에픽",
  "nightFallbackHour": "10"
}

Parameters

항목	필수여부	type	설명	비고
messageContent	필수	string	메시지 내용	-#{} 를 사용해 변수를 포함시킬 수 있음
hostNumber	필수	string	발신번호	-워크 스페이스에 등록된 발신번호 만 사용 가능
recipient	필수	object	수신자정보	-아래 항목 참조 -최대 1500개
recipient.phone	필수	string	수신자 전화번호	-xxx-xxxx-xxxx 형식
recipient.variables	선택	object	메시지 변수	-#{} 에 들어갈 변수명
advertiseInfo	선택	boolean	광고성 알람 여부
advertiseTitle	선택	string	브랜드명	광고성 알람일 경우 필수값
nightFallbackHour	선택	string	야간 대체 발송 시간	-야간시간대에 알람이 발송이 예정 되어 있다면nightFallbackHour 시간으로 변경하여 알람을 예약함 -광고성 문자 및 친구톡 캠페인에서만 설정 가능
reservationTime	선택	string	-예약 시간	-한국 시간대(KST) 기준 -ISO8601 형식 -야간시간대 (21:55 ~ 08:00)에 예약 할 수 없습니다.

Response

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

::

항목	필수여부	type	설명	비고
oneTimeMessageEventId	필수	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