Classic/VPC 환경에서 이용 가능합니다.
지정한 스케줄에 따라 원하는 사용자에게 다국어 푸시 알림 메시지를 발송합니다. 즉시 발송과 예약 발송을 모두 지원합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /v2/notifications/push |
요청 헤더
GAMEPOT 3.0 API에서 공통으로 사용하는 헤더에 대한 정보는 GAMEPOT 3.0 요청 헤더를 참조해 주십시오.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
scheduleCode |
String | Required | 스케줄 코드 |
scheduleDesc |
String | Required | 스케줄 설명 |
scheduleTimeZone |
String | Required | 스케줄 시간대 |
scheduleTime |
String | Required | 발송 일시
|
startDate |
String | Optional | 스케줄 시작 일시
|
endDate |
String | Optional | 스케줄 종료 일시
|
messageType |
String | Required | 메시지 유형
|
title |
Object | Required | 푸시 제목 정보 |
title.content |
String | Required | 기본 제목 |
title.i18n |
Object | Required | 다국어 제목 정보 |
title.i18n.default |
Object | Required | 기본 언어 제목 정보 |
title.i18n.default.content |
String | Required | 기본 언어 제목 |
title.i18n.[language] |
Object | Optional | 다국어 제목 정보
|
title.i18n.[language].content |
String | Optional | 다국어 제목 |
message |
Object | Required | 푸시 메시지 정보 |
message.content |
String | Required | 기본 메시지 |
message.custom |
Object | Optional | 사용자 정의 데이터
|
message.option |
Object | Optional | 메시지 옵션 |
message.i18n |
Object | Required | 다국어 메시지 정보 |
message.i18n.default |
Object | Required | 기본 언어 메시지 정보 |
message.i18n.default.content |
String | Required | 기본 언어 메시지 |
message.i18n.[language] |
Object | Optional | 다국어 메시지 정보
|
message.i18n.[language].content |
String | Optional | 다국어 메시지 |
dayOfWeeks |
Array | Required | 스케줄 요일 목록 |
deviceType |
String | Required | 디바이스 타입
|
to |
Array | Optional | 수신자 아이디 목록
|
type |
String | Required | 푸시 수신 대상
|
country |
Array | Optional | 국가 코드 목록 |
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://dashboard-api.gamepot.ntruss.com/v2/notifications/push' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"scheduleCode": "code1234",
"scheduleDesc": "description",
"scheduleTimeZone": "Asia/Seoul",
"scheduleTime": "2025-09-24T00:00:00.170Z",
"messageType": "AD",
"title": {
"content": "제목",
"i18n": {
"default": {
"content": "제목"
},
"en": {
"content": "Title"
},
"ko": {
"content": "제목"
}
}
},
"message": {
"content": "메시지",
"custom": {},
"option": {},
"i18n": {
"default": {
"content": "메시지"
},
"en": {
"content": "message"
},
"ko": {
"content": "메시지"
}
}
},
"dayOfWeeks": [],
"deviceType": "ALL",
"to": [],
"type": "ALL",
"country": []
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
status |
Integer | - | 응답 코드 |
message |
Object | - | 푸시 발송 정보 |
message.status |
Boolean | - | 푸시 발송 성공 여부
|
message.id |
String | - | 푸시 발송 요청 아이디 |
응답 상태 코드
GAMEPOT 3.0 API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 GAMEPOT 3.0 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"status": 1,
"message": {
"status": true,
"id": "521f5bcc-****-****-****-ff89474822ed"
}
}