API - Discador - Cadastrando Assinantes de 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 POST (payload) e seguir todas as convenções da montagem deste tipo de requisição.

• name
  O nome do assinante, podendo conter espaço em caso de nome e sobrenome.
• 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.
• number
  O número de telefone do assinante, para o qual o discador fará a chamada. É possível adicionar quantos números forem necessários, para cada número, utilize uma nova variável number.
• custom_
  O discador permite a adição de quantos campos custom forem necessários. Por exemplo, se for de interesse para o operador saber a cidade do assinante, basta adicionar à chamada o campo custom_cidade.
• token
  Para gerar um token, basta seguir os passos em Tokens de API.

Exemplos de Chamada

Exemplo com POST:

POST /api/v1/campaign/{id}/subscriber
name=Fulano de Tal&external_id=06961000000&number=1141186256&number=1140033833&custom_cidade=Natal&token=<TOKEN>

Exemplo com CURL:

curl --data "name=Fulano de Tal&external_id=06961000000&number=1141186256&number=1140033833&custom_cidade=Natal&token=<TOKEN>" https://cliente.evolux.net.br/api/v1/campaign/1/subscriber

Retorno do Exemplo:

{
	"meta": {"status": 200, "message": "OK"}, 
	"data": {
		"numbers": [{"id": 7, "number": "1141186256"}, {"id": 8, "number": "1140033833"}], 
		"external_id": "06961000000", 
		"id": {ID}, 
		"custom_fields": {"cidade": "Natal"}, 
		"name": "Fulano de Tal"
	}
}