API de Presets

createPreset

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

Crea un nuevo preset.

Request Body

Nombre	Tipo	Descripción
auth*	string	Token de acceso a la API del Panel de Control de Pushwoosh.
name*	string	Nombre del preset.
applicationCode*	string	Código de aplicación de Pushwoosh
campaignCode	string	Código de una campaña a la que desea asignar este preset.
content*	object	Parámetros del contenido del mensaje.
content.message*	string	Cadena o array. Contenido de los mensajes. En caso de ser una cadena, se utilizará el idioma “Default” (predeterminado).
content.action	object	Parámetros de acción personalizada. Vea el ejemplo a continuación.
content.userData	array	Datos de usuario personalizados. Se pasarán como el parámetro “u” en la carga útil (convertido a cadena JSON).
content.properties	array	Contenido específico para diferentes plataformas. Vea el ejemplo a continuación.
scheduling.sendRate	integer	Limitación (Throttling). Los valores válidos van de 100 a 1000 pushes/segundo.
segmentation	object	Parámetros de segmentación
segmentation.filter	string	Nombre del segmento (filtro)
segmentation.platforms*	array	Array de enteros. La lista de IDs de plataformas. 1 - iOS, 3 - Android, 7 - Mac OS X, 8 - Windows, 9 - Amazon, 10 - Safari, 11 - Chrome, 12 - Firefox.

200

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

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",        // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh.
    "name": "PRESET_NAME",                 // requerido.
    "applicationCode": "XXXXX-XXXXX",      // requerido. Código de aplicación de Pushwoosh.
    "applicationGroupCode": "AAAAA-BBBBB", // opcional. Puede usarse en lugar de "applicationCode".
    "campaignCode": "CCCCC-DDDDD",         // opcional. Código de campaña.
    "content": {                           // requerido. Contiene datos del mensaje.
      "message": {                         // requerido. cadena u objeto. Contenido del mensaje. En caso de ser
        "en": "English message",           //           una cadena, se usará el idioma predeterminado.
        "fr": "French message"             //           Contenido del mensaje localizado para diferentes idiomas.
      },                                   //           Solo códigos de idioma ISO 639-1:2002.
      "title": {                           // opcional. cadena u objeto. Para multilenguaje, establezca el título
        "en": "English title",             //           para cada idioma en el objeto. Se ignora si
        "fr": "French title"               //           se especifican títulos específicos de la plataforma (ej.,
      },                                   //           'ios_title', 'android_header', etc.; vea los
                                           //           ejemplos de parámetros específicos de plataforma en
                                           //           la API /createMessage).
      "subtitle": {                        // opcional. cadena u objeto. Para multilenguaje, establezca el subtítulo
        "en": "English subtitle",          //           para cada idioma en el objeto. Se ignora si
        "fr": "French subtitle"            //           se especifican subtítulos específicos de la plataforma (ej.,
      },                                   //           'ios_subtitle', etc.; vea los ejemplos de parámetros
                                           //           específicos de plataforma en la API /createMessage).
      "action": {                          // opcional. Acción a realizar una vez que un usuario abre un mensaje.
        "type": "url",                     // opcional. Tipo de acción. Tipos disponibles: "url", "deepLink",
                                           //            "richMedia", "openApp"(predeterminado).
        "options": {                       // opcional. Opciones para tipos de acción. Requerido para todos los tipos
                                           //           de acción excepto para "openApp".
          "url": "https://example.com",    // requerido para tipo de acción "url", cadena. Se acortará
                                           //           si se define un acortador.
          "shortener": 2,                  // opcional. Valores disponibles: 0 - no minimizar, 2 - bit.ly.
                                           //           Si no se especifica acortador, se usará bit.ly
                                           //           por defecto.
          "richMediaCode": "BBBBB-AAAAA",  // requerido para tipo de acción "richMedia", cadena.
                                           //           Código Rich Media del Panel de Control de Pushwoosh.
          "id": 123,                       // requerido para tipo de acción "deepLink", entero. ID de Deep Link.
          "params": {                      // opcional, parámetros personalizados, requerido para tipo de acción "deepLink", array.
            "param1": "value1",
            "param2": "value2"
          }
        }
      },
      "userData": {                        // opcional. Datos de usuario personalizados. Se pasarán como
        "CustomData": "value"              //           parámetro "u" en la carga útil (convertido a cadena 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. Opciones de programación.
      "sendRate": 1000         // opcional. Limitación. Valores válidos de 100 a 1000 pushes/segundo.
    },
    "segmentation": {          // requerido. Opciones de segmentación.
      "filter": "FILTER NAME", // opcional. Nombre del filtro de su Panel de Control de Pushwoosh.
      "platforms": [1, 3]      // requerido. La lista de IDs de plataformas: 1 — iOS; 3 — Android;
                               //           7 — Mac OS X; 8 — Windows; 9 — Amazon; 10 — Safari;
                               //           11 — Chrome; 12 — Firefox;
    }
  }
}

Nota

Para parámetros específicos de la plataforma, por favor consulte /createMessage.

getPreset

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

Recupera los parámetros del preset push específico.

Request Body

Nombre	Tipo	Descripción
auth*	string	Token de acceso a la API del Panel de Control de Pushwoosh.
preset_code*	string	Código del preset push del cual recuperar información.

200

{
  "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]
    }
  }
}

Example

{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // requerido. Código del preset push del cual recuperar información
  }
}

listPresets

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

Recupera la lista de presets creados para la aplicación.

Request Body

Nombre	Tipo	Descripción
auth*	string	Token de acceso a la API del Panel de Control de Pushwoosh.
application*	string	Código de aplicación de Pushwoosh

Sin presets

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

Lista de presets

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

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",  // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
    "application": "XXXXX-XXXXX"     // requerido. Código de aplicación de Pushwoosh
  }
}

deletePreset

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

Elimina un preset de su cuenta.

Request Body

Nombre	Tipo	Descripción
auth*	string	Token de acceso a la API del Panel de Control de Pushwoosh.
preset_code*	string	Código del preset recuperado del Panel de Control de Pushwoosh o de la respuesta de la API /listPresets.

200

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

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // requerido. Token de acceso a la API desde el Panel de Control de Pushwoosh
    "preset_code": "AAAAA-BBBBB"    // requerido. Código de un preset para eliminar
  }
}