권한 가이드
기본 규칙
각 API 를 부르려면 그 API 에 맞는 권한이 키에 있어야 합니다. 권한이 없으면
403으로 거절합니다.이 문서에 없는 조회(
GET) API 는 그 기능의 조회 권한으로 판정됩니다.문서에 없는 등록 · 수정 · 삭제 API 는 부를 수 없습니다.
권한은 키를 만드는 회원이 그 기능의 권한을 가지고 있을 때만 고를 수 있습니다.
권한을 골라 만든 API Key 는 레거시 API 에 쓸 수 없습니다.
발송 권한과 허용 IP
발송 권한이 있는 API Key는 허용 IP 를 1개 이상 직접 지정해야 합니다. 발송 API 는 직접 지정한 IP 에서 부를 때만 성공합니다. 모든 IP 허용(0.0.0.0/0)과 클라우드 공급사 대역은 발송 허용 IP 로 쓸 수 없습니다.
Oauth2 는 발송 권한에 허용 IP 제한을 받지 않습니다.
권한 목록
기능 | 조회 권한 | 변경 권한 | 발송 권한 |
|---|---|---|---|
메시지 |
|
|
|
카카오 |
|
| |
RCS |
|
| |
발신번호 |
|
| |
주소록 |
|
| |
수신거부 · 차단 |
|
| |
파일 |
|
| |
CRM |
|
| |
앱스토어 |
|
| |
잔액 · 충전 내역 |
| ||
단가 |
| ||
발송 한도 |
|
더 많은 기능을 API Key 권한으로 쓸 수 있도록 준비하고 있습니다. 필요한 권한이 목록에 없거나 궁금한 점이 있으면 고객센터로 문의해 주세요.
메시지
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 발송 | POST |
|
POST |
| ||
POST |
| ||
POST |
| ||
POST |
| ||
POST |
| ||
그룹 발송 | POST |
| |
POST |
| ||
예약 등록 | POST |
| |
POST |
| ||
예약 시각 변경 | PUT |
| |
그룹 재발송 | POST |
| |
실패 메시지 재발송 | POST |
| |
메시지 재발송 | POST |
| |
주소록 그룹 예약 발송 | POST |
| |
| 그룹 생성 | POST |
|
POST |
| ||
그룹 삭제 | DELETE |
| |
DELETE |
| ||
그룹에 메시지 추가 · 삭제 | PUT, DELETE |
| |
PUT, DELETE |
| ||
예약 취소 | DELETE |
| |
주소록 예약 취소 | DELETE |
| |
주소록 예약 메시지 취소 | DELETE |
| |
| 메시지 목록 | GET |
|
| 그룹 목록 | GET |
|
| 그룹 상세 | GET |
|
| 그룹의 메시지 | GET |
|
| 그룹 미리보기 | GET |
|
| 발신번호별 메시지 | GET |
|
| 통계 | GET |
|
| 일별 통계 | GET |
|
| 팩스 수신번호 | GET |
|
| 받은 팩스 | GET |
|
카카오
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 채널 연동 인증 토큰 요청 | POST |
|
채널 연동 | POST |
| |
채널 연동 해제 | DELETE |
| |
채널 공유 | POST |
| |
채널 공유 해제 | DELETE |
| |
채널 그룹 초대 | POST |
| |
채널 그룹 초대 취소 | DELETE |
| |
채널 그룹 초대 수락 | POST |
| |
채널 그룹 초대 거절 | POST |
| |
채널 그룹에서 내보내기 | DELETE |
| |
채널 그룹에서 나가기 | DELETE |
| |
알림톡 템플릿 등록 | POST |
| |
알림톡 템플릿 엑셀로 등록 | POST |
| |
알림톡 템플릿 수정 | PUT |
| |
알림톡 템플릿 이름 변경 | PUT |
| |
알림톡 템플릿 삭제 | DELETE |
| |
알림톡 템플릿 검수 요청 | PUT |
| |
알림톡 템플릿 검수 요청 취소 | PUT |
| |
알림톡 템플릿 휴면 해제 | POST |
| |
브랜드 메시지 템플릿 등록 | POST |
| |
브랜드 메시지 템플릿 수정 | PUT |
| |
브랜드 메시지 템플릿 삭제 | DELETE |
| |
브랜드 메시지 템플릿 복사 | POST |
| |
| 채널 목록 · 상세 | GET |
|
채널 카테고리 | GET |
| |
검색용 아이디 확인 | GET |
| |
채널 그룹 목록 · 상세 | GET |
| |
채널 그룹 초대 목록 · 상세 | GET |
| |
템플릿 목록 · 상세 | GET |
| |
발송 가능한 템플릿 | GET |
|
RCS
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 브랜드 연동 | POST |
|
브랜드 연동 해제 | DELETE |
| |
템플릿 등록 | POST |
| |
템플릿 수정 | PUT |
| |
템플릿 삭제 | DELETE |
| |
템플릿 검수 취소 | PUT |
| |
템플릿 동기화 | PUT |
| |
| 브랜드 목록 · 상세 | GET |
|
템플릿 목록 · 상세 | GET |
| |
공통 템플릿 | GET |
| |
서식 | GET |
|
발신번호
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 발신번호 목록 | GET |
|
활성 발신번호 | GET |
| |
번호 정보 | GET |
| |
별칭 조회 | GET |
| |
| 별칭 등록 | POST |
|
별칭 삭제 | DELETE |
|
주소록
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 폴더 추가 | POST |
|
폴더 수정 | PUT |
| |
폴더 삭제 | DELETE |
| |
명단 추가 | POST |
| |
명단 수정 | PUT |
| |
명단 삭제 | DELETE |
| |
명단을 다른 폴더로 복사 | POST |
| |
발송 준비 | POST |
| |
발송 준비 취소 | PUT |
| |
| 폴더 목록 | GET |
|
폴더 명단 | GET |
| |
명단 검색 | GET |
| |
발송 준비 상태 | GET |
|
수신거부 · 차단
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 차단 그룹 추가 · 수정 | POST |
|
차단 그룹 삭제 | DELETE |
| |
차단 번호 추가 · 수정 | POST |
| |
차단 번호 대량 추가 | POST |
| |
그룹에서 차단 번호 빼기 | DELETE |
| |
| 080 수신거부 · KISA 차단 목록 | GET |
|
차단 그룹 목록 | GET |
| |
차단 번호 목록 | GET |
|
파일
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 업로드 | POST |
|
삭제 | DELETE |
| |
| 파일 목록 | GET |
|
파일 상세 | GET |
|
CRM
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 엔티티 목록 · 상세 | GET |
|
속성 목록 · 상세 | GET |
| |
레코드 목록 · 상세 | GET |
| |
레코드 상세 검색 | POST |
| |
레코드 전문 검색 | GET |
| |
중복 레코드 찾기 | POST |
| |
내보내기 상태 | GET |
| |
관계 목록 | GET |
| |
관계 유형 목록 | GET |
| |
활동 목록 · 상세 | GET |
| |
세그먼트 목록 · 상세 | GET |
| |
세그먼트 레코드 | GET |
| |
세그먼트 평가 | POST |
| |
요금제 | GET |
| |
청구 내역 | GET |
| |
다음 결제 · 초과 사용 | GET |
| |
| 엔티티 추가 | POST |
|
엔티티 수정 · 삭제 | PATCH, DELETE |
| |
속성 추가 | POST |
| |
속성 수정 · 삭제 | PATCH, DELETE |
| |
| 레코드 생성 | POST |
|
레코드 수정 | PATCH |
| |
레코드 대량 수정 | POST |
| |
레코드 복원 | POST |
| |
CSV 가져오기 | POST |
| |
| 레코드 삭제 | DELETE |
|
레코드 대량 삭제 | POST |
| |
내보내기 요청 | POST |
| |
관계 추가 | POST |
| |
관계 수정 · 삭제 | PATCH, DELETE |
| |
관계 유형 추가 | POST |
| |
관계 유형 수정 · 삭제 | PATCH, DELETE |
| |
활동 추가 | POST |
| |
활동 수정 · 삭제 | PATCH, DELETE |
| |
활동 완료 처리 | POST |
| |
세그먼트 삭제 | DELETE |
| |
초과 사용 설정 | PUT |
|
앱스토어
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 앱 등록 | POST |
|
앱 수정 · 삭제 | PUT, DELETE |
| |
앱 공개 단계 변경 | PUT |
| |
앱 썸네일 올리기 | POST |
| |
앱 스크린샷 올리기 | POST |
| |
앱홈 등록 · 수정 | POST, PUT |
| |
앱홈 수익금 설정 | POST, PUT, DELETE |
| |
서브계정 추가 · 삭제 | POST, DELETE |
| |
서브계정 수정 | PUT |
| |
서브계정 사용자 정의 필드 삭제 | DELETE |
| |
| 앱 목록 | GET |
|
앱홈 수익금 설정 | GET |
| |
서브계정 목록 | GET |
| |
수익금 | GET |
|
잔액 · 단가 · 발송 한도
권한 | 작업 | 메서드 | 경로 |
|---|---|---|---|
| 잔액 | GET |
|
잔액 변동 내역 | GET |
| |
충전 내역 | GET |
| |
무료 제공량 | GET |
| |
잔액 부족 알림 설정 | GET |
| |
견적서 | GET |
| |
거래명세서 | GET |
| |
세금계산서 목록 | GET |
| |
출금 내역 | GET |
| |
전용 입금 계좌 | GET |
| |
선불 결제 내역 | GET |
| |
| 메시지 단가 | GET |
|
국가별 단가 | GET |
| |
| 발송 한도 | GET |
|
한도 변경 추정 | GET |
| |
시스템 한도 증가 요청 목록 | GET |
|
거절 메시지
메시지 | 뜻 |
|---|---|
이 API Key 에는 | 키에 그 권한을 더해 다시 만들어야 합니다. |
발송은 API Key 에 직접 지정한 IP 에서만 할 수 있습니다. | 요청한 IP 가 키의 허용 IP 에 없습니다. |
CRM 레코드 변경은 자동화로 메시지가 나갈 수 있어 message:send 권한도 필요합니다. | CRM 레코드 변경에 발송 권한이 빠졌습니다. |
API Key 로는 계정 · 자격증명 · 결제 설정 API 를 부를 수 없습니다. | 권한과 상관없이 막힌 API 입니다. |
이 작업은 API Key 로 할 수 없습니다. 콘솔에서 진행해 주세요. | 콘솔에서만 하는 작업입니다. |
아직 API Key 권한을 준비 중인 기능이라 부를 수 없습니다. | 권한을 준비하고 있는 기능입니다. |
이 API Key 로 부를 수 없는 API 입니다. | 권한 목록에 없는 API 입니다. |