개요
디케이테크인의 Kakao i BizMessage 서비스는 최종 사용자에게 알림톡, 친구톡, SMS, LMS, MMS, RCS, 네이버톡톡 등을 전송할 수 있는 시스템입니다. 디케이테크인의 BizMessage API는 전화번호(또는 유저키)로 특정 사용자에게 카카오톡과 문자 메시지를 전송할 수 있는 API입니다. BizMessage API는 비즈메시지 서버에 등록된 고객에 한해 허용된 IP로만 접근할 수 있는 제한적인 서비스입니다.
Kakao i BizMessage 서비스는 BizMessage Agent 설치 방식 혹은 BizMessage API 호출 방식으로 구현할 수 있습니다. 본 문서는 본 문서는 BizMessage API를 사용하기 전에 알아야 하는 내용을 설명합니다.
안내
BizMessage API의 라이센스는 디케이테크인이 소유합니다. BizMessage 서비스를 사용하기 위해서는 별도의 서비스 계약이 필요합니다. 계약 방법 및 서비스 이용 절차에 대한 자세한 설명은 BizMessage(KOR) 문서를 참고하시기 바랍니다.
BizMessage 서버 정보
BizMessage API v.2.0의 Swagger UI는 ${host}/v2/document/index.html 입니다. Swagger를 통해 BizMessage API를 사용하고자 하는 경우, 디케이테크인 담당자에게 방화벽 오픈을 요청하시기 바랍니다.
BizMessage 서버는 운영과 스테이징으로 구분됩니다.
- 운영 서버는 실제 고객에게 메시지를 발송하는 목적으로 적합하며, 발송 메시지 건수에 제한이 없고, 과금이 됩니다.
- 스테이징 서버는 소량의 메시지를 테스트하는 목적으로 적합하며, 발송 메시지 건수에 제한이 있고, 과금이 되지 않습니다. 하지만 스테이징 서버에서 메시지를 발송하더라도 실제 메시지가 발송되므로, 메시지 오발송에 주의가 필요합니다. 스테이징 서버에서 전송할 수 있는 메시지 제한 개수는 계약 조건에 따라 다를 수 있습니다.
| 대분류 | 구분 | 도메인 | IP | 포트 |
|---|---|---|---|---|
| 운영 | 일반 | https://bizmsg-web.kakaoenterprise.com | - | 443 |
| 금융권 | https://bizmsg-bank.kakaoenterprise.com | 210.109.10.120 | 443 | |
| 증권 | https://bizmsg-stock.kakaoenterprise.com | 210.109.10.120 | 443 | |
| 공공기관 | https://bizmsg-gov.kakaoenterprise.com | 210.109.10.120 | 443 | |
| 스테이징 | 일반 | https://stg-web.bizmsg.kakaoenterprise.com | - | 443 |
| 금융권 | https://stg-bizmsg-bank.kakaoenterprise.com | 210.109.10.100 | 443 | |
| 증권 | https://stg-bizmsg-stock.kakaoenterprise.com | 210.109.10.101 | 443 | |
| 공공기관 | https://stg-bizmsg-gov.kakaoenterprise.com | (작업중) | 443 |
주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.
API Request
BizMessage에서 제공하고 있는 API의 요청 URL 형태는 다음과 같습니다. HTTP RPC 스타일의 API 요청(Request)에서는 파라미터를 다음과 같은 방법으로 전달할 수 있습니다.
API 호출 방식
BizMessage에서 제공하는 API의 호출 방식은 일반적으로 다음의 방식을 사용합니다.
| 메서드 | 구분 | 파라미터 전달 |
|---|---|---|
| GET | URL | 요청 URL에 표기된 쿼리 파라미터 |
| POST | Body | Request Body에 application/json으로 표현된 데이터 |
Request Body에 application/x-www-form-urlencoded로 표현된 데이터 |
API 인증
BizMessage API를 호출하기 전, 먼저 OAuth 2.0 API를 호출하여 인증을 진행해야 합니다. OAuth 2.0 API 호출 시, 계약 시 발급받은 클라이언트 정보(Basic Client ID와 Client Secret)를 Authorization 헤더를 통해 전달하여 정보를 인증받아야 합니다. OAuth 2.0 인증과 관련한 자세한 설명은 OAuth 2.0 인증 문서를 참고하시기 바랍니다.
API Response
모든 BizMessage API의 응답(Response)은 JSON 객체로 표현됩니다. 따라서 Content Type은 application/json으로 고정됩니다.
API 메시지 상태 코드
BizMessage API의 메시지 상태 코드는 API 메시지 상태 코드를 참고하시기 바랍니다.