/createMessage 파라미터

여기에서는 /createMessage API 파라미터에 대한 설명을 확인할 수 있습니다.

• 필수 파라미터는 지정된 시간에 /createMessage API 요청을 성공적으로 보내고 푸시 알림을 브로드캐스트하기 위해 포함되어야 합니다.

• 선택적 파라미터를 사용하면 푸시 알림 속성을 사용자 지정할 수 있습니다.

참고

SMS를 보내기 위해 _/createMessage_를 사용하는 경우, SMS 전송 파라미터를 참조하십시오. 다른 파라미터는 전달되지 않습니다.

필수 파라미터

필수 파라미터는 /createMessage 요청에서 반드시 사용해야 합니다. 그렇지 않으면 요청이 제출되지 않습니다.

application

Pushwoosh 계정에서 생성된 앱의 고유 코드입니다. 앱 코드는 Control Panel의 왼쪽 상단 모서리나 /createApplication 요청에 대한 응답에서 찾을 수 있습니다. 앱 코드는 하이픈으로 구분된 10개의 문자(문자와 숫자 모두) 집합입니다.

API를 통해 앱을 생성할 때, /createApplication 요청에 대한 응답으로 앱 코드를 받게 됩니다.

API를 통해 이전에 생성된 앱의 코드를 얻으려면 /getApplications를 호출하십시오. /getApplications 요청에 대한 응답으로, Pushwoosh 계정에서 생성된 모든 앱의 목록과 그 이름 및 코드를 받게 됩니다.

auth

Pushwoosh Control Panel의 API 액세스 토큰입니다. Settings → API Access로 이동하여 사용하려는 토큰을 복사하거나 새 토큰을 생성하십시오.

액세스 토큰을 생성할 때 권한을 지정하십시오. API 토큰을 사용할 활동 유형에 대한 체크박스를 선택하십시오. Applications 체크박스를 선택하여 앱별 API 토큰을 생성할 수 있습니다.

content

메시지 내용을 정의하는 문자열 또는 객체입니다. 문자열 유형 값으로 제출된 “content” 파라미터는 모든 수신자에게 동일한 메시지를 보냅니다.

문자열

"content": "Hello world!",

JSON 객체는 다국어 메시지와 같이 동적 콘텐츠를 사용하여 콘텐츠를 지정하는 데 사용됩니다.

객체

"content": {
  "en": "Hello!",
  "es": "¡Hola!",
  "de": "Hallo!"
},

notifications

푸시 속성의 JSON 배열입니다. 최소한 필수 content 및 send_date 파라미터를 포함해야 합니다.

“notifications” 배열 내에서 사용할 수 있는 선택적 파라미터:

• campaign
• capping_days
• capping_count
• conditions
• data
• devices
• dynamic_content
• filter
• ignore_user_timezone
• inbox_date
• inbox_image
• link
• minimize_link
• platforms
• preset
• rich_media
• send_rate
• timezone
• template_bindings
• transactionId
• users

send_date

메시지가 전송되는 날짜 및 시간입니다. YYYY-MM-DD HH:mm 형식의 모든 날짜 및 시간이거나 ‘now’일 수 있습니다. ‘now’로 설정하면 요청을 제출한 직후 메시지가 전송됩니다.

선택적 파라미터

campaign

캠페인 코드입니다. 캠페인 코드를 얻으려면 Statistics → Aggregated statistics로 이동하여 사용하려는 캠페인을 선택하십시오. 캠페인 코드는 페이지 URL 끝에 XXXXX-XXXXX 형식으로 표시됩니다.

예시:

URL: https://app.pushwoosh.com/applications/AAAAA-AAAAA/statistics/aggregated-message?campaignCode=XXXXX-XXXXX

캠페인 코드: XXXXX-XXXXX

캠페인 목록과 코드를 얻으려면 /getCampaigns를 호출하십시오. /getCampaigns 요청에 대한 응답으로, Pushwoosh 계정의 특정 앱에 대해 생성된 모든 캠페인 목록과 그 코드, 이름, 설명을 받게 됩니다.

capping_days

빈도 제한에 적용될 기간(일 단위, 최대 30일)입니다. 자세한 내용은 빈도 제한을 참조하십시오.

capping_count

“capping_days” 기간 내에 특정 앱에서 특정 기기로 보낼 수 있는 최대 푸시 수입니다. 생성된 메시지가 기기의 “capping_count” 한도를 초과하는 경우 해당 기기로 전송되지 않습니다. 자세한 내용은 빈도 제한을 참조하십시오.

conditions

조건은 [tagName, operator, operand]와 같은 배열로, 태그 및 그 값을 기반으로 타겟 메시지를 보내는 데 사용됩니다. 여기서:

• tagName — 적용할 태그의 이름,
• operator — 값 비교 연산자 (“EQ” | “IN” | “NOTEQ” | “NOTIN” | “LTE” | “GTE” | “BETWEEN” | “NOTSET” | “ANY”),
• operand — 다음 유형 중 하나의 태그 값: string | integer | array | date | boolean | list

연산자 설명

EQ	태그 값이 피연산자와 같습니다.
IN	태그 값이 피연산자와 교차합니다 (피연산자는 항상 배열이어야 합니다).
NOTEQ	태그 값이 피연산자와 같지 않습니다.
NOTIN	태그 값이 피연산자와 교차하지 않습니다 (피연산자는 항상 배열이어야 합니다).
GTE	태그 값이 피연산자보다 크거나 같습니다.
LTE	태그 값이 피연산자보다 작거나 같습니다.
BETWEEN	태그 값이 최소 피연산자 값보다 크거나 같고 최대 피연산자 값보다 작거나 같습니다 (피연산자는 항상 배열이어야 합니다).
NOTSET	태그가 설정되지 않았습니다. 피연산자는 고려되지 않습니다.
ANY	태그에 어떤 값이든 있습니다. 피연산자는 고려되지 않습니다.

문자열 태그

유효한 연산자: EQ, IN, NOTEQ, NOTIN, NOTSET, ANY

유효한 피연산자:

EQ, NOTEQ	피연산자는 문자열이어야 합니다
IN, NOTIN	피연산자는 ["value 1", "value 2", "value N"]과 같은 문자열 배열이어야 합니다
NOTSET	태그가 설정되지 않았습니다. 피연산자는 고려되지 않습니다
ANY	태그에 어떤 값이든 있습니다. 피연산자는 고려되지 않습니다

정수 태그

유효한 연산자: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

유효한 피연산자:

EQ, NOTEQ, GTE, LTE	피연산자는 정수여야 합니다
IN, NOTIN	피연산자는 [value 1, value 2, value N]과 같은 정수 배열이어야 합니다
BETWEEN	피연산자는 [min_value, max_value]와 같은 정수 배열이어야 합니다
NOTSET	태그가 설정되지 않았습니다. 피연산자는 고려되지 않습니다
ANY	태그에 어떤 값이든 있습니다. 피연산자는 고려되지 않습니다

날짜 태그

유효한 연산자: EQ, IN, NOTEQ, NOTIN, BETWEEN, GTE, LTE, NOTSET, ANY

유효한 피연산자:

• "YYYY-MM-DD 00:00" (문자열)
• 유닉스 타임스탬프 1234567890 (정수)
• EQ, BETWEEN, GTE, LTE 연산자의 경우 "N days ago" (문자열)

불리언 태그

유효한 연산자: EQ, NOTSET, ANY

유효한 피연산자: 0, 1, true, false

리스트 태그

유효한 연산자: IN, NOTIN, NOTSET, ANY

유효한 피연산자: 피연산자는 ["value 1", "value 2", "value N"]과 같은 문자열 배열이어야 합니다.

중요

“filter”와 “conditions” 파라미터는 함께 사용해서는 안 됩니다.
또한, “devices” 파라미터가 동일한 요청에 사용되면 두 파라미터 모두 무시됩니다.

국가 및 언어 태그

언어 태그 값은 ISO-639-1에 따른 소문자 두 글자 코드입니다. 국가 태그 값은 ISO_3166-2에 따른 대문자 두 글자 코드입니다.

예를 들어, 브라질의 포르투갈어 사용자에게 푸시 알림을 보내려면 다음 조건을 지정해야 합니다: "conditions": [["Country", "EQ", "BR"],["Language", "EQ", "pt"]]

conditions_operator

조건 배열에 대한 논리 연산자입니다. 가능한 값: AND | OR. 기본값은 AND입니다.

적용된 연산자가 AND인 경우(연산자가 지정되지 않았거나 ‘conditions_operator’ 파라미터 값이 ‘AND’인 경우), 모든 조건을 동시에 만족하는 기기가 푸시 알림을 받게 됩니다.

연산자가 OR인 경우, 지정된 조건 중 하나라도 만족하는 기기가 메시지를 받게 됩니다.

data

푸시 페이로드에 사용자 지정 데이터를 전달하는 데 사용되는 JSON 문자열 또는 JSON 객체입니다. 페이로드에서 “u” 파라미터로 전달됩니다(JSON 문자열로 변환됨).

devices

타겟 푸시 알림을 보낼 푸시 토큰 또는 hwid의 배열입니다. 설정된 경우, 목록에 있는 기기에만 메시지가 전송됩니다.

dynamic_content

기기 태그 값 대신 사용할 동적 콘텐츠의 플레이스홀더입니다. 아래 예시는 타겟팅하는 모든 사용자에게 “Hello, John!” 메시지를 보냅니다. 설정되지 않은 경우, 동적 콘텐츠 값은 기기 태그에서 가져옵니다.

"content": "Hello, {firstname|CapitalizeFirst}!",
"dynamic_content_placeholders": {
  "firstname": "John",
  "lastname": "Doe"
},

filter

Pushwoosh Control Panel에서 또는 /createFilter API 요청을 통해 생성된 세그먼트의 이름과 정확히 일치해야 합니다. Audience → Segments 섹션으로 이동하여 생성된 세그먼트 목록을 확인하십시오.

API를 통해 세그먼트 목록을 얻으려면 /listFilters API 메서드를 호출하십시오. /listFilters 요청에 대한 응답으로, Pushwoosh 계정에서 생성된 모든 세그먼트 목록과 세그먼트의 이름, 조건, 만료 날짜를 받게 됩니다.

ignore_user_timezone

‘true’로 설정하면 UTC-0에 따라 “send_date” 파라미터에 지정된 시간과 날짜에 메시지를 보냅니다.

‘false’로 설정하면 사용자는 기기 설정에 따라 지정된 현지 시간에 메시지를 받게 됩니다.

inbox_date

메시지가 사용자의 받은 편지함에 보관되어야 하는 날짜입니다. 지정되지 않은 경우, 메시지는 전송일 다음 날 받은 편지함에서 제거됩니다.

참고

메시지를 받은 편지함에 저장하려면 ‘inbox’ 파라미터 중 하나 이상을 사용하십시오: “inbox_date” 또는 “inbox_image”.

주의

메시지는 지정된 날짜의 00:00:01에 받은 편지함에서 제거되므로, 이전 날짜가 사용자가 받은 편지함에서 메시지를 볼 수 있는 마지막 날입니다.

inbox_image

받은 편지함에서 메시지 옆에 표시될 사용자 지정 이미지의 URL입니다.

참고

메시지를 받은 편지함에 저장하려면 ‘inbox’ 파라미터 중 하나 이상을 사용하십시오: “inbox_date” 또는 “inbox_image”.

inbox_days

받은 편지함 메시지의 수명(일 단위, 최대 30일)입니다. 이 기간이 지나면 메시지는 받은 편지함에서 제거됩니다. inbox_date 파라미터 대신 사용할 수 있습니다.

link

사용자가 푸시 알림을 열었을 때 열릴 URL입니다.

minimize_link

“link” 파라미터에 제출된 URL을 최소화하는 단축기입니다. 푸시 알림 페이로드 크기는 제한되어 있으므로 한도를 초과하지 않도록 짧은 URL을 만드는 것을 고려하십시오. 사용 가능한 값: 0 — 최소화 안 함, 2 — bitly. 기본값 = 2. Google URL 단축기는 2019년 3월 30일부터 비활성화되었습니다.

platforms

특정 플랫폼에만 메시지를 보내기 위한 플랫폼 코드 배열입니다.

사용 가능한 플랫폼 코드: 1 — iOS, 3 — Android, 7 — Mac OS X, 8 — Windows, 9 — Amazon, 10 — Safari, 11 — Chrome, 12 — Firefox, 14 — Email, 17 — Huawei, 18 — SMS, 21 — WhatsApp.

preset

Pushwoosh Control Panel 또는 API를 통해 생성된 프리셋의 코드입니다. 프리셋 코드를 얻으려면 Content → Presets로 이동하여 사용하려는 프리셋을 확장하고 프리셋 세부 정보에서 Preset Code를 복사하십시오.

rich_media

메시지에 첨부할 리치 미디어 페이지의 코드입니다. 코드를 얻으려면 Content → Rich Media로 이동하여 사용하려는 리치 미디어 페이지를 열고 브라우저의 URL 표시줄에서 코드를 복사하십시오. 코드는 하이픈으로 구분된 10개의 문자(문자와 숫자 모두) 집합입니다.

send_rate

푸시 전송 속도를 제한하는 스로틀링입니다. 유효한 값은 100에서 1000 푸시/초입니다.

timezone

특정 날짜와 시간에 메시지를 보낼 때 고려할 시간대입니다. 설정된 경우 기기의 시간대는 무시됩니다. 무시된 경우 메시지는 UTC로 전송됩니다. 지원되는 시간대는 https://php.net/manual/timezones.php를 참조하십시오.

template_bindings

콘텐츠 템플릿에서 사용할 템플릿 플레이스홀더입니다. 자세한 내용은 Liquid 템플릿 가이드를 참조하십시오.

transactionId

네트워크 문제 발생 시 메시지 중복을 방지하기 위한 고유 메시지 식별자입니다. /createMessage 또는 /createTargetedMessage 요청을 통해 생성된 메시지에 ID를 할당할 수 있습니다. Pushwoosh 측에서 5분 동안 저장됩니다.

users

userIds의 배열입니다. User ID는 /registerUser, /registerDevice, 또는 /registerEmail API 요청에 의해 설정된 고유 사용자 식별자입니다.