API - Discador - Cadastrando Assinantes de Campanha (Callwe)

Owned by Hamilton Reis (Unlicensed)
Oct 14, 2021
2 min read



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

 

Para cadastrar assinantes em uma campanha, é necessário primeiro Criar uma Campanha. Veja como criar uma na /wiki/spaces/DOC/pages/2588675.


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://evolux.evolux.io/api/v1/campaign/7/subscriber

    O ID dessa campanha é 7.

A autenticação vai no cabeçalho, na chave:

  • token
    (Para gerar um token, basta seguir os passos em Tokens de API.)

As variáveis serão passadas no formulário do POST 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.

Exemplos de Chamada

Exemplo em Python (usando a lib "requests"):

import requests url = "https://evolux.evolux.io/api/v1/campaign/7/subscriber" payload={'name': 'Fulano de tal', 'number': '84999999999', 'external_id': '99999', 'custom_cidade': 'Natal-RN', 'custom_cliente': 'VIP'} files=[ ] headers = { 'token': 'XXXXXXX-XXXX-XXXXX-XXXX-XXXXXXXXX', 'Cookie': 'evolux=459015c6ba4f7bcd0431ba13cc0e6bcff812a65fc9b22bb585ed4ad7b748bab7fd8c2f89' } response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text)

 

Exemplo com CURL:

curl --location --request POST 'https://evolux.evolux.io/api/v1/campaign/7/subscriber' \ --header 'token: xxxxxxxxx-xxxxx-xxxx-xxxx-xxxxxxxxxxx' \ --header 'Cookie: evolux=459015c6ba4f7bcd0431ba13cc0e6bcff812a65fc9b22bb585ed4ad7b748bab7fd8c2f89' \ --form 'name="Fulano de Tal"' \ --form 'number="84999999999"' \ --form 'external_id="99999"' \ --form 'custom_cidade="Natal-RN"' \ --form 'custom_cliente="VIP"' 

Retorno do Exemplo: