푸시 알림 설정

Prev Next

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

사용자에게 푸시 알림을 설정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /v1/api/members/{userId}/notification

요청 헤더

Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
userId String Required 사용자 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
token String Optional 푸시 토큰
device String Optional 디바이스 푸시 타입
  • FCM | APNS
os String Optional 운영 체제 버전
push Boolean Optional 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
ad Boolean Optional 광고성 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
night Boolean Optional 야간 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
timezone String Optional 시간대

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/39c8de0f-****-****-****-6a1a875df59f/notification' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "token": "dXNhZ2******************************YWJjZGVm",
    "device": "APNS",
    "os": "iOS 18",
    "push": true,
    "ad": true,
    "night": true,
    "timezone": "Asia/Seoul"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
member Object - 사용자 정보
member.id String - 사용자 아이디
member.notifications Object - 푸시 알림 설정 내역
member.notifications.token String - 푸시 토큰
member.notifications.device String - 디바이스 푸시 타입
  • FCM | APNS
member.notifications.os String - 운영 체제 버전
member.notifications.push Boolean - 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.ad Boolean - 광고성 푸시 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.night Boolean - 야간 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.timezone String - 시간대
  • 미설정인 경우, null 표시
status Integer - 응답 상태
  • 1: 성공
  • 1이 아닌 경우: 실패

응답 상태 코드

Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "member": {
        "id": "39c8de0f-****-****-****-6a1a875df59f",
        "notifications": {
            "token": "dXNhZ2******************************YWJjZGVm",
            "device": "APNS",
            "os": "iOS 18",
            "push": true,
            "ad": true,
            "night": true,
            "timezone": null
        }
    },
    "status": 1
}