메시지 발송 결과 (WebHook)

RCS 메세지의 결과값을 고객사 callback URL로 전달합니다.

WebHook API

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

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

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

RCS 처리 결과를 {Callback URL}로 전달하는 API

POST {Callback URL}

200: OK 응답 반환 완료

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

{
    "results": [
        {
            "msg_key": "string",
            "code": "string",
            "desc": "string",
            "done_date": "string"
        }
    ]
}

전송되는 webhook body 형식

키		타입	설명
results		object array	발송결과에 대한 배열 (배열 형식이지만 1건씩 전송)
	msg_key	string	발송 요청 시 사용한 메시지 고유 키
	code	string	RCS 메시지 발송 결과 코드(RCS 결과 코드 참조)
	desc	string	RCS 메시지 발송 결과 코드 상세(RCS 결과 코드 참조)
	done_date	string	메시지최종처리시각 (YYYYMMDD24HHMISS)
	echo_to_webhook	string	사용자가 요청 시 입력한 webhook을 받을 때 함께 받을 string

Response Body (고객사 ➡ API PLEX)

{
    "code": "string",
    "desc": "string"
}

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