API - Discador - Excluir Assinantes da Campanha

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:

  https://cliente.evolux.net.br/dialer/campaign/edit/659

  O ID dessa campanha é 659.

As variáveis serão passadas como parâmetros do DELETE (payload) e seguir todas as convenções da montagem deste tipo de requisição.

• campaign_id
  Id da campanha.

• external_id
  Esse campo representa ID ou identificação de sistema externo ao Evolux (por exemplo, CRM do cliente, número do chamado em outra plataforma, etc). Caso já exista um sistema ou banco de dados que atrele o cliente a um número, esse número deverá ser colocado nesse campo.
• token
  Para gerar um token, basta seguir os passos em Tokens de API.

Definição

curl -s -X DELETE "https://$HOST/api/v1/remove_subscriber/$CAMPAIGN_ID/subscriber/$EXTERNAL_ID?token=$TOKEN"

Possíveis retornos

Não encontrado

{
	"meta": {
		"status": 404, "message": "Subscriber not found." }
	}
}

Ocupado

{
	"meta": {
		"status": 422, "message": "Subscriber is busy with status: <status>" }
	}
}

Deletado com sucesso

{ 
	"meta": {
		"status": 200, "message": "The subscriber was successfully removed"
	}
}

Exemplos de Chamada

Exemplo com CURL:

curl -s -X DELETE "https://cliente.evolux.net.br/api/v1/remove_subscriber/659/subscriber/8?token=$TOKEN"

Retorno do Exemplo:

{
    "meta": {
        "status": 200,
        "message": "The subscriber was successfully removed"
    }
}