메시지 발송 결과(WebHook)

SMS, LMS, MMS의 결과값을 고객사 callback URL로 전달합니다.

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX ➡ 고객사 URL)

고객사 callback URL 정보는 서비스 신청 시 입력하거나 [서비스 콘솔 / 연동 정보 / Callback URL]에서 수정할 수 있습니다.

고객사 callback URL에 대한 API PLEX의 접근을 허용해야 합니다. (IP, PORT)

고객사 server에서 webhook을 수신하지 못하였을 시 10회 까지 재시도합니다.

Biz Message SMS, LMS, MMS 처리 결과를 {Callback URL}로 전달하는 API

POST {Callback URL}

200: OK 응답 반환 완료

Webhook Body 예시 (API PLEX ➡ 고객사)

{
    "results": [
        {
            "code": "0",
            "desc": "성공",
            "dest": "LGU",
            "request_date": "2022-10-22 13:52:40.000",
            "done_date": "2022-10-22 13:52:44.390",
            "msg_key": "4b68ca16-7aa8-4a17-b74c-2b8e4adb13f8",
            "echo_to_webhook": "echo test",
            "message_type": “MMS”
        }
    ]
}

전송되는 webhook body 형식

키		타입	필수	설명
results		object array	Y	발송결과에 대한 배열 (배열 형식이지만 1건씩 전송됨)
	msg_key	string	Y	메시지 고유 키 (발송 요청 시 사용한 메시지 고유 키 또는 API PLEX가 부여한 키)
	code	string	Y	발송 결과 코드 (메시지 결과 코드 참조)
	desc	string	N	발송 결과 코드 상세 (메시지 결과 코드 참조)
	dest	string	N	최종착신 통신사 (SKT, KT, LGU)
	request_date	string	Y	접수 시간 (yyyy-MM-dd HH:mm:ss.SSS)
	done_date	string	Y	최종 처리 시간 (yyyy-MM-dd HH:mm:ss.SSS)
	echo_to_webhook	string	Y	사용자가 요청 시 입력한 webhook을 받을 때 함께 받을 string
	message_type	string	Y	사용자가 요청한 message type (SMS, LMS, MMS)

메세지 결과 코드

code	설명
G410	API PLEX → 원천 서비스 요청 실패
G430	원천 서비스 → API PLEX 결과 수신 실패(대기 시간 만료)
d	중복된 수신번호 접수 차단
e	서버 내부 에러
q	메시지 중복키 체크
p	메시지 본문 중복 차단
0	성공
1	전송 시간 초과
5	통신사 결과 미수신
8	단말기 BUSY
9	음영지역
A	단말기 메시지 저장 재수 초과
E	전원 꺼짐
2	잘못된 전화번호/비가입자
B	단말기 일시 서비스 정지
C	기타 단말기 문제
D	착신 거절
F	기타
G	내부 포맷 에러
H	통신사 포맷 에러
I	SMS/MMS 서비스 불가 단말기
J	착신 측 호 불가 상태
K	통신사에서 메시지 삭제 처리
L	통신사 메시지 처리 불가 상태
M	무선망단 전송 실패
S	스팸
V	컨텐츠 사이즈 초과
U	잘못된 컨텐츠
o	timeout

Response Body (고객사 ➡ API PLEX)

{
    "code": "100",
    "desc": "success"
}

키	타입	설명
code	string	webhook 수신 결과 코드 (정상 수신시 "100") 정상적으로 webhook 수신 시 응답에 code를 “100”으로 고정하여 발송
desc	string	webhook 수신 결과 상세 (ex: "desc":"success")