SENS 개요

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

Simple & Easy Notification Service는 별도의 메시지 서버 구축 없이 다양한 유형(SMS, 알림톡, 친구톡)의 알림 메시지 기능을 구현할 수 있는 네이버 클라우드 플랫폼의 서비스입니다. Simple & Easy Notification Service에서는 메시지 발송 및 관리 기능에 대한 API를 RESTful 형태로 제공합니다.

Simple & Easy Notification Service 공통 설정

Simple & Easy Notification Service API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://sens.apigw.gov-ntruss.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간차 발생 시 유효하지 않은 요청으로 간주
  • Unix Timestamp 형식
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명
Content-Type Required 요청 데이터의 형식
  • application/json

응답

공통 응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

error
error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
status Integer Required 오류 코드
error String Required 오류 이름
message String Required 오류 메시지

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 메시지 설명
200 OK 요청 성공
204 No Content 요청 성공 (삭제 완료)
400 Bad Request 잘못된 요청
401 Unauthorized 인증 실패
403 Forbidden 접근 권한 없음
404 Not Found 리소스를 찾을 수 없음
429 Too Many Requests 요청 횟수 초과
500 Internal Server Error 서버 내부 오류
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
    "status": 403,
    "error": "Forbidden",
    "message": "Do not have access to this 'serviceId'"
}

Simple & Easy Notification Service API

Simple & Easy Notification Service 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

프로젝트

프로젝트 관련 API에 대한 설명은 다음과 같습니다.

API 설명
프로젝트 생성 프로젝트 생성
프로젝트 목록 조회 프로젝트 목록 조회
프로젝트 조회 프로젝트 상세 정보 조회
프로젝트 수정 프로젝트 정보 수정
프로젝트 삭제 프로젝트 삭제

SMS

SMS 관련 API에 대한 설명은 다음과 같습니다.

API 설명
메시지 발송 SMS/LMS/MMS 메시지 발송
메시지 발송 목록 조회 메시지 발송 목록 조회
메시지 발송 결과 조회 메시지 발송 결과 조회
발송 예약 상태 조회 메시지 발송 예약 상태 조회
발송 예약 취소 메시지 발송 예약 취소
수신 거부 번호 등록 수신 거부 번호 등록
수신 거부 번호 조회 수신 거부 번호 조회
수신 거부 번호 삭제 수신 거부 번호 삭제
파일 업로드 MMS 발송용 파일 업로드

알림톡

알림톡 관련 API에 대한 설명은 다음과 같습니다.

API 설명
채널 조회 알림톡 채널 조회
템플릿 조회 알림톡 템플릿 조회
알림톡 발송 알림톡 메시지 발송
알림톡 발송 목록 조회 알림톡 발송 요청 조회
알림톡 발송 결과 조회 알림톡 발송 결과 조회
발송 예약 상태 조회 알림톡 발송 예약 상태 조회
발송 예약 취소 알림톡 발송 예약 취소

친구톡

친구톡 관련 API에 대한 설명은 다음과 같습니다.

API 설명
채널 조회 친구톡 채널 조회
친구톡 발송 친구톡 메시지 발송
친구톡 발송 목록 조회 친구톡 발송 목록 조회
친구톡 발송 결과 조회 친구톡 발송 결과 조회
발송 예약 상태 조회 친구톡 발송 예약 상태 조회
발송 예약 취소 친구톡 발송 예약 취소
이미지 업로드 친구톡에 사용할 이미지 업로드
이미지 목록 조회 업로드된 이미지 목록 조회
이미지 조회 업로드된 이미지 상세 정보 조회
이미지 삭제 업로드된 이미지 삭제

브랜드 메시지

브랜드 메시지 관련 API에 대한 설명은 다음과 같습니다.

API 설명
메시지 발송 브랜드 메시지 발송
메시지 발송 목록 조회 브랜드 메시지 발송 목록 조회
메시지 발송 결과 조회 브랜드 메시지 발송 결과 조회
이미지 업로드 브랜드 메시지에 사용할 이미지 업로드
이미지 목록 조회 업로드된 이미지 목록 조회
이미지 조회 업로드된 이미지 상세 정보 조회
이미지 삭제 업로드된 이미지 삭제

Simple & Easy Notification Service 연관 리소스

Simple & Easy Notification Service API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.