네이버 클라우드 플랫폼의 상품 사용 방법을 보다 상세하게 제공하고, 다양한 API의 활용을 돕기 위해 [설명서][API 참조서]를 구분하여 제공하고 있습니다.

2019년 1월 10일부터 Ncloud의 OPEN API 설명서가 리뉴얼되었습니다.
리뉴얼된 설명서는 아래 링크를 참고하여 주시기 바랍니다.

PUSH API(v2, 신버전) API 참조서 바로가기 >>
Simple & Easy Notification Service Push 설명서 바로가기 >>

목차

인증서 발급받기

Push 서비스를 이용하기 위해서는 사용하려는 Push Type별로 인증서를 발급받고 해당 인증서를 Simple & Easy Notification Service에 등록해야 합니다.

인증서 등록하기

콘솔 접속 후 Push > Certificate 메뉴를 클릭합니다.

등록된 프로젝트 목록 중에 인증서를 등록할 프로젝트를 선택합니다.

GCM/FCM 인증서 등록하기

① 검색창을 이용해 언제든 프로젝트를 전환할 수 있습니다.
② 발급받은 Sender Id
③ 발급받은 Server Key

APNS 인증서 등록하기

프로젝트를 선택한 뒤, 인증서를 등록합니다.

① 인증서 파일 업로드
② 인증서 비밀번호
③ 인증서 Type(Sandbox/Production)
④ App Id(인증서가 등록되면 표시됩니다.)
⑤ 인증서 만료일(인증서가 등록되면 표시됩니다.)

인증서 수정하기

등록된 인증서 정보를 변경하면 저장 버튼이 활성화됩니다. 저장 버튼을 클릭하면 인증서 정보가 수정됩니다.

인증서 삭제하기

인증서가 등록된 상태에서는 삭제 버튼이 노출됩니다. 삭제 버튼을 클릭하면 인증서를 삭제할 수 있습니다.

① 삭제할 인증서의 프로젝트 이름을 다시 한 번 입력하면 확인 버튼이 활성화됩니다.

사용자 디바이스 등록/삭제하기

인증서 등록이 완료되었으면 사용자/디바이스를 등록/삭제할 수 있습니다.

사용자/디바이스 등록/삭제 기능은 OPEN API로 제공됩니다(API v2 사용 가이드 바로가기). 제공되는 OPEN API를 사용하여 고객의 Application에서 자유롭게 사용자 및 디바이스 토큰을 관리할 수 있습니다.

채널 생성하기

콘솔 접속 후 Push > Channel 메뉴를 클릭합니다.

등록된 프로젝트 목록 중 채널을 생성할 프로젝트를 선택합니다. 검색창을 이용해 언제든 프로젝트를 전환할 수 있습니다.

생성하기 버튼을 클릭하면 채널 생성 대화 상자가 나타납니다.

① 채널 이름입니다. 반드시 입력해야 하는 값으로, 알파벳 소문자, 숫자, 하이픈(-), 밑줄(_)로만 구성할 수 있고, 24자 미만으로 입력할 수 있습니다.
② 채널 설명입니다. 128자 미만으로 입력할 수 있습니다.

채널에 사용자 등록/삭제하기

채널 생성이 완료되었으면, 채널에 사용자를 등록할 수 있습니다. 채널 관리 기능은 OPEN API로 제공됩니다(API v2 사용 가이드 바로가기).

채널 수정하기

채널 조회 화면에서 수정하려는 채널 오른쪽 끝의 버튼을 클릭하고 수정 버튼을 클릭합니다.

① 채널 이름은 수정할 수 없습니다.
② 채널 설명은 수정할 수 있습니다.

채널 삭제하기

채널 조회 화면에서 삭제하려는 채널 오른쪽 끝의 버튼을 클릭하고 삭제 버튼을 클릭합니다.

① 삭제할 채널의 이름을 다시 한 번 입력하면 확인 버튼이 활성화됩니다.

메시지 발송하기

Push 메시지 발송은 OPEN API를 통해서만 가능합니다. OPEN API 사용 가이드 바로가기

메시지 발송 결과 조회하기

메시지 발송 결과를 수 초 이내에 실시간으로 조회할 수 있습니다. 결과보기 버튼을 클릭합니다.

① 메시지 발송 결과를 확인할 수 있습니다. JSON 형식의 데이터로 제공됩니다.

항목 Mandatory Type 설명 비고
requestId Mandatory String 요청 아이디
requestTime Mandatory DateTime 요청 시간
statusCode Mandatory String 요청 상태 코드 아래 Response Code 참조
statusName Mandatory String 요청 상태명 success - 성공
fail - 실패
statusMessage Mandatory String 요청 상태 메시지
messageStatusCode Mandatory String 발송 상태 코드 200 - 성공
그외 - 실패
messageStatusName Mandatory String 발송 상태명 success - 성공
processing - 처리 중
fail - 실패
completeTime Mandatory DateTime 발송 완료 시간
targetCount Mandatory Integer 요청 대상 디바이스 갯수
sentCount Mandatory Integer 발송 성공 디바이스 갯수
messageType Mandatory String 메시지 타입 NOTIF - 알림 메시지
AD - 광고성 메시지
target Mandatory Object 발송 요청 target 정보
message Mandatory Object 발송 요청 message 정보  
  • 발송 상태가 처리 중(processing)인 경우, targetCount/sentCount가 0으로 조회됩니다(집계 전).

메시지 발송 이력 조회하기

메시지 발송 이력을 조회할 수 있습니다. 최대 30일까지 보관됩니다.

① 요청 일시로 검색할 수 있습니다.
② 요청 상태로 검색할 수 있습니다.
③ 메시징 서버로의 요청 상태를 의미합니다(Success, Fail).
④ 메시징 서버에서의 발송 상태를 의미합니다(Success, Processing, Fail).
⑤ 발송 요청 결과를 조회할 수 있습니다.

예약 메시지 결과 조회/취소하기

Reservation 메뉴로 이동하기

콘솔 접속 후 Push > Reservation 메뉴에서 예약 내역 탭으로 이동합니다.

예약 내역 조회하기

① 예약 시간으로 검색할 수 있습니다.
② 상태로 검색할 수 있습니다.
③ 예약 시간대에 해당하는 예약 시간입니다.
④ 예약 상태를 의미합니다. READY, PROCESSING, CANCELED, FAIL, DONE, STALE, SKIP으로 구분됩니다.
⑤ 메시지 예약 ID입니다.
⑥ 상세보기를 클릭하면 메시지 발송 내용을 조회할 수 있는 창이 팝업됩니다.

예약 취소하기

① 취소를 원하는 예약을 클릭합니다.
② 상단에 예약취소 버튼을 클릭합니다. (예약 취소의 경우 Ready 상태의 예약만 취소 가능합니다.)
③ 취소하려고 하는 예약 내역이 맞는지 확인 후 삭제하시면 됩니다.

스케줄 생성/수정/삭제하기

Reservation 메뉴로 이동하기

콘솔 접속 후 Push > Reservation 메뉴에서 스케줄 탭으로 이동합니다.

프로젝트 선택 및 메시지 발송 화면 팝업하기

등록된 프로젝트 목록 중에 스케줄을 생성할 프로젝트를 선택합니다.

① 검색 창을 이용해 언제든 프로젝트를 전환할 수 있습니다.
② 프로젝트 선택 후 생성하기 버튼을 클릭합니다.

스케줄 생성하기

① 스케줄 발송에 사용할 스케줄 코드를 입력합니다.
② 반복할 요일을 선택합니다. 매일을 클릭하면 모든 요일이 선택됩니다.
③ 메시지를 발송할 시간을 입력합니다. [HH:mm] 형태로 입력가능하며, 선택하신 TimeZone에 맞춰 발송됩니다.
④ 스케줄이 동작하는 기간을 선택합니다. 최대 6개월 뒤까지 선택가능합니다.
⑤ 스케줄에 대한 설명을 자유롭게 입력합니다.

스케줄 수정/삭제하기

① 수정 또는 삭제할 스케줄을 선택합니다.
수정 버튼을 클릭해 원하시는 정보로 수정 후 업데이트합니다.
삭제 버튼을 클릭해 스케줄 코드를 입력 후 삭제합니다.

스케줄 메시지 조회하기

스케줄을 클릭하면 스케줄 아래에서 스케줄 메시지를 확인할 수 있습니다.
② 스케줄에 Mapping된 메시지 ID입니다.
상세보기를 클릭하면 메시지에 대한 정보를 조회할 수 있습니다.

""에 대한 건이 검색되었습니다.

    ""에 대한 검색 결과가 없습니다.

    처리중...