Audience API

bulkSetTags

POST https://api.pushwoosh.com/api/v2/audience/bulkSetTags

디바이스 목록에 대한 태그 값을 설정합니다.

Request Body

Name	Type	Description
application*	String	Pushwoosh Application Code
auth*	String	Pushwoosh Control Panel의 API Access Token.
create_missing_tags	Boolean	true인 경우, 누락된 태그가 자동으로 생성됩니다.
devices*	Object	디바이스 배열입니다.
devices.hwid	String	user_id 또는 push_token 대신 디바이스를 식별하는 데 사용할 수 있습니다. 자세히 보기
devices.user_id	String	hwid 또는 push_token 대신 사용자를 식별하는 데 사용할 수 있습니다. 자세히 보기
devices.push_token	String	hwid 또는 user_id 대신 디바이스를 식별하는 데 사용할 수 있습니다. 자세히 보기
devices.list_operator	String	목록(list) 유형의 태그 값을 설정하는 방법을 정의합니다: set, append, 또는 remove
devices.tags*	Object	지정된 태그에 설정할 값입니다.

OK
Error

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

{
  "message": "invalid request"
}

{
  "application": "application code",   // 필수. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // 필수. Pushwoosh Control Panel의 API Access Token
  "create_missing_tags": false,        // 선택 사항. 누락된 태그를 자동으로 생성할지 여부
  "devices": [{                        // 필수. 디바이스 배열
    "hwid": "device hwid",             // 선택 사항. "user_id" 또는 "push_token" 대신 디바이스를
                                       //           식별하는 데 사용할 수 있습니다.
    "user_id": "user ID",              // 선택 사항. "hwid" 또는 "push_token" 대신 사용자를 식별하는 데 사용할 수 있습니다.
    "push_token": "device push token", // 선택 사항. "hwid" 또는 "user_id" 대신 디바이스를 식별하는 데 사용할 수 있습니다.
    "list_operator": "set",            // 필수. 목록(list) 태그용. 목록 유형의 태그 값을 설정하는 방법을
                                       //           정의합니다: set, append, 또는 remove
    "tags": {                          // 필수. 지정된 태그에 설정할 값입니다.
      "tag_name": "tagvalue",          //           올바른 값 유형을 사용하십시오
      "tag_name2": "tagvalue2"
    }
  }]
}

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkSetTags status

GET https://api.pushwoosh.com/api/v2/audience/bulkSetTags/{request_id}?detailed=false

/bulkSetTags 작업의 상태를 반환합니다.

Path Parameters

Name	Type	Description
request_id	String	이전 `/bulkSetTags` 호출의 request id

Query Parameters

Name	Type	Description
detailed	Boolean	(true/false) 디바이스별 상세 정보를 반환할지 여부

{
  "request_id": "id of the request",
  "status": "Completed",          // "Pending", "Failed"일 수도 있음
  "progress": 100,                // 작업 진행률 0-100
  "devices_success": 100,         // 성공한 디바이스
  "devices_not_found": 0,         // Pushwoosh에서 찾을 수 없는 디바이스
  "devices_failed": 0,            // 오류 발생
  "devices": [{                   // 디바이스 보고서 (detailed = true인 경우에만)
    "hwid": "device hwid",
    "status": "done",             // "failed", "not found"일 수도 있음
    "tags": {
      "tagName": "ok",
      "tagName2": "tag not found",
      "tagName3": "wrong value. expect :string"
    }
  }]
}

bulkRegisterDevice

한 번의 요청으로 여러 디바이스를 Pushwoosh에 등록합니다. 또한 각 디바이스에 대해 다양한 태그를 지정할 수 있습니다.

POST https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice

Request body parameters

Parameter	Type	Required	Description
application	string	Yes	Pushwoosh Application Code
auth	string	Yes	API Access Token.
devices	array	Yes	디바이스 객체의 배열입니다. 각 객체는 디바이스와 관련 데이터를 나타냅니다. 자세한 내용은 아래의 Device object parameters 표를 참조하십시오.

Device object parameters

Parameter	Type	Required	Description
hwid	string	Yes	디바이스의 Hardware ID 또는 고유 식별자입니다.
push_token	string	Yes	디바이스의 Push Token입니다.
platform	integer	Yes	플랫폼 식별자입니다. 자세히 보기
list_operator	string	No	목록(list) 유형 태그에 대한 작업을 결정합니다: - “append”: 태그 목록에 지정된 값을 추가합니다. - “remove”: 태그 목록에서 지정된 값을 제거합니다. 참고: `list_operator` 매개변수가 지정되지 않은 경우, 태그 목록의 모든 기존 값이 제공된 값으로 대체됩니다.
tags	object	No	디바이스에 할당된 사용자 지정 태그입니다. 태그는 세분화(segmentation)에 사용되는 키-값 쌍입니다.

Request example

{
  "application": "application code",   // 필수. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // 필수. Pushwoosh Control Panel의 API Access Token
  "devices": [{                        // 필수. 디바이스 배열
    "hwid": "device hwid",             // 필수. 디바이스의 고유 식별자 (이메일일 수 있음).
    "push_token": "device push token", // 필수. 디바이스의 Push Notification 토큰.
    "platform": 14,                    // 필수. 디바이스 플랫폼 (예: 이메일의 경우 14).
    "list_operator": "append",         // 선택 사항. 목록(list) 태그용. 목록 유형의 태그에서 지정된 값을 추가하거나 제거합니다.
    "tags": {                          // 선택 사항. 지정된 태그에 설정할 값입니다.
      "language": "en",                //           올바른 값 유형을 사용하십시오.
      "CSV_Import": "summer_camp"
    }
  },
  {
    "hwid": "device hwid 2",           // 필수. 두 번째 디바이스의 고유 식별자.
    "push_token": "device push token 2", // 필수. 디바이스의 Push Notification 토큰.
    "platform": 14,                    // 필수. 디바이스 플랫폼.
    "list_operator": "remove",         // 선택 사항. 목록 유형의 태그에서 값을 추가하거나 제거합니다.
    "tags": {                          // 선택 사항. 지정된 태그에서 제거할 값입니다.
      "language": "en",
      "CSV_Import": "summer_camp2"
    }
  },
  {
    "hwid": "device hwid 3",           // 필수. 세 번째 디바이스의 고유 식별자.
    "push_token": "device push token 3", // 필수. 디바이스의 Push Notification 토큰.
    "platform": 14,                    // 필수. 디바이스 플랫폼.
    "tags": {                          // 선택 사항. 지정된 태그에 설정할 값입니다.
      "language": "en",
      "CSV_Import": "summer_camp3"
    }
  }]
}

Response

이 메서드는 작업 ID(Operation ID)로 응답하며, 이를 사용하여 대량 등록 프로세스의 상태와 결과를 추적할 수 있습니다.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkRegisterDevice status

다음 GET 요청을 수행하여 대량 등록 프로세스의 상태를 확인할 수 있습니다:

GET https://api.pushwoosh.com/api/v2/audience/bulkRegisterDevice/{request_id}?detailed=true

Parameter	Type	Required	Description
request_id	string	Yes	POST 요청에서 반환된 Request ID입니다.
detailed	boolean	No	`true`로 설정하면 응답에 각 등록된 디바이스에 대한 상세 결과가 포함됩니다.

Example response

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}

bulkUnregisterDevice

한 번의 요청으로 Pushwoosh에서 여러 디바이스 등록을 해제합니다.

POST https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice

Request body parameters

Parameter	Type	Required	Description
application	string	Yes	Pushwoosh Application Code
auth	string	Yes	API Access Token
devices	array	Yes	디바이스 객체의 배열입니다. 각 객체는 디바이스와 관련 데이터를 나타냅니다. 자세한 내용은 아래의 Device object parameters 표를 참조하십시오.

Device object parameters

Parameter	Type	Required	Description
hwid	string	Yes	디바이스의 Hardware ID 또는 고유 식별자입니다. 자세히 보기

Request example

{
  "application": "application code",   // 필수. Pushwoosh App Code
  "auth": "Pushwoosh auth token",      // 필수. Pushwoosh Control Panel의 API Access Token
  "devices": [{                        // 필수. 디바이스 배열
    "hwid": "device hwid",             // 필수. 디바이스의 고유 식별자 (이메일일 수 있음).
  },
  {
    "hwid": "device hwid 2",           // 필수. 두 번째 디바이스의 고유 식별자.
  },
  {
    "hwid": "device hwid 3",           // 필수. 세 번째 디바이스의 고유 식별자.
  }]
}

Response

이 메서드는 작업 ID(Operation ID)로 응답하며, 이를 사용하여 대량 처리 프로세스의 상태와 결과를 추적할 수 있습니다.

{
  "request_id": "request_id to use in GET method to obtain job status",
  "status": "Pending"
}

bulkUnregisterDevice status

다음 GET 요청을 수행하여 대량 등록 해제 프로세스의 상태를 확인할 수 있습니다:

GET https://api.pushwoosh.com/api/v2/audience/bulkUnregisterDevice/{request_id}?detailed=true

Parameter	Type	Required	Description
request_id	string	Yes	POST 요청에서 반환된 Request ID입니다.
detailed	boolean	No	`true`로 설정하면 응답에 각 등록 해제된 디바이스에 대한 상세 결과가 포함됩니다.

Example response

{
  "request_id": "9a2e1a14-XXXX-46c3-XXXX-c254b25d3782",
  "status": "Completed",
  "progress": 100,
  "devices_success": 4,
  "devices": [
    {
      "hwid": "user1@example.com",
      "status": "done"
    },
    {
      "hwid": "user2@example.com",
      "status": "done"
    },
    {
      "hwid": "user3@example.com",
      "status": "done"
    },
    {
      "hwid": "invalid_email@example.com",
      "status": "failed"
    }
  ]
}