API 메서드 레퍼런스 인덱스

Pushwoosh는 알림 전송, 사용자 관리, 분석 추적과 같은 다양한 기능을 위해 분류된 100개 이상의 API 메서드로 구성된 방대한 라이브러리를 제공합니다.

메시징 API v2

/create*Message 제품군(푸시, 이메일, SMS, 카카오) 전체를 대체하는 통합 API입니다. 개요 및 마이그레이션 가이드를 참조하세요.

Notify	모든 채널을 통해 단일 메시지를 생성하고 전송합니다. /createMessage, /createTargetedMessage, /createEmailMessage, /createSMSMessage, /createKakaoMessage를 대체합니다.
Cancel	이전에 생성된 메시지가 전달되기 전에 취소합니다. Notify의 message_code와 함께 사용하세요.
Update	아직 예약된 메시지를 새로운 정의로 대체합니다(전체 교체). Notify의 message_code와 함께 사용하세요.

SMTP 게이트웨이

API를 직접 호출하는 대신 표준 SMTP를 통해 트랜잭션 이메일을 제출합니다. 게이트웨이는 애플리케이션 코드와 API 토큰으로 인증한 다음 각 메시지를 Notify로 전달합니다. SMTP 게이트웨이 레퍼런스를 참조하세요.

메시지 API

createMessage 사용 중단됨	새로운 푸시 알림을 생성합니다. 대신 Notify를 사용하세요.
deleteMessage	메시지(전송되었거나 예약된)를 삭제하고 메시지 기록에서 제거합니다.
getMessageDetails	메시지 세부 정보를 검색합니다.
createTargetedMessage 사용 중단됨	새로운 타겟 푸시 알림을 생성합니다. 대신 transactional 종류와 함께 Notify를 사용하세요.
getPushHistory 사용 중단됨	상세 데이터와 함께 메시지 기록을 검색하려면 /messages:list를 사용하세요.
cancelMessage	예약된 메시지를 취소하고 메시지 기록에 유지합니다.

프리셋 API

Create	새로운 푸시 프리셋을 생성합니다.
List	애플리케이션의 푸시 프리셋을 나열합니다.
Get	코드로 단일 푸시 프리셋을 검색합니다.
Update	코드로 푸시 프리셋을 덮어씁니다.
UpdatePartial	코드로 푸시 프리셋의 제공된 필드만 업데이트합니다.
Clone	동일한 애플리케이션 내에서 푸시 프리셋을 복제합니다.
Delete	코드로 푸시 프리셋을 삭제합니다.

디바이스 API

registerDevice	애플리케이션에 디바이스를 등록합니다.
unregisterDevice	디바이스의 푸시 토큰을 제거합니다.
deleteDevice	지정된 애플리케이션에서 디바이스와 모든 관련 데이터를 삭제합니다.
setTags	디바이스에 대한 태그 값을 설정합니다.
getTags	특정 디바이스에 대한 태그와 해당 값을 검색합니다.
setBadge	디바이스의 현재 배지 값을 Pushwoosh로 보냅니다.
applicationOpen	앱 열기 이벤트를 등록합니다.
pushStat	푸시 열기 이벤트를 등록합니다.
messageDeliveryEvent	디바이스에 대한 푸시 전달 이벤트를 등록합니다.

Audience API

bulkSetTags	여러 디바이스에 대한 태그 값을 설정합니다.
bulkSetTags Status	bulkSetTags 작업의 상태를 반환합니다.
bulkRegisterDevice	단일 요청으로 여러 디바이스를 등록하며, 각 디바이스에 대한 선택적 태그 값을 포함합니다.
bulkRegisterDevice Status	요청 ID를 사용하여 대량 디바이스 등록 요청의 상태와 결과를 검색합니다.
bulkUnregisterDevice	단일 요청으로 여러 디바이스를 등록 해제합니다.
bulkUnregisterDevice Status	요청 ID를 사용하여 대량 디바이스 등록 해제 요청의 상태와 결과를 검색합니다.

태그 API

addTag	계정에 태그를 생성합니다.
deleteTag	모든 관련 정보와 함께 태그를 제거합니다.
listTags	계정의 태그 목록을 검색합니다.

세분화(필터) API

createFilter	새로운 세그먼트를 생성합니다.
listFilters	사용 가능한 세그먼트 목록과 그 조건을 반환합니다.
deleteFilter	기존 세그먼트를 삭제합니다.
exportSegment	세그먼트 조건과 일치하는 구독자를 내보내는 요청을 예약합니다.
exportSegment Results	exportSegment 결과에 대한 CSV 링크를 검색합니다.

사용자 중심 API

registerUser	외부 User ID를 지정된 디바이스와 연결합니다.
deleteUser	지정된 User ID와 연결된 사용자와 모든 디바이스를 삭제합니다.
postEvent	앱 내에서 이벤트를 호출합니다.

이벤트 API

createEvent	앱에 대한 이벤트를 생성합니다.

애플리케이션 API

createApplication	계정에 새로운 애플리케이션을 생성합니다.
updateApplication	애플리케이션 설정을 업데이트합니다.
deleteApplication	계정에서 앱을 삭제합니다.
getApplication	앱에 대한 세부 정보를 가져옵니다.
getApplications	계정의 애플리케이션 목록을 검색합니다.
getApplicationFile	앱과 관련된 구성 파일을 검색합니다.
setApplicationPlatformStatus	앱의 플랫폼 상태를 변경합니다.

캠페인 API

createCampaign	새로운 푸시 캠페인을 생성합니다.
deleteCampaign	특정 캠페인을 삭제합니다.
getCampaigns	앱의 캠페인 목록을 검색합니다.

앱 구성 API

configureApplication for iOS	앱에 대한 iOS 플랫폼을 구성합니다.
configureApplication for Android	앱에 대한 Android 플랫폼을 구성합니다.
configureApplication for Mac OS X	앱에 대한 macOS 플랫폼을 구성합니다.
configureApplication for Windows	앱에 대한 Windows 플랫폼을 구성합니다.
configureApplication for Amazon	앱에 대한 Amazon 플랫폼을 구성합니다.
configureApplication for Chrome	앱에 대한 Chrome 플랫폼을 구성합니다.
configureApplication for Safari	앱에 대한 Safari 플랫폼을 구성합니다.
configureApplication for Firefox	앱에 대한 Firefox 플랫폼을 구성합니다.
configureApplication for Email	앱에 대한 이메일 플랫폼을 구성합니다.

이메일 API

createEmailMessage 사용 중단됨	이메일 메시지를 생성합니다. 대신 platforms: ["EMAIL"]과 email_payload와 함께 Notify를 사용하세요.
registerEmail	앱에 이메일 주소를 등록합니다.
deleteEmail	데이터베이스에서 이메일 주소를 제거합니다.
setEmailTags	지정된 이메일 주소에 대한 태그 값을 설정합니다.
registerEmailUser	외부 User ID를 지정된 이메일 주소와 연결합니다.

이메일 템플릿 API

Create	애플리케이션에 새로운 이메일 템플릿을 생성합니다.
List	애플리케이션의 이메일 템플릿을 나열합니다.
Get	코드로 단일 이메일 템플릿을 반환합니다.
Update	코드로 기존 이메일 템플릿을 업데이트합니다.
Delete	코드로 이메일 템플릿과 연결된 프리셋을 삭제합니다.
Clone	이메일 템플릿을 대상 애플리케이션으로 복제합니다.

테스트 디바이스 API

createTestDevice	애플리케이션에 테스트 디바이스를 등록합니다.
listTestDevices	애플리케이션에 등록된 모든 테스트 디바이스를 검색합니다.

메시지 인박스 API

getInboxMessages	지정된 HWID에 대한 인박스 메시지 목록을 검색합니다.
inboxStatus	특정 인박스 메시지의 상태를 업데이트합니다.

통계 API

메시지 통계

messages:list	전송된 메시지 목록을 검색합니다.
totalsByIntervals	시간별로 집계된 메트릭 및 전환 데이터를 제공합니다.
getDeliveryFunnel	단일 메시지에 대한 전달 퍼널을 반환하며, 각 단계에서 Audience가 손실되는 위치에 대한 분석을 제공합니다.
getMessageLog	전송된 메시지에 대한 상세 정보를 검색합니다.
linksInteractions	이메일 링크 클릭에 대한 통계를 제공합니다.
linksInteractionsDevices	이메일의 링크를 클릭한 사용자 목록을 보여줍니다.
bouncedEmails	이메일 반송, 불만 사항 및 반송 사유에 대한 정보를 제공합니다.

비동기 메시지 통계 내보내기

exportMessagesStatistics/export	messages:list의 행 제한 없이 메시지 기록을 CSV 파일로 내보내는 작업을 대기열에 추가합니다.
exportMessagesStatistics/status	내보내기 작업의 진행 상황을 반환합니다.
exportMessagesStatistics/result	작업이 완료되면 생성된 파일 이름을 반환합니다.
exportMessagesStatistics/lastTasks	애플리케이션의 최근 내보내기 작업 목록을 보여줍니다.
exportMessagesStatistics/delete	보존 기간이 만료되기 전에 작업과 해당 파일을 삭제합니다.
exportMessagesStatistics/download	이름으로 생성된 CSV 파일을 다운로드합니다.

애플리케이션 및 구독자 통계

getApplicationSubscribersStats	디바이스 유형별로 그룹화된 앱의 구독자 통계를 검색합니다.
getAppStats	특정 기간 동안의 앱 통계를 검색합니다.
getSubscribersStatistics	특정 기간 동안의 구독자 통계를 검색합니다.

캠페인 통계

getCampaignStats	특정 기간 동안의 캠페인 통계를 검색합니다.

이벤트 및 태그 통계

getEventStatistics	특정 기간 동안 이벤트가 트리거된 횟수를 검색합니다.
getTagStats	특정 태그에 대한 통계를 검색합니다.

인앱 통계

inapps:totals	기간 동안 하나 이상의 인앱 캠페인에 대한 노출, 상호 작용 및 빈도 제한 총계를 검색합니다.
inapps:timeline	단일 캠페인에 대한 기간 총계 및 인앱 메트릭의 시계열을 검색합니다.

iOS 실시간 현황 API

startLiveActivity	새로운 iOS 실시간 현황을 생성합니다.
updateLiveActivity	기존 iOS 실시간 현황을 업데이트합니다.

Apple Wallet PassKit API

Apple Wallet PassKit API	Pushwoosh에서 Apple Wallet 패스 및 관련 구성을 관리하기 위한 레퍼런스입니다.

Google Wallet API

Create a pass	Google Wallet에서 패스를 생성하고 저장 링크를 반환합니다.
Validate a pass	패스를 생성하지 않고 패스 구성을 확인합니다.
Update a pass	기존 패스를 업데이트합니다. Google은 저장된 디바이스에 변경 사항을 전달합니다.
Get a save link	기존 패스에 대한 “Google Wallet에 추가” 저장 링크를 반환합니다.
Get a pass	저장된 단일 패스를 반환합니다.
List passes	애플리케이션에 대한 패스 목록을 페이지별로 반환합니다.
Set pass state	패스를 활성화하거나 무효화합니다.
Delete a pass	Google에서 패스를 무효화하고 Pushwoosh 기록을 제거합니다.
Get configuration	애플리케이션에 대한 Google Wallet 구성 상태를 반환합니다.
Templates	패스 템플릿을 나열하거나 시작점으로 하나를 가져옵니다.

Customer Journey API

Lifecycle	UUID로 Journey를 시작, 일시 중지, 완료, 초안 작성 또는 보관합니다.
Create and update	새로운 Journey 정의를 생성하거나 기존 정의를 대체합니다.
Start by API	실행 중인 Journey의 API 진입점으로 사용자를 주입합니다.
Get Journey stats	ID로 특정 Journey에 대한 통계를 얻습니다.
Remove users from journeys	전체 또는 선택된 활성 Journey에서 한 명 이상의 사용자를 제거합니다.

예약된 요청 API

getResults	예약된 요청의 결과를 검색합니다.

SMS API

createSMSMessage 사용 중단됨	새로운 SMS 메시지를 생성합니다. 대신 platforms: ["SMS"]와 함께 Notify를 사용하세요.

WhatsApp API

createWhatsAppMessage 사용 중단됨	새로운 WhatsApp 메시지를 생성합니다. 대신 platforms: ["WHATS_APP"]과 함께 Notify를 사용하세요.

LINE API

createLineMessage 사용 중단됨	새로운 LINE 메시지를 생성합니다. 대신 platforms: ["LINE"]과 함께 Notify를 사용하세요.

카카오 API

createKakaoMessage 사용 중단됨	승인된 템플릿을 사용하여 카카오 메시지를 보냅니다. 대신 platforms: ["KAKAO"]와 함께 Notify를 사용하세요.

지오존 API

getNearestZone	가장 가까운 지오존의 매개변수와 거리를 검색합니다. 또한 지오 푸시 알림을 위해 디바이스 위치를 기록합니다.
addGeoZone	특정 앱에 지오존을 추가합니다.
updateGeoZone	이름, 상태, 콘텐츠, 범위와 같은 지오존 속성을 업데이트합니다.
deleteGeoZone	앱에서 지오존을 제거합니다.
addGeoZoneCluster	앱에 지오존 클러스터를 추가합니다.
deleteGeoZoneCluster	앱에서 지오존 클러스터를 제거합니다.
listGeoZones	앱의 지오존 목록을 검색합니다.
listGeoZoneClusters	앱의 지오존 클러스터 목록을 검색합니다.