PUSH API

기본 정보

API URL

https://sens.apigw.ntruss.com/push/v2

SENS Push API Swagger 바로가기

API Header

NAVER Cloud Platform 인증키 및 Signature 생성 가이드 바로가기

디바이스

디바이스 토큰 등록

디바이스 토큰을 등록하고 사용자에 바인딩합니다.

요청 URL

POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

{
    "userId":"string",
    "country":"string",
    "language":"string",
    "timezone":"integer",
    "channelName":"string",
    "deviceType":"(GCM|FCMv1|APNS)",
    "deviceToken":"string",
    "isNotificationAgreement":"boolean",
    "isAdAgreement":"boolean",
    "isNightAdAgreement":"boolean"
}

응답 Body

없음

응답 Status

디바이스 토큰 조회

등록된 디바이스/사용자를 조회합니다.

요청 URL

GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

{
    "userId":"string",
    "country":"string",
    "language":"string",
    "timezone":"integer",
    "channelName":"string",
    "notificationAgreement":"boolean",
    "adAgreement":"boolean",
    "nightAdAgreement":"boolean",
    "notificationAgreementTime":"datetime",
    "adAgreementTime":"datetime",
    "nightAdAgreementTime":"datetime",
    "createTime":"datetime",
    "updateTime":"datetime",
    "devices":[
        {
            "deviceType":"(GCM|FCMv1|APNS)",
            "deviceToken":"string"
        }
    ]
}

응답 Status

디바이스 토큰 삭제

사용자(userId)에 바인딩된 디바이스를 모두 삭제합니다. 사용자도 함께 삭제됩니다.

요청 URL

DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

없음

응답 Status

채널

채널 생성

채널을 생성합니다.

요청 URL

POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

{
    "channelName":"string",
    "channelDesc":"string"
}

응답 Body

없음

응답 Status

채널 수정

채널을 수정합니다.

요청 URL

PUT https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

[
    {
        "channelName":"string",
        "channelDesc":"string"
    }
]

응답 Body

[
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]

응답 Status

채널 조회

채널을 조회합니다.

요청 URL

GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Parameters

Headers

API Header 바로가기

요청 Body

없음

응답 Body

[
    {
        "channelName": "string",
        "channelDesc": "string",
        "createTime": "localDateTime",
        "updateTime": "localDateTime"
    }
]

응답 Status

채널 삭제

채널을 삭제합니다.

요청 URL

DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

[
    {
        "channelName":"string"
    }
]

응답 Body

없음

응답 Status

채널에 사용자 추가

채널에 사용자를 추가합니다.

요청 URL

POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels/{channelName}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

없음

응답 Status

채널에 사용자 삭제

채널에서 사용자를 삭제합니다.

요청 URL

DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/channels/{channelName}/users/{userId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

없음

응답 Status

메시지

메시지 발송

메시지를 발송합니다.

요청 URL

POST https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

{
  "messageType": "(AD | NOTIF)",
  "target": {
    "type": "(ALL | CHANNEL | USER)",
    "deviceType": "(GCM | FCMv1 | APNS)",
    "to": [
      "string",
      "string"
    ],
    "country": [
      "string",
      "string"
    ]
  },
  "message": {
    "default": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "gcm": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "fcmv1": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    },
    "apns": {
      "content": "string",
      "custom": {
        "customKey1": "customValue1",
        "customKey2": "customValue2"
      },
      "option": {},
      "i18n": {
        "default": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        },
        "[language]": {
          "content": "string",
          "custom": {
            "customKey1": "customValue1",
            "customKey2": "customValue2"
          }
        }
      }
    }
  },
  "reserveTime": "yyyy-MM-dd HH:mm",
  "reserveTimeZone": "string",
  "scheduleCode": "string"
}

공통 메시지

• 메시지 발송 requestBody의 message 항목이 공통 메시지를 위한 규격이다.
• message.default.XXX, message.gcm.XXX, message.fcmv1.XXX, message.apns.XXX로 구분할 수 있으며 message.default는 필수로 작성해 주십시오.
• default만 작성 시 모든 Push Type에 동일한 메시지가 발송되며 gcm, fcmv1, apns 작성시 Push Type별로 메시지를 분리할 수 있습니다.
• 적용 우선 순위: gcm = fcmv1 = apns > default
• message에 아래 표대로 메시지를 작성하면 각 Push Type에 맞게 메시지가 생성되어 발송됩니다.

다국어 메시지

• 디바이스에 설정된 language에 따라 다국어 메시지를 처리하기 위한 규격입니다.
• message.default.XXX, message.[language].XXX로 구분할 수 있으며 `language는 ISO-639-1 표준을 따르고 소문자만 사용 가능합니다. 하지만 예외적으로 중국어 간체/번체 지원을 위해 zh-Hant, zh-Hans는 사용할 수 있습니다.
  • ISO-639-1
  • 소문자만 가능
  • zh-Hant, zh-Hans 사용 가능 (대소문자 구분)
• language는 디바이스 등록 시 설정된 언어 코드 기준입니다.
• 적용 우선 순위는 message.content, message.custom 보다 높습니다.

Push Type 별 사용 가능한 option

• GCM(FCM)/FCMv1 메시지 정보 가이드 바로가기
  • collapse_key
  • time_to_live

• APNS 메시지 정보 가이드 바로가기
  • aps.badge
  • aps.sound
  • aps.content-available
  • aps.alert.title
  • aps.alert.action-loc-key
  • ...

응답 Body

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string"
}

응답 Status

메시지 발송 결과 조회

메시지 발송 결과를 조회합니다.

요청 URL

GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/messages/{requestId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "completeTime":"string",
    "targetCount":"integer",
    "sentCount":"integer",
    "messageType":"string",
    "target":{
        ...
    },
    "message":{
        ...
    }
}

응답 Status

예약 메시지

예약 메시지 상태 조회

메시지 발송 예약 상태를 조회합니다.

GET https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

{
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}

응답 Status

예약 메시지 취소

메시지 발송 예약을 취소합니다.

DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

없음

응답 Status

스케줄 메시지

스케줄 메시지 취소

메시지 발송 스케줄을 취소합니다.

DELETE https://sens.apigw.ntruss.com/push/v2/services/{serviceId}/schedules/{scheduleCode}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Headers

API Header 바로가기

요청 Body

없음

응답 Body

없음

응답 Status