인앱 메시지·푸시 마케팅 SDK 연동 | Appbox
메시지•인앱•푸시 마케팅
푸시 허용 등록
이를 통해 사용자 설정에 따라 푸시 메시지가 정상적으로 발송되거나 차단될 수 있도록 제어할 수 있어, 개인정보 동의 상태나 알림 설정 변화에 따른 정확한 메시지 발송이 가능합니다.
푸시 알림 허용 여부를 갱신
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| agree | 필수 | 푸시수신 동의 여부 (Y 또는 N) | Y | |
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | 성공 여부 (true | false) |
| err.code | 에러코드 ( -7000 : 권한 없음, -8000 : 서버 오류) |
| err.message | 에러 메시지 |
푸시를 수신하려면 사용자가 푸시 권한을 승인 하여야 합니다.
허용하지 않은 경우 위의 표기와 같이 err.code = -7000 시스템 권한 없음으로 리턴됩니다.
이런 경우 "앱 설정으로 이동 AppboxSDK.application.openAppSettings(); " 을 이용하여 사용자가 푸시 허용을 설정할 수 있도록 자동 이동 시킬 수 있습니다.
푸시 허용 여부
이를 통해 앱의 푸시 설정 페이지 등에서 푸시 수신여부 추기값을 ON 또는 OFF로 설정할 수 있습니다.
푸시 알림 허용 여부를 확인
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | Y : 허용, N : 거부 |
| err.code | 에러코드 (-8000 : 서버 오류) |
| err.message | 에러 메시지 |
data.result 값이 Y인 경우는 필히 푸시를 수신할 수 있는 경우입니다.
단, N으로 리턴 되는 경우는 OS 설정 에서 해당앱의 푸시를 거부하거나, 사용자가 앱에서 푸시를 거부 한 경우입니다.
사용자가 앱에서 푸시를 받겠다고 설정하여도 OS설정에서 푸시 거부가 되어 있는 상태라면, N으로 리턴됩니다.
푸시 토큰 요청
웹과 네이티브 간 연동을 통해 사용자 기기에서 토큰을 수신할 수 있는 기능으로, 앱 실행 시 또는 토큰이 필요한 시점에 호출하여 최신 토큰을 확보할 수 있습니다.
푸시 토큰 요청
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | 사용자 디바이스 푸시 토큰 |
로컬 푸시 발송
네트워크가 연결되어 있지 않아도 알림을 바로 보여줄 수 있어, 예약 알림, 미션 완료 안내, 앱 내 이벤트 반응 등 즉각적인 피드백이 필요한 상황에 효과적으로 활용할 수 있습니다.
주요 내용을 로컬푸시로 알림
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| title | - | 제목 | ||
| message | 필수 | 메시지 내용 | ||
| targetUrl | - | 이동 URL | ||
| overlap | - | true: groupID가 동일하면 최종건 하나만 노출, false: 항상 쌓임 | false | |
| groupID | - | overlap의 항목과 함께 사용되는 그룹아이디 (0부터 9까지 숫자만 입력) | 0 | |
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | 성공 여부 (true | false) |
| err.code | 에러코드 ( -7000 : 권한 없음 ) |
| err.message | 에러 메시지 |
푸시를 수신하려면 사용자가 푸시 권한을 승인 하여야 합니다.
허용하지 않은 경우 위의 표기와 같이 err.code = -7000 시스템 권한 없음으로 리턴됩니다.
이런 경우 "앱 설정으로 이동 AppboxSDK.application.openAppSettings(); " 을 이용하여 사용자가 푸시 허용을 설정할 수 있도록 자동 이동 시킬 수 있습니다.
세그먼트 등록
콘솔에서 메시지를 발송할 때 세그먼트를 활용하면 전체 사용자에게 동일한 메시지를 보내는 대신, 관심사·행동·기록·속성 등에 따라 대상자를 구분하여 더욱 관련성 높은 메시지를 전달할 수 있습니다.
segment를 이용하면 사용자의 관심사/행동/특성별로 그룹을 나누어 관련성 높은 메시지를 보내고, 관심사 등의 특성별로 고객 패턴 통계를 모니터링 할 수 있습니다.
개인화 세그먼트
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| segment | 필수 | segment 값에는 콘솔에서 정의한 json 파라미터가 key, value 형태로 들어가야 합니다. | ||
segment 의 값은 {key: value} 형태로 value는 string형 입니다. 여러항목이 들어가야 할때는 {key1: value, key2: value, key3:value...} 형태로 들어갑니다.
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | 성공 여부 (true | false) |
| err.code | 에러코드 (-8000 : 서버 오류) |
| err.message | 에러 메시지 |
메시지 구독 등록
메시지 구독 등록
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| topicScheme | 필수 | 구독 키값(단일 string 또는 string 배열) | ||
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result.succeeded | 구독 성공한 topic 키값 배열 |
| data.result.failed | 구독 실패한 topic 키값 배열 |
구독 브릿지 인터페이스 전에 앱박스 콘솔에 로그인하여 사용자 관리 > 구독 등록에서 등록되어야 합니다.
메시지 구독 해지
메시지 구독 해지
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| topicScheme | 필수 | 구독 키값(단일 string 또는 string 배열) | ||
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result.succeeded | 구독 성공한 topic 키값 배열 |
| data.result.failed | 구독 실패한 topic 키값 배열 |
메시지 구독 갱신
메시지 구독 갱신
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| subscribe | 선택 | 구독할 토픽 키값 배열(string 배열, 최대 20개) | ||
| unsubscribe | 선택 | 해지할 토픽 키값 배열(string 배열, 최대 20개) | ||
* subscribe와 unsubscribe 중 최소 1개는 필수입니다. 같은 토픽 키값을 두 항목에 동시에 지정하면 요청 전체가 거부됩니다.
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result.subscribe.succeeded | 구독 성공한 topic 키값 배열 |
| data.result.subscribe.failed | 구독 실패한 topic 키값 배열 |
| data.result.unsubscribe.succeeded | 해지 성공한 topic 키값 배열 |
| data.result.unsubscribe.failed | 해지 실패한 topic 키값 배열 |
전환 이벤트 기록
이 기능은 메시지에 반응한 사용자가 최종 목표(참여, 가입, 구매 등)를 얼마나 달성했는지를 측정하는 데 활용되며, 캠페인 효과 분석과 퍼널 개선에 중요한 지표로 사용됩니다.
이벤트(푸시, 인앱 메시지)에 대한 전환 기록
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| conversionCode | 필수 | 콘솔에서 푸시 또는 인앱메시지를 발송시 생성되는 전환 코드를 입력하세요. | ||
Response 항목 정의
| Response 결과값 | |
|---|---|
| data.result | 성공 여부 (true | false) |
| err.code | 에러코드 (-8000 : 서버 오류) |
| err.message | 에러 메시지 |
전환 기록은 앱박스 콘솔로 전달되어 캠페인별 전환 성과를 집계하고 통계로 확인 할 수 있습니다.
푸시 수신 리스트
브릿지를 통해 웹페이지에서 네이티브에 저장된 푸시 수신 이력을 조회할 수 있습니다.
받은 푸시 메시지를 리스트로 가져오기
Request 항목 정의
| Request 항목 | 필수여부 | 설명 | 기본값 | |
|---|---|---|---|---|
| fromDate | - | 시작일 | ||
| toDate | - | 종료일 | ||
Response 항목 정의
| Response 결과값 | ||
|---|---|---|
| data.result | title | 제목 |
| body | 메시지 내용 | |
| param | 파라미터 (URL 또는 파라미터 등) | |
| imageUrl | 푸시에 이미지가 포함되었을때 이미지 URL | |
| createdAt | 수신 일자 | |