API - Discador - Zerar Assinantes de uma Campanha
Para poder utilizar a API do Evolux, é necessário primeiro Gerar um Token.
Para zerar assinantes em uma campanha, é necessário primeiro Criar uma Campanha. Veja como criar uma na Documentação Geral do Discador.
Parâmetros da Chamada de API
ID da Campanha
O ID da campanha pode ser obtido na URL da campanha de destino. Após criar a campanha, acesse sua página de edição ou dashboard para verificar a informação.
Exemplo:http://cliente.evolux.net.br/dialer/campaign/edit/659O ID dessa campanha é 659.
As variáveis serão passadas como parâmetros do POST (payload) e seguir todas as convenções da montagem deste tipo de requisição.
token
Para gerar um token, basta seguir os passos em Tokens de API.
Exemplos de Chamada
Exemplo com POST:
POST /api/v1/campaign/{campaign_id}/subscribers/clear
token=<TOKEN>Exemplo com CURL:
curl --data "token=<TOKEN>" http://cliente.evolux.net.br/api/v1/campaign/1/subscribers/clearRetorno do Exemplo:
{
"meta" : {
"status" : 200,
"message" : "OK"
},
"data" : {
"message" : "6107 subscribers deleted."
}
}Possíveis Falhas
Token fornecido não é válido
{
"meta" : {
"message" : "Invalid token.",
"status" : 403
}
}Token não foi enviado
{
"meta" : {
"message" : "Missing token.",
"status" : 400
}
}
Um método diferente de POST foi enviado
{
"meta" : {
"status" : 405,
"message" : "Method not allowed."
}
}Campanha não foi encontrada
{
"meta" : {
"status" : 404,
"message" : "Invalid Campaign."
}
}Note que caso você omita o ID na URL, o endpoint será um totalmente diferente e um retorno padrão de 404 ("endpoint not found") será retornado.