푸시 알림 설정 조회

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

사용자의 푸시 알림 설정 내역을 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`userId`	String	Required	사용자 아이디 사용자 목록 조회 참조

요청 예시

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

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/NCP001/notification' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "id": "NCP001",
    "notifications": {
        "token": "48b673227f*************************17ac563d712dad",
        "device": "sandbox",
        "os": "17.5.1",
        "push": true,
        "ad": true,
        "night": true,
        "timezone": null
    }
}