API de Predefinições

createPreset

POST https://api.pushwoosh.com/json/1.3/createPreset

Cria uma nova predefinição.

Corpo da Requisição

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle da Pushwoosh.
name*	string	Nome da predefinição.
applicationCode*	string	Código da aplicação Pushwoosh.
campaignCode	string	Código de uma campanha à qual você deseja atribuir esta predefinição.
content*	object	Parâmetros de conteúdo da mensagem.
content.message*	string	String ou array. Conteúdo da mensagem. Caso seja uma string, o idioma “Padrão” (Default) será usado.
content.action	object	Parâmetros de ação personalizada. Veja o exemplo abaixo.
content.userData	array	Dados personalizados do usuário. Serão passados como o parâmetro “u” no payload (convertido para string JSON).
content.properties	array	Conteúdo específico para diferentes plataformas. Veja o exemplo abaixo.
scheduling.sendRate	integer	Limitação (Throttling). Valores válidos são de 100 a 1000 pushes/segundo.
segmentation	object	Parâmetros de segmentação.
segmentation.filter	string	Nome do segmento (filtro)
segmentation.platforms*	array	Array de inteiros. A lista de IDs de plataformas. 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox.

{
  "status_code": 200,
  "status_message": "OK"
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh.
    "name": "PRESET_NAME",                 // obrigatório.
    "applicationCode": "XXXXX-XXXXX",      // obrigatório. Código da aplicação Pushwoosh.
    "applicationGroupCode": "AAAAA-BBBBB", // opcional. Pode ser usado em vez de "applicationCode".
    "campaignCode": "CCCCC-DDDDD",         // opcional. Código da campanha.
    "content": {                           // obrigatório. Contém dados da mensagem.
      "message": {                         // obrigatório. string ou objeto. Conteúdo da mensagem. Caso seja
        "en": "English message",           //           uma string, o idioma padrão será usado.
        "fr": "French message"             //           Conteúdo da mensagem localizado para diferentes idiomas.
      },                                   //           Apenas códigos de idioma ISO 639-1:2002.
      "title": {                           // opcional. string ou objeto. Para multilíngue, defina o título
        "en": "English title",             //           para cada idioma no objeto. Ignorado se
        "fr": "French title"               //           títulos específicos da plataforma forem especificados (ex.,
      },                                   //           'ios_title', 'android_header', etc.; veja os
                                           //           exemplos de parâmetros específicos da plataforma na
                                           //           API /createMessage).
      "subtitle": {                        // opcional. string ou objeto. Para multilíngue, defina o subtítulo
        "en": "English subtitle",          //           para cada idioma no objeto. Ignorado se
        "fr": "French subtitle"            //           subtítulos específicos da plataforma forem especificados (ex.,
      },                                   //           'ios_subtitle', etc.; veja os exemplos de parâmetros
                                           //           específicos da plataforma na API /createMessage).
      "action": {                          // opcional. Ação a ser realizada quando um usuário abre uma mensagem.
        "type": "url",                     // opcional. Tipo de ação. Tipos disponíveis: "url", "deepLink",
                                           //            "richMedia", "openApp"(padrão).
        "options": {                       // opcional. Opções para tipos de ação. Obrigatório para todos os tipos
                                           //           de ação, exceto para "openApp".
          "url": "https://example.com",    // obrigatório para o tipo de ação "url", string. Será encurtado
                                           //           se um encurtador for definido.
          "shortener": 2,                  // opcional. Valores disponíveis: 0 - não minimizar, 2 - bit.ly.
                                           //           Se nenhum encurtador for especificado, o encurtador bit.ly será
                                           //           usado por padrão.
          "richMediaCode": "BBBBB-AAAAA",  // obrigatório para o tipo de ação "richMedia", string.
                                           //           Código Rich Media do Painel de Controle da Pushwoosh.
          "id": 123,                       // obrigatório para o tipo de ação "deepLink", inteiro. ID do Deep Link.
          "params": {                      // opcional, parâmetros personalizados, obrigatório para o tipo de ação "deepLink", array.
            "param1": "value1",
            "param2": "value2"
          }
        }
      },
      "userData": {                        // opcional. Dados personalizados do usuário. Serão passados como parâmetro "u"
        "CustomData": "value"              //           no payload (convertido para string JSON).
      },
      "platforms": {
        "ios": {
          "sound": "default",
          "silent": 1,
          "ttl": 604800,
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          },
          "interruptionLevel": "active"
        },
        "android": {
          "rootParams": {
            "rule_id": "12345",
            "screen_id": "34567"
          }
        }
      }
    },
    "scheduling": {            // opcional. Opções de agendamento.
      "sendRate": 1000         // opcional. Limitação. Valores válidos são de 100 a 1000 pushes/segundo.
    },
    "segmentation": {          // obrigatório. Opções de segmentação.
      "filter": "FILTER NAME", // opcional. Nome do filtro do seu Painel de Controle da Pushwoosh.
      "platforms": [1, 3]      // obrigatório. A lista de IDs de plataformas: 1 — iOS; 3 — Android;
                               //           7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //           11 — Chrome; 12 — Firefox;
    }
  }
}

getPreset

POST https://api.pushwoosh.com/json/1.3/getPreset

Recupera os parâmetros de uma predefinição de push específica.

Corpo da Requisição

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle da Pushwoosh.
preset_code*	string	Código da predefinição de push para recuperar informações.

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "preset": {
      "code": "XXXXX-XXXXX",
      "name": "Full preset",
      "page_id": 26,
      "url": null,
      "content": {
        "en": "Some message",
        "de": "Eine Nachricht"
      },
      "properties": {
        "ignore_user_timezone": 1,
        "ios_badges": "5",
        "ios_sound": "default",
        "ios_ttl": "43200",
        "android_sound": "Sound1.wav",
        "android_custom_icon": "icon.png",
        "android_header": "android_header",
        "android_gcm_ttl": "43200",
        "wns_type": "toast",
        "wns_content": {
          "template": "ToastImageAndText02",
          "lang-en": {
            "headlinetext": "Title",
            "bodytext": "super text"
          },
          "languages": ["en", "zh", "it", "sv", "de", "fr", "pt", "nl", "es"],
          "lang-zh": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-it": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-sv": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-de": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-fr": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-pt": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-nl": {
            "headlinetext": "",
            "bodytext": ""
          },
          "lang-es": {
            "headlinetext": "",
            "bodytext": ""
          },
          "imagesource": "https:\/\/image.com\/jpg"
        },
        "adm_sound": "song",
        "adm_custom_icon": "i5.bmp",
        "adm_header": "Amazon Header",
        "adm_ttl": "7200",
        "safari_title": "Safari title",
        "safari_action": "OK",
        "safari_url_args": ["hello.com", ""],
        "safari_ttl": "43200",
        "userdata": "{\"custom\":\"data\"}",
        "created_via": "CP",
        "user_id": 2,
        "filter_id": "1"
      },
      "platforms": [1, 3, 7, 10, 11]
    }
  }
}

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // obrigatório. Código da predefinição de push para recuperar informações
  }
}

listPresets

POST https://api.pushwoosh.com/json/1.3/listPresets

Recupera a lista de predefinições criadas para a aplicação.

Corpo da Requisição

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle da Pushwoosh.
application*	string	Código da aplicação Pushwoosh.

Sem predefinições
Lista de predefinições

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": []
  }
}

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "presets": [{
      "name": "test",
      "code": "AAAAA-BBBBB"
    }]
  }
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "application": "XXXXX-XXXXX"     // obrigatório. Código da aplicação Pushwoosh
  }
}

deletePreset

POST https://api.pushwoosh.com/json/1.3/deletePreset

Exclui uma predefinição da sua conta.

Corpo da Requisição

Nome	Tipo	Descrição
auth*	string	Token de acesso à API do Painel de Controle da Pushwoosh.
preset_code*	string	Código da predefinição recuperado do Painel de Controle da Pushwoosh ou da resposta da API `/listPresets`.

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle da Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // obrigatório. Código de uma predefinição para excluir
  }
}