웹푸시 일괄 발송

사용자에게 웹 푸시를 발송할 수 있는 API입니다.

개요

WEB PUSH는 구독, 발송 두 가지 단계로 구분됩니다.

발송은 형식, 수신지 정보를 JSON 형태로 가공하여 사용자 브라우저에 전달하고, 브라우저 상의 ServiceWorker가 PUSH를 생성하는 과정을 말합니다.

발송 API를 호출할 경우 고객식별자(clientId) 또는 사용자식별자(userId), 구독식별자(subscrpId)에 따라 API PLEX Gateway에 저장된 endpoint 정보에 PUSH를 전송합니다.

API 호출 시 입력해주신 PUSH 설정 정보 JSON이 해당 endpoint(사용자의 화면이 띄워지는 브라우저)로 전송되면, .js 파일에 정의된 ServiceWorker 설정 파일에 따라 PUSH를 생성합니다.

발송 ServiceWorker 설정 파일은 API 사용 계약 시 제공됩니다.

웹푸시 일괄 발송API

PUSH에 삽입할 타이틀, 텍스트, 아이콘, 그림, 버튼 명, 버튼 링크를 포함한 JSON을 API로 전송 시 ClientId에 해당하는 모든 Endpoint에 PUSH를 전송합니다.

캐릭터 인코딩은 UTF-8을 기본으로 합니다.

JSON 형태의 전송값은 application/json; charset=utf-8을 기본으로 사용합니다.

웹푸시 구독 신청 API

POST https://d02vc26mxg.apigw.ntruss.com/web-push/v1_0/api/notify/all

Headers

Name	Type	Description
Authorization*	string	사용자ID;secret_key

Request Body

Name	Type	Description
payload*	object	Push 설정값
clientId*	string	API Plex에서 사용하는 고객 아이디
image	string	브라우저에 따라 위/아래에 위치하는 이미지 URL 이미지 크기는 512 x 256 또는 1440 x 720 권장 서버 내 이미지 파일URL 또는 웹 상의 image Link ( .png, .jpeg, .jpg 지원 )
icon	string	브라우저에 따라 좌/우에 위치하는 아이콘 URL 이미지 크기는 256 x 256 또는 그 이상을 권장 서버 내 이미지 파일URL 또는 웹 상의 image Link ( .png, .jpeg, .jpg 지원 )
text	string	PUSH 타이틀 아래의 내용 문구 30자 이상일 경우 …로 축약 표시됨
title	string	PUSH 타이틀 문구
msgKey*	string	해당 Push 요청을 구분할 수 있는 특정한 임의의 값
viewUrl	string	좌측 버튼 클릭 시 이동하는 URL
viewButtonName	string	좌측에 위치하는 버튼 명 10자 이하 권장
homeUrl	string	우측 버튼 클릭 시 이동하는 URL
homeButtonName	string	우측에 위치하는 버튼 명 10자 이하 권장

200: OK 응답 반환 완료

Response Body

{
    "code": 2004,
    "desc": "Saved Notification Successfully"
    "successCount": 14531,
    "msgKey": "msgkey1"
}

키	타입	설명
code	number	전송 결과 코드
desc	string	결과 코드에 대한 설명
successCount	number	PUSH 발송 성공 수
msgKey	string	해당 Push 요청을 구분할 수 있는 특정한 임의의 값

전송 결과 코드

code	설명
2004	Saved Notification Successfully
4004	clientId is empty
4042	Could not found Subscription
4043	Could not found ClientId
4049	Already Exist
5001	System Error