※ 가격 상담을 원하시는 경우 신청해주세요
고객님께서는 스마트문자(RCS) 무료 업그레이드 대상입니다.
업그레이드를 원하시는 경우 아래 [무료 업그레이드 신청하기] 버튼을 눌러주시면 전문 담당자가 모든 과정을 도와드립니다.
문자연동 메인 이미지
뿌리오 문자연동 서비스란?
웹에 접속하지 않고 원하는 시점에 API연동을 통해 문자를 자동으로 발송하는 서비스입니다.
* 모듈 연동이 필요하신
경우 [여기]를 클릭해주세요.
문자연동 서비스 신청 전 확인해 주세요.
문자연동 서비스는 기업회원만 이용이 가능합니다.
이용을 원하시는 회원님께서는 기업회원 전환 부탁드립니다.
문자연동에 필요한 프로그램 연동 설정을 할 수 있는 개발 담당자가 필요합니다.
문자연동 서비스 신청하기 버튼을 눌러주세요.
신청페이지에서 연동 담당자 정보 입력 및 약관 동의 후 신청 바랍니다.
신청하신 건은 심사 후 승인 처리됩니다. (영업일 1~2일 소요)
승인이 완료되면 입력하신 연동 담당자 휴대폰번호로 승인 문자가 발송됩니다.
연동 신청이 승인 완료 시 오픈 API 페이지를 통해 인증 키 발급하세요.
문자 연동 신청 승인 후 API 서비스를 이용하기 위해 인증 키를 발급합니다.
연동 > 연동신청관리 메뉴에서 발송할 서버의 IP를 등록해주세요.
문자 연동 개발 규격서(API)를 참고하여 개발환경에 맞게 선택하시고 서비스 반영하면 됩니다.
뿌리오 연동 규격
HTTPS
- 안전한 데이터 전송을 위해 모든 API 요청은 SSL 환경의 HTTPS(443)를 사용해야
합니다.
UTF-8
- UTF-8 인코딩은 다양한 언어와 스크립트의 광범위한 문자를 지원하기 위해 기본적으로
제공됩니다.
가이드 작성 환경 정보
- java: JDK17
- python: Python 3.10.8
- php: php5
*테스트 시 보안 등급 / 서버 스펙 확인 (OS 및 프로그램, TLS 버전 등)
*개발 환경에서 발생한 오류는 각 본인 환경에 맞는 설정이 있기에 도움을 드리기 어렵습니다.
*버전이 업그레이드될수록 지원하지 않는 메서드가 있을 수 있어 요청 실패가 나올 수 있습니다.
*연동 발송은 변수7 까지만 지원합니다. (변수8 추후 지원 예정)
요청값 정의
경로 | 설명 | ||
/v1/token | POST | Access Token 발급을 요청하는 기능입니다. | |
---|---|---|---|
/v1/message | 메시지 전송을 요청하는 기능입니다. | ||
/v1/kakao | 카카오톡(알림톡) 전송을 요청하는 기능입니다. | ||
/v1/cancel | 문자 예약발송을 취소하는 기능입니다. | ||
/v1/cancel/kakao | 카카오톡(알림톡) 예약발송을 취소하는 기능입니다. |
엑세스 토큰 발급
- 메시지, 카카오톡 발송 API 서비스를 이용하기 위해서 엑세스 토큰을 발급하기 위한 API입니다.
- 엑세스 토큰의 유효 시간은 24시간이며, 이후에는 사용이 불가하고 재발급이 필요합니다.
- Rate-Limit이 변경되거나 연동 IP를 추가하는 경우, 그리고 인증키를 재발급 받은 경우 엑세스
토큰
재발급이 필요합니다.
- Authorization 헤더에 뿌리오 계정과 연동 페이지에서 발급 받은 인증키를
Base64 인코딩한 문자열을 입력합니다.
- 연동IP 등록 및 인증키 발급이 선행되어야 합니다. 연동 > 연동 관리에서 확인
가능합니다.
요청 헤더 | 설명 |
Authorization | "뿌리오 계정 : 연동 개발 인증키”를 Base64 인코딩한 문자열을 전달하는 헤더
Authorization : Basic {Base64 인코딩한 문자열} |
---|
필드 | 타입 | 필수 | 설명 |
token | text | Y | 인증 토큰 |
---|---|---|---|
type | text(6) | Y | Bearer |
expired | text(14) | Y | 토큰 만료 시간 |
2. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "token": “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjMsInVzZXJuYW1lIjoiam9obmRvZSIsImV4cCI6MTY5MjM4ODgwMH0.BJYd2Urr4nU6J1R6RBOlhJpSdSv3zmyl3vr_-F7VjKk", "type": "Bearer", "expired": "20230414090407" }
메시지(SMS/LMS/MMS) 발송 요청
- 메시지 발송을 요청하는 API 입니다.
- API 사용을 위해서 엑세스 토큰 발급이 선행이 되어야 합니다.
- 자세한 발송 결과는 뿌리오 발송결과 페이지에서 확인할 수 있습니다.
- API 성공 응답을 받더라도 잔액부족, 발송한도 초과, 계정 사용불가와 같은 이유로
최종적으로 발송에 실패할수도 있습니다. 이러한 경우 연동 사용내역 > 발송 실패건 보기에서 확인할
수 있습니다.
- 추가 필드는 허용되지 않습니다.
- 치환 문구 사용 시 메시지 길이 초과로 인해 발송이 되지 않을 수 있습니다.
- MessageType 파라미터를 기준으로 재화가 차감됩니다.
요청 헤더 | 설명 |
Authorization | 엑세스 토큰을 전달하는 헤더, 토큰 타입은 “Bearer”로 고정
Authorization: Bearer {엑세스 토큰} |
---|
필드 | 타입 | 필수 | 설명 |
account | text(20) | O | 뿌리오 계정 |
---|---|---|---|
messageType | text(3) | O | SMS/LMS/MMS
* MessageType 기준으로 재화가 차감됩니다. |
content | text(2000) | O | 메시지 내용
- SMS : 최대 90byte - MMS, LMS : 최대 2000byte |
from | text(16) | O | 발신번호 |
duplicateFlag | text(1) | O | 수신 번호 중복 여부
- Y : 중복 허용 - N : 중복 제거 |
targetCount | number | O | 수신자 목록 수 |
targets | array | O | 수신자 목록
* 아래 targets 참조 |
refKey | text(32) | O | 요청자가 부여한 키 |
rejectType | text(2) | X | 수신 거부 유형
- AD : 광고 수신거부 |
sendTime | text(19) | X | 예약 발송 시간
- yyyy-MM-DDTHH:mm:ss 형태 - 최소 3분 이후, 최대 다음 해 말일 - 요청에서 제외시 즉시 발송 |
subject | text(30) | X | 제목 |
files | array | X | MMS 발송 시 첨부 파일
* 아래 files 참조 |
필드 | 타입 | 필수 | 설명 |
to | text(16) | Y | 수신 번호 |
---|---|---|---|
changeWord | json | N | 치환 문구 목록
* 아래 changeWord 참조 |
name | text(100) | N | [*이름*] 치환 문구 |
필드 | 타입 | 필수 | 설명 | 필드 | 타입 | 필수 | 설명 |
var1 | text(100) | N | [*1*] 치환 문구 | var5 | text(100) | N | [*5*] 치환 문구 |
---|---|---|---|---|---|---|---|
var2 | text(100) | N | [*2*] 치환 문구 | var6 | text(100) | N | [*6*] 치환 문구 |
var3 | text(100) | N | [*3*] 치환 문구 | var7 | text(100) | N | [*7*] 치환 문구 |
var4 | text(100) | N | [*4*] 치환 문구 |
⦁ files
- MMS 발송 시 사용될 이미지이며, 최대 1개까지만 첨부가 가능합니다.
- 바이너리 형식인 이미지 파일을 Base64로 인코딩하여 텍스트로 입력하셔야 합니다.
- 파일 형식 및 크기 : jpg, jpeg / 최대 300KB
필드 | 타입 | 필수 | 설명 |
name | text(200) | Y | 파일 명 |
---|---|---|---|
size | number | Y | 파일 크기 (byte) |
data | text | Y | 업로드할 이미지 파일 |
필드 | 타입 | 필수 | 설명 |
code | text(4) | O | 응답 코드 |
---|---|---|---|
description | text | O | 응답 메시지 |
refKey | text(32) | O | 요청자가 부여한 키 |
messageKey | text(33) | O | 메시지 고유 키 |
응답 헤더 | 설명 |
RateLimit-Limit | 총 허용량 |
---|---|
RateLimit-Remaining | 남은 요청 허용량 |
RateLimit-Reset | 다음 요청 제한 재설정까지 남은 시간 |
3. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "code": "1000", "description": "success", "refKey": "text", "messageKey": "230413110135117SMS029914servsUBn“ }
실패 사유 | 설명 |
잔액 부족 | 잔액이 부족하여 발송에 실패한 경우입니다. |
---|---|
API 사용 불가 | 현재 계정이 API를 사용하지 못하는 상태입니다. |
잘못된 유저 정보 | 현재 계정이 뿌리오 서비스를 사용하지 못하는 상태입니다. |
차단된 발신번호 | 불법 발신번호로 등록된 번호입니다. |
잘못된 발신번호 | 현재 발신번호가 사용하지 못하는 상태입니다. |
발송 한도 초과 | 발송 일일 한도를 초과하였습니다. |
서버 오류 | 서버에서 오류가 발생하였습니다. |
예약 불가 시간 | 예약이 불가능한 시간입니다. |
서버 점검 시간 | 뿌리오 서비스가 점검 중 입니다. |
잘못된 MMS 이미지 | 올바르지 않은 MMS 이미지 입니다. |
예약 취소
- 발송 예약을 취소하는 API 입니다.
- 현재 발송 중이거나, 발송예약 시간 1분 전에는 예약을 취소할 수 없습니다.
- API 사용을 위해서 엑세스 토큰 발급이 선행이 되어야 합니다.
- 추가 필드는 허용되지 않습니다.
요청 헤더 | 설명 |
Authorization | 엑세스 토큰을 전달하는 헤더, 토큰 타입은 “Bearer”로 고정 Authorization: Bearer {엑세스 토큰} |
---|
필드 | 타입 | 필수 | 설명 |
account | text(20) | O | 뿌리오 계정 |
---|---|---|---|
messageKey | text(33) | O | 메시지 고유 키 |
필드 | 타입 | 필수 | 설명 |
code | text(4) | O | 응답 코드 |
---|---|---|---|
description | text | O | 응답 메시지 |
응답 헤더 | 설명 |
RateLimit-Limit | 총 허용량 |
---|---|
RateLimit-Remaining | 남은 요청 허용량 |
RateLimit-Reset | 다음 요청 제한 재설정까지 남은 시간 |
3. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "code": "1000", "description": "success", }
4. API 결과코드정의
상태 코드 | 결과 코드 | 결과 메시지 | 설명 |
200 | 1000 | ok | 성공 |
---|---|---|---|
400 | 2000 | (잘못된 파라미터에 따라 다름) | 요청이 유효하지 않음 |
2001 | 잘못된 예약발송 취소 URL | URL이 유효하지 않음 | |
3001 | invalid basic Authentication | 토큰 발급 호출 시, Authorization 헤더가 유효하지 않음 | |
3002 | jwt invalid token | 토큰이 유효하지 않음 | |
3003 | invalid ip | 아이피가 유효하지 않음 | |
3004 | invalid account | 계정이 유효하지 않음 | |
3005 | invalid bearer | 토큰이 유효하지 않음 | |
3006 | not empty authorization header | Authorization 헤더가 유효하지 않음 | |
3007 | jwt token issuance failed | 엑세스 토큰 발행 실패 | |
3008 | too many request | 너무 많은 요청 (Rate-Limit 관련) | |
4004 | inactive account | api 접근 권한이 비활성화 상태 | |
4006 | invalid auth key | 인증키가 유효하지 않음 | |
4007 | not issued auth key | 인증키를 발행 받지 않음 | |
4009 | invalid message key | 취소를 위한 messageKey가 유효하지 않음 | |
4010 | the deadline for canceling has expired | 예약 취소 가능 시간이 지남 | |
4011 | the message has already been sent | 메시지가 이미 발송중인 상태 | |
4012 | the reservation cannot be canceled | 예약을 취소할 수 없음 | |
500 | 9000 ~ 9999 | internal server error | 서버 오류 |
Rate-Limit
메시지 발송 API, 카카오톡 발송 API, 예약 취소 API를 사용할 때 Rate-Limit이 적용됩니다.
Rate-Limit이란 정해진 시간내에 허용 가능한 API 호출 수를 의미합니다.
만약 허용 가능한 API 호출 수를 넘어선다면, HTTP 429 응답과 함께 API 호출에 실패합니다.
Rate-Limit 기본 값은 1초당 15회 입니다.
업계 1위 뿌리오의
연동 서비스를 써야만 하는 이유!
손쉽게
다양한 환경에 연동지원
전문운영상담원이 지원을 해드립니다.
다양하고 편리한
결제 서비스
선불/후불 다양한 결제 방식을 지원합니다.
철저한
개인정보 보호 시스템
정보보호 관리 체계 인증(ISMS-P), 개인정보 보호마크획득, SSL 보안인증으로 안전한 서비스를 제공합니다.
뿌리오 카카오톡연동 서비스란?
웹에 접속하지 않고 원하는 시점에 API연동을 통해 카카오톡을 자동으로 발송하는 서비스입니다.
* 모듈 연동이 필요하신 경우 [여기]를 클릭해주세요.
카카오톡연동 서비스 신청 전 확인해 주세요.
카카오톡연동 발송에 필요한 발신프로필이 필요합니다. [카카오톡 설정 > 발신프로필 관리] 메뉴에서 발신프로필을 등록해주세요.
알림톡은 승인된 템플릿만 발송 가능하며 템플릿 등록 및 심사 요청은 [카카오톡 설정 > 알림톡 템플릿 관리]에서 진행하실 수 있습니다.
템플릿 심사는 카카오에서 진행하며, 승인까지 영업일 기준 약 1~2일 가량 소요되니 사전에 등록해주시기 바랍니다.
카카오톡연동 개발 작업을 진행할 수 있는 개발 담당자가 필요합니다.
연동 서비스 신청하기 버튼을 눌러주세요.
신청페이지에서 연동 담당자 정보 입력 및 약관 동의 후 신청해주세요.
신청하신 건은 담당자 심사 후 승인 처리됩니다. (영업일 1~2일 소요)
승인이 완료되면 신청 시 입력한 담당자 휴대폰번호로 승인 문자가 발송됩니다.
카카오톡 API연동 작업을 진행해주세요.
승인이 완료되면 연동 서비스 이용을 위한 연동 개발(API) 인증키가 자동으로 발급됩니다.
인증키는 [연동신청관리] 메뉴에서 확인 가능합니다.
[연동신청관리] 메뉴에서 발송할 서버의 IP를 등록해주세요.
카카오톡연동 개발 규격서(API)를 참고하여 연동 작업을 진행해주세요.
뿌리오 연동 규격
HTTPS
- 안전한 데이터 전송을 위해 모든 API 요청은 SSL 환경의 HTTPS(443)를 사용해야
합니다.
UTF-8
- UTF-8 인코딩은 다양한 언어와 스크립트의 광범위한 문자를 지원하기 위해 기본적으로
제공됩니다.
가이드 작성 환경 정보
- java: JDK17
- python: Python 3.10.8
- php: php5
*테스트 시 보안 등급 / 서버 스펙 확인 (OS 및 프로그램, TLS 버전 등)
*개발 환경에서 발생한 오류는 각 본인 환경에 맞는 설정이 있기에 도움을 드리기 어렵습니다.
*버전이 업그레이드될수록 지원하지 않는 메서드가 있을 수 있어 요청 실패가 나올 수 있습니다.
*연동 발송은 변수7 까지만 지원합니다. (변수8 추후 지원 예정)
요청값 정의
경로 | 설명 | ||
/v1/token | POST | Access Token 발급을 요청하는 기능입니다. | |
---|---|---|---|
/v1/message | 메시지 전송을 요청하는 기능입니다. | ||
/v1/kakao | 카카오톡(알림톡) 전송을 요청하는 기능입니다. | ||
/v1/cancel | 문자 예약발송을 취소하는 기능입니다. | ||
/v1/cancel/kakao | 카카오톡(알림톡) 예약발송을 취소하는 기능입니다. |
엑세스 토큰 발급
- 메시지, 카카오톡 발송 API 서비스를 이용하기 위해서 엑세스 토큰을 발급하기 위한 API입니다.
- 엑세스 토큰의 유효 시간은 24시간이며, 이후에는 사용이 불가하고 재발급이 필요합니다.
- Rate-Limit이 변경되거나 연동 IP를 추가하는 경우, 그리고 인증키를 재발급 받은 경우 엑세스
토큰
재발급이 필요합니다.
- Authorization 헤더에 뿌리오 계정과 연동 페이지에서 발급 받은 인증키를
Base64 인코딩한 문자열을 입력합니다.
- 연동IP 등록 및 인증키 발급이 선행되어야 합니다. 연동 > 연동 관리에서 확인
가능합니다.
요청 헤더 | 설명 |
Authorization | "뿌리오 계정 : 연동 개발 인증키”를 Base64 인코딩한 문자열을 전달하는 헤더
Authorization : Basic {Base64 인코딩한 문자열} |
---|
필드 | 타입 | 필수 | 설명 |
token | text | Y | 인증 토큰 |
---|---|---|---|
type | text(6) | Y | Bearer |
expired | text(14) | Y | 토큰 만료 시간 |
2. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "token": “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjMsInVzZXJuYW1lIjoiam9obmRvZSIsImV4cCI6MTY5MjM4ODgwMH0.BJYd2Urr4nU6J1R6RBOlhJpSdSv3zmyl3vr_-F7VjKk", "type": "Bearer", "expired": "20230414090407" }
카카오톡(알림톡 텍스트, 이미지, 강조표기, 아이템리스트) 발송 요청
- 카카오톡 발송을 요청하는 API 입니다.
- API 사용을 위해서 엑세스 토큰 발급이 선행이 되어야 합니다.
- 자세한 발송 결과는 뿌리오 발송결과 페이지에서 확인할 수 있습니다.
- API 성공 응답을 받더라도 잔액부족, 발송한도 초과, 계정 사용불가와 같은 이유로
최종적으로 발송에 실패할수도 있습니다. 이러한 경우 문자연동 사용내역 > 발송 실패건 보기에서 확인할
수 있습니다.
- 추가 필드는 허용되지 않습니다.
- 치환 문구 사용 시 메시지 길이 초과로 인해 발송이 되지 않을 수 있습니다.
- MessageType 파라미터를 기준으로 재화가 차감됩니다.
요청 헤더 | 설명 |
Authorization | 엑세스 토큰을 전달하는 헤더, 토큰 타입은 “Bearer”로 고정
Authorization: Bearer {엑세스 토큰} |
---|
필드 | 타입 | 필수 | 설명 |
account | text(20) | O | 뿌리오 계정 |
---|---|---|---|
messageType | text(3) | O | ALT/ALL/ALH/ALI
- ALT: 알림톡 기본형 - ALI: 알림톡 이미지 - ALH: 알림톡 강조표기 - ALL: 알림톡 아이템리스트 |
senderProfile | text(20) | O | 발신 프로필명
- 뿌리오에서 발급받은 발신 프로필명(ex) @뿌리오) |
templateCode | text(100) | O | 템플릿 코드
- 뿌리오에서 발급받은 템플릿 코드 - 카카오톡 > 카카오톡 설정 > 알림톡 템플릿 관리에서 확인 가능 |
duplicateFlag | text(1) | O | 수신 번호 중복 여부
- Y : 중복 허용 - N : 중복 제거 |
targetCount | number | O | 수신자 목록 수 |
targets | array | O | 수신자 목록
* 아래 targets 참조 |
refKey | text(32) | O | 요청자가 부여한 키 |
isResend | text(1) | O | 대체 발송 허용 여부
- Y : 대체 발송 허용 - N : 대체 발송 불가 |
sendTime | text(19) | X | 예약 발송 시간
- yyyy-MM-DDTHH:mm:ss 형태 - 최소 3분 이후, 최대 다음 해 말일 - 요청에서 제외시 즉시 발송 |
resend | object | X | 대체 발송 정보
* 아래 resend 참조 |
필드 | 타입 | 필수 | 설명 |
to | text(16) | Y | 수신 번호 |
---|---|---|---|
changeWord | json | N | 치환 문구 목록
* 아래 changeWord 참조 |
name | text(100) | N | [*이름*] 치환 문구 |
필드 | 타입 | 필수 | 설명 | 필드 | 타입 | 필수 | 설명 |
var1 | text(100) | N | [*1*] 치환 문구 | var5 | text(100) | N | [*5*] 치환 문구 |
---|---|---|---|---|---|---|---|
var2 | text(100) | N | [*2*] 치환 문구 | var6 | text(100) | N | [*6*] 치환 문구 |
var3 | text(100) | N | [*3*] 치환 문구 | var7 | text(100) | N | [*7*] 치환 문구 |
var4 | text(100) | N | [*4*] 치환 문구 |
필드 | 타입 | 필수 | 설명 |
messageType | text(3) | O | SMS/LMS/MMS
* MessageType 기준으로 재화가 차감됩니다. |
---|---|---|---|
content | text(2000) | O | 메시지 내용
- SMS : 최대 90byte - MMS, LMS : 최대 2000byte |
from | text(16) | O | 발신번호 |
subject | text(30) | X | 제목 |
files | array | X | MMS 발송 시 첨부 파일
* 아래 files 참조 |
⦁ files
- MMS 발송 시 사용될 이미지이며, 최대 1개까지만 첨부가 가능합니다.
- 바이너리 형식인 이미지 파일을 Base64로 인코딩하여 텍스트로 입력하셔야 합니다.
- 파일 형식 및 크기 : jpg, jpeg, png, gif / 최대 400KB
필드 | 타입 | 필수 | 설명 |
name | text(200) | Y | 파일 명 |
---|---|---|---|
size | number | Y | 파일 크기 (byte) |
data | text | Y | 업로드할 이미지 파일 |
필드 | 타입 | 필수 | 설명 |
code | text(4) | O | 응답 코드 |
---|---|---|---|
description | text | O | 응답 메시지 |
refkey | text(32) | O | 요청자가 부여한 키 |
messageKey | text(33) | O | 메시지 고유 키 |
응답 헤더 | 설명 |
RateLimit-Limit | 총 허용량 |
---|---|
RateLimit-Remaining | 남은 요청 허용량 |
RateLimit-Reset | 다음 요청 제한 재설정까지 남은 시간 |
3. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "code": "1000", "description": "success", "refkey": "text", "messageKey": "230413110135117SMS029914servsUBn“ }
실패 사유 | 설명 |
잔액 부족 | 잔액이 부족하여 발송에 실패한 경우입니다. |
---|---|
API 사용 불가 | 현재 계정이 API를 사용하지 못하는 상태입니다. |
잘못된 유저 정보 | 현재 계정이 뿌리오 서비스를 사용하지 못하는 상태입니다. |
차단된 발신번호 | 불법 발신번호로 등록된 번호입니다. |
잘못된 발신번호 | 현재 발신번호가 사용하지 못하는 상태입니다. |
발송 한도 초과 | 발송 일일 한도를 초과하였습니다. |
서버 오류 | 서버에서 오류가 발생하였습니다. |
예약 불가 시간 | 예약이 불가능한 시간입니다. |
서버 점검 시간 | 뿌리오 서비스가 점검 중 입니다. |
잘못된 MMS 이미지 | 올바르지 않은 MMS 이미지 입니다. |
존재하지 않는 프로필 | 뿌리오 계정에 등록되지 않은 발신프로필입니다. |
잘못된 프로필 | 현재 발신프로필이 사용 불가한 상태입니다. |
템플릿 유형 불일치 | messageType과 templateCode가 일치하지 않습니다. |
존재하지 않는 템플릿 | 뿌리오 계정에 등록되지 않은 템플릿입니다. |
잘못된 템플릿 | 현재 템플릿이 사용 불가한 상태입니다. |
예약 취소
- 발송 예약을 취소하는 API 입니다.
- 현재 발송 중이거나, 발송예약 시간 1분 전에는 예약을 취소할 수 없습니다.
- API 사용을 위해서 엑세스 토큰 발급이 선행이 되어야 합니다.
- 추가 필드는 허용되지 않습니다.
요청 헤더 | 설명 |
Authorization | 엑세스 토큰을 전달하는 헤더, 토큰 타입은 “Bearer”로 고정 Authorization: Bearer {엑세스 토큰} |
---|
필드 | 타입 | 필수 | 설명 |
account | text(20) | O | 뿌리오 계정 |
---|---|---|---|
messageKey | text(33) | O | 메시지 고유 키 |
필드 | 타입 | 필수 | 설명 |
code | text(4) | O | 응답 코드 |
---|---|---|---|
description | text | O | 응답 메시지 |
응답 헤더 | 설명 |
RateLimit-Limit | 총 허용량 |
---|---|
RateLimit-Remaining | 남은 요청 허용량 |
RateLimit-Reset | 다음 요청 제한 재설정까지 남은 시간 |
3. 예시
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 { "code": "1000", "description": "success", }
4. API 결과코드정의
상태 코드 | 결과 코드 | 결과 메시지 | 설명 |
200 | 1000 | ok | 성공 |
---|---|---|---|
400 | 2000 | (잘못된 파라미터에 따라 다름) | 요청이 유효하지 않음 |
2001 | 잘못된 예약발송 취소 URL | URL이 유효하지 않음 | |
3001 | invalid basic Authentication | 토큰 발급 호출 시, Authorization 헤더가 유효하지 않음 | |
3002 | jwt invalid token | 토큰이 유효하지 않음 | |
3003 | invalid ip | 아이피가 유효하지 않음 | |
3004 | invalid account | 계정이 유효하지 않음 | |
3005 | invalid bearer | 토큰이 유효하지 않음 | |
3006 | not empty authorization header | Authorization 헤더가 유효하지 않음 | |
3007 | jwt token issuance failed | 엑세스 토큰 발행 실패 | |
3008 | too many request | 너무 많은 요청 (Rate-Limit 관련) | |
4004 | inactive account | api 접근 권한이 비활성화 상태 | |
4006 | invalid auth key | 인증키가 유효하지 않음 | |
4007 | not issued auth key | 인증키를 발행 받지 않음 | |
4009 | invalid message key | 취소를 위한 messageKey가 유효하지 않음 | |
4010 | the deadline for canceling has expired | 예약 취소 가능 시간이 지남 | |
4011 | the message has already been sent | 메시지가 이미 발송중인 상태 | |
4012 | the reservation cannot be canceled | 예약을 취소할 수 없음 | |
500 | 9000 ~ 9999 | internal server error | 서버 오류 |
Rate-Limit
메시지 발송 API, 카카오톡 발송 API, 예약 취소 API를 사용할 때 Rate-Limit이 적용됩니다.
Rate-Limit이란 정해진 시간내에 허용 가능한 API 호출 수를 의미합니다.
만약 허용 가능한 API 호출 수를 넘어선다면, HTTP 429 응답과 함께 API 호출에 실패합니다.
Rate-Limit 기본 값은 1초당 15회 입니다.
업계 1위 뿌리오의
카카오톡 연동 서비스를 써야만 하는 이유!
손쉽게
다양한 환경에 연동지원
전문운영상담원이 지원을 해드립니다.
다양하고 편리한
결제 서비스
선불/후불 다양한 결제 방식을 지원합니다.
철저한
개인정보 보호 시스템
정보보호 관리 체계 인증(ISMS-P), 개인정보 보호마크획득, SSL 보안인증으로 안전한 서비스를 제공합니다.
경기도 성남시 수정구 금토로 69, 다우디지털스퀘어 4층 ㈜다우기술 대표이사 김윤덕
Copyrights ⓒ2023 DAOU TECH Inc. All rights reserved.
어떤 방법으로 아이디 전체를 확인하시겠습니까?
선택하신 수단으로 아이디를 전송했습니다.
본 웹사이트에서 이메일 주소를 이메일 주소 수집 프로그램이나 그 밖의 기술적 장치를 이용하여 무단으로 수집되는 것을 거부하며, 이를 위반할 시에는 정보통신망법에 의해 형사처벌됨을 유념하시기 바랍니다.