Pular para o conteúdo

API de Campanhas

createCampaign

Anchor link to

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

Cria uma campanha de push dentro do aplicativo.

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle Pushwoosh.
application*stringCódigo da aplicação Pushwoosh
name*stringNome da campanha.
descriptionstringDescrição da campanha.
{
"status_code": 200,
"status_message": "OK",
"response": {
"campaign": "XXXXX-XXXXX"
}
}
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
"application": "XXXXX-XXXXX", // obrigatório. Código da aplicação Pushwoosh
"name": "CAMPAIGN_NAME", // obrigatório.
"description": "CAMPAIGN_DESCRIPTION" // opcional.
}
}

deleteCampaign

Anchor link to

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

Exclui uma campanha específica.

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle Pushwoosh.
campaign*stringCódigo de uma campanha para excluir.
{
"status_code": 200,
"status_message": "OK",
"response": null
}
Exemplo
{
"request": {
"auth": "yxoPUlwqm…………pIyEX4H", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
"campaign": "XXXXX-XXXXX" // obrigatório. ID de uma campanha para excluir
}
}

getCampaigns

Anchor link to

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

Recupera a lista de campanhas para o aplicativo.

Corpo da Requisição

Anchor link to
NomeTipoDescrição
auth*stringToken de acesso à API do Painel de Controle Pushwoosh.
application*stringCódigo da aplicação Pushwoosh
cursorstringIndica a última campanha recuperada na requisição anterior.
limitintegerO número máximo de campanhas para uma única resposta.
{
"status_code": 200,
"status_message": "OK",
"response": {
"campaigns": [{
"code": "7CFF3-63A7B",
"name": "CAMPAIGN_NAME_1",
"description": "DESCRIPTION1"
}, {
"code": "C284C-33DD3",
"name": "CAMPAIGN_NAME_2",
"description": "DESCRIPTION2"
}],
"limit": 100,
"cursor": "+4PxJPhhwITD4PFsiKui1BA=="
}
}
Exemplo
{
"request": {
"auth": "jLbec2UW........ztFSOf5Za", // obrigatório. Token de acesso à API do Painel de Controle Pushwoosh
"application": "XXXXX-XXXXX", // obrigatório. Código da aplicação Pushwoosh
"cursor": "+4PxJPhhwITD4PFsiKui1BA==", // opcional. Indica a última campanha recuperada na requisição anterior.
"limit": 100 // opcional. O número máximo de campanhas
// para uma única resposta.
}
}