소개
이 문서는 메타플라이어의 메시지 발송 Open API 가이드입니다. 매니저 화면에서 하던 발송과 조회를 연동처 시스템에서 직접 호출할 수 있게 열어 둔 인터페이스입니다.
Metaflyer의 API를 이용하기 위해서는 API 사용 신청을 통하여 API 키를 발급 받고 해당 API 키를 Request Header를 통해 전달하여야 합니다.
준비 절차는 Setup 에 있습니다.
제공 기능
| 기능 | 설명 | 문서 |
|---|---|---|
| 문자 발송 | SMS · LMS · MMS. 예약 발송, 치환 태그, 템플릿 | Message API |
| 알림톡 발송 | 카카오톡 알림톡 발송 | 알림톡 API |
| 이메일 발송 | 메일 발송, 예약 발송 | Message API |
| 브랜드 메시지 | 카카오톡 브랜드 메시지 | Kakao Brand Message API | | 발송 내역 조회 | 발송 상태·실패 사유 조회 | Message API | | 발신프로필 관리 | 카카오톡 발신 프로필 등록·조회·삭제·인증 | 발신프로필 API | | 알림톡 템플릿 관리 | 템플릿 등록·수정·삭제·조회 | 알림톡 API |
기술 스택
- HTTPS 위의 REST API 입니다. 발송·등록은
POST, 조회는GET을 씁니다. - 요청과 응답 본문은 모두 JSON 입니다. 문자 인코딩은 UTF-8 이며,
요청 헤더에
Content-Type: application/json;charset=UTF-8을 지정합니다. (동영상 업로드만 예외로multipart/form-data를 씁니다.) - 인증은 요청 헤더의
apiKey하나로 합니다. 별도의 토큰 발급이나 갱신 절차가 없습니다. - 모든 응답은
time·result·resultMessage·locale을 공통으로 포함합니다. 각 API 문서의 [Common Response] 를 참고하세요.
API 버전
엔드포인트 경로 끝에 버전이 붙습니다(예: /api/message/sendSMS.v1.1).
헤더의 버전 메뉴에서 문서 버전을 바꿀 수 있고, 지금 보고 계신 문서는
v1.1 기준입니다.
문서가 언제 무엇 때문에 바뀌었는지는 헤더의 변경 로그 에 적습니다. API 동작이 바뀐 것과, 동작은 그대로인데 문서가 틀려 고친 것을 구분해 두었으니 연동 전에 한 번 훑어보시길 권합니다.