발송 결과 조회

발송 결과를 자사 DB에 적재하고자 할 때 이 API를 사용합니다.

API Key

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

요청 URL

HTTP

https://api.effic.biz/target/history

API Header

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

Method

POST

요청 Body

{
  "phoneNumber": "string",
  "organizationName": "string"
}

Parameters

항목	필수여부	타입	설명	비고
phoneNumber	선택	string	전화번호
organaizationName	필수	string	회사 식별값	메일의 %@${organizationName}.% 으로 식별합니다 (e.g.teamsparta)

응답 Body

{
  "sentAt": Date
  "completedAt": Date
  "status": 'success' | 'processing' | 'fail'
  "messageMethod": 'SMS' | 'ALIMTALK'
  "sendType": 'AUTO' | 'MANUAL'
  "messageTitle": string
  "messageSubTitle": string
  "messageContent": string
  //자동 발송의 경우
  "autoMessageEventName": string
  //문자일 경우
  "hostNumber": string
  //알림톡일 경우
  "channelId": string
  "templateCode": string
  "templateEmphasizeType": 'NONE' | 'TEXT' | 'IMAGE' | 'ITEM_LIST'
  "templateMessageType": 'BA' | 'EX' | 'AD' | 'MI'
  "messageSubTitle": string
  "imageUrl": string 
  "itemList": json 
  "templateExtra": string
  "buttons": json
}

항목	필수여부	타입	설명	비고
sentAt	필수	Date	발송 시도 시간
completedAt	선택	Date	발송 완료 시간
status	선택	string	발송상태	'success' 'processing' 'fail'
messageMethod	필수	string	발송매체	'SMS' 'ALIMTALK'
sendType	필수	string	자동발송, 수동발송	'AUTO' 'MANUAL'
messageTitle	필수	string	메시지 제목
messageSubTitle	선택	string	메시지 부제목
messageContent	필수	string	메시지 본문
autoMessageEventName	선택	string	자동화 캠페인 이름	자동 발송의 경우
hostNumber	선택	string	발신번호	문자일 경우
channelId	선택	string	알림톡 채널명	알림톡일 경우
templateCode	선택	string	알림톡 템플릿 코드
templateEmphasizeType	선택	string	알림톡 강조 유형	'NONE': 기본형 'TEXT': 강조표기형 'IMAGE': 이미지형 'ITEM_LIST': 아이템리스트형
templateMessageType	선택	string	알림톡 메시지 유형	'BA': 기본형 'EX': 부가정보형 'AD': 채널추가형 'MI':복합형
messageSubTitle	선택	string	강조표기형의 부제목
imageUrl	선택	string	이미지형의 이미지 url
itemList	선택	json	아이템 리스트형의 아이템 리스트 정보
templateExtra	선택	string	부가 정보
buttons	선택	json	CTA 정보 (버튼)