API - Discador - Buscando Assinantes de Campanha

Para poder utilizar a API do Evolux, é necessário primeiro Gerar um Token.

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 de query e seguem todas as convenções da montagem deste tipo de requisição. Os parâmetros de query são todos opcionais, a exceção do token. Caso nenhum parâmetro de busca seja fornecido, todos os assinantes do banco de dados são retornados. Caso o ID seja inválido, é retornado erro HTTP 200 com lista vazia no payload de resposta.

name
O nome do assinante, podendo conter espaço em caso de nome e sobrenome. Este campo procura por qualquer parte do nome e é case-insensitive (ignora maiúsculas/minúsculas). Exemplo: se name="Luis", os assinantes de nome "Antonio Luis", "Luis Antonio", "Sergio Augusto Luis" serão retornados.
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. Este campo bate exatamente o external_id cadastrado e é case-sensitive (não ignora maiúsculas/minúsculas).
number
Um número pertencente ao cliente. Este campo procura por qualquer parte do número.
token
Para gerar um token, basta seguir os passos em Tokens de API.

Exemplos de Chamada

Exemplo com CURL:

curl -s -X GET "https://cliente.evolux.net.br/api/v1/subscriber/search?token=<TOKEN>&number=1234567890"

Retorno do Exemplo:

{
   "meta" : {
      "message" : "OK",
      "status" : 200
   },
   "data" : {
      "total" : 1,
      "results" : [
         {
            "name" : "Nome do Assinante",
            "numbers" : [
               {
                  "id" : 1,
                  "number" : "1234567890"
               }
            ],
            "custom_fields" : {},
            "status" : "Completed",
            "external_id" : null,
            "id" : 5
         }
      ]
   }
}