Cadastrar múltiplos assinantes em uma campanha através de importação de arquivo CSV.
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 Campanha. |
Parâmetros da Chamada de API
Enpoint |
/api/v1/campaign/{id}/subscribers/tasks |
---|---|
Método |
POST |
-
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://{{dominio}}.callwe.io/dialer/campaign/edit/659
O ID dessa campanha é 659.
-
token
O token pode ser enviado tanto através do cabeçalho da requisição (header) quanto via query string na URL. Para gerar um token, basta seguir os passos em Tokens de API. -
Content-Type
O Content-Type deve ser enviado através do cabeçalho da requisição (header) e indica o tipo do arquivo que está sendo importado. Esta API suporta apenas envio de arquivos
Esta API suporta apenas envio de arquivos .csv. Sendo assim, no cabeçalho da requisição, o Content-Type deve ser text/csv.
-
Body
O body da requisição é o conteúdo do arquivo CSV.
Exemplo:"id","external_id","name","status","outcome","number1","comments","cidade","ESTADO" "6","","joaquim","Pending","-","8599991234","","recife","PE"
O tamanho máximo do arquivo é 50MB com um tempo limite de upload de 30 segundos.
Retorno da chamada
O propósito desta API é receber o arquivo com os dados dos assinantes a serem importados e criar uma tarefa assíncrona (task) que processa esse arquivo e, consequentemente, faz o cadastro dos assinantes na campanha.
Sendo assim, o retorno desta chamada é um JSON que contém o link de acesso a API que verifica o estado da tarefa criada. Para saber mais informações acesse em API - Tarefas - Verificando o estado de uma tarefa assíncrona.
Exemplos de Chamada
Exemplo de requisição - CURL
curl -X POST \
--url https://{{dominio}}.callwe.io/api/v1/campaign/1/subscribers/tasks \
-H 'Content-Type: text/csv' \
-H 'token: <API_TOKEN>' \
--data-binary '"""id;name;number1;number2;Joao Silva\tMaria Joaquina;8433214567;84987654321\tJose Santos;8498764567;8494564321"""'
Exemplo de resposta:
{
"meta": {
"status": 200,
"message": "OK"
},
"data": {
"message": "Upload successful. A new task was created to finish the import. Check the task status using the task_url.",
"task_url": "https://cliente.evolux.net.br/api/v1/tasks/c8160aa51abb453fac6b860ce07187c6"
}
}