Documentação API Octopus

A API Ocotopus consistem em uma interface para integração com diversos sistemas de CRM
para envio de Mailings à discadora da Fast Telecom Brasil
Abaixo seram descritos os passos para integração com nossa API que consite em passos bem
simples
Autenticar e receber um TOKEN que será válido por uma hora com possibilidade de se
revogado em menos tempo de acordo com o cliente.
Enviar o mailing
o Mailing deverá respeitar alguns campos chave
Nossa API está configurada para suportar até 30.000 documentos (regitros de sua
base de dados) por envio, podendo ser reconfigurado caso seja necessário
Passos para o envio de Mailing
Autenticação
Com um usuário previamente cadastrado, será possível o envio de um ou mais mailing, bem
como campanhas. Para isso é necessário ter um username, password e clientId criados pela
Fast Telecom Brasil. De posse desses dados o cliente deverá fazer uma chamada de
autenticação que, por default é válida por uma hora, da seguinte forma:
curl --location --request POST 'https://api.diskoctopus.com.br/auth'
\
--header 'Authorization: Basic bGVhbmRyby5kb21pbmd1ZXM6dGVzdGU=' \
--header 'Content-Type: application/json' \
--data-raw '{
"clientId": 1
}'

Dentro do atributo Authorization no header, constam dois parâmetros que são:

username (string)
password (string)
Dentro do body consta um parâmetro chamaro clientId que será informado previamente
pela Fast Telecom Brasil.
PS: Se necessitar de exemplos em uma linguagem específica, por favor nos contate para que
possamos auxiliá-lo.
O retorno dessa chamada consiste em algumas variáveis de autenticação para provar que você
é um usuário válido e pode enviar mailings.
{
"exp":"Wed, 29 Dec 2021 08:53:07 GMT",

Direitos reservados 2022 Extractta 1 de 4

 "message":"Validated successfully",

"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6ImxlYW5
kcm8uZG9taW5ndWVzIiwiY2xpZW50SWQiOjEsImV4cCI6MTY0MDc2Nzk4N30.A-
nQ9eOOZ7Sj9_TE7_Ggkfl_o-4tzW84SGMZ90m4aI4"
}

Por defaut o token é válido por 12 horas, podendo oscilar de cliente para cliente (consulte seu
contrato para mais informações).
Esse método, como mencionado acima, deve ser adicionado a cada intervalo de tempo
(dependendo de seu contrato) e é requerido para as demais solicitações às APIs.
Você não precisa de uma nova chamada ao método de autenticação até que receba um retorno
nos seguintes moldes:
{
"message":"Token invalido ou expirado"
}

Assim que receber um retorno como esse, será necessário reautenticar, receber um novo token
e reenviar a solicitação, independentemente do método solitado.
Enviando um mailing
Nossa API está preparada para receber até 500.000 mil documentos, ou seja, dados de
pessoas para fazer as ligações. Se precisar de uma carga maior, por favor nos contate para
entendermos melhor seu caso de uso.
Método mailing
Esperamos um array chamado clientes que contenha os seguintes campos:
id: Um identificador único do contato
cpf: CPF do contato
nome: Nome da Pessoa Física ou Jurídica (string)
telefones: aqui recebemos um array com ordem de prioridade para as ligaçoes:
telefone, composto pelo DDD e Telefone: 11111111111 de até 11 posições do tipo
inteiro
Totalmente opcional é o conteúdo do campo camposAdicionais. Este também espera um array
com os seguintes campos:
chave: representa o nome do campo
valor: representa o valor do campo
tipo: representa o tipo de dados e eles podem ser:
1 (string)
2 (inteiro)
3 (data)

Direitos reservados 2022 Extractta 2 de 4

 4 (decimal)
Outro campo opcional é: nomeCampanha. Este campo pode vir no corpo da requisição e será
utilizado como um nome amigável para a campanha, inclusive pode ser o mesmo nome de
campanha criado pelo software integrador. Um exemplo seria:
curl --location --request POST
'https://api.diskoctopus.com.br/mailing' \
--header 'token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VybmFtZSI6ImxlYW5kcm8uZG9t
aW5ndWVzIiwiY2xpZW50SWQiOjEsImV4cCI6MTY0MDY0MDM2NH0.aj-W9SsgIFuyPmo-
h1IU_P8lIsYBEue1bLnu6EStiTM' \
--header 'Content-Type: application/json' \
--data-raw '{
"nomeCampanha": "Nome da Campanha",
"camposAdicionais": [
{
"chave": "nome_do_campo_adicional",
"valor": "valor_do_campo_adicional",
"tipo": 1
},
{
"chave": "nome_do_campo_adicional",
"valor": "valor_do_campo_adicional",
"tipo": 2
}
],
"clientes":[
{
"id": 1
"nome": "Nome Cliente 1",
"CPF": "11111111111",
"telefones": [11111111111, 22222222222, 33333333333]
},
{
"id": 2
"nome": "Nome Cliente 2",
"CPF": "22222222222"
"telefones": [11111111111, 22222222222, 33333333333]
}
]
}'

O retorno é composto pelo seguinte objeto e o se não houver erro o código HTTP 200 é
enviado:
{
"_v":1.4, // versão da API
"idCampanha":54, // ID da Campanha

Direitos reservados 2022 Extractta 3 de 4

 "idImportacao":"627e71604144795ad0d312ab", // id da importação
para ser utilizado na verificação de status da importação
"totalContatos":50000, // contatos no mailing
"totalTelefones":400000 // telefones no mailing
}

Método mailing/status
Com este método é possível verificar o status da importação. Esperamos apenas um campo e a
autenticação é da mesma forma do método anterior:
Input
idImportacao: string, encontrada no objeto de retorno do método mailing
Output
Um objeto composto da seguinte forma:
{
"dataInicioImportacao": "2022-05-13T14:57:05",
"nomeCampanha": "b__ campanha 14 - IP 71 - 50k",
"percentualImportado": 100
}

Direitos reservados 2022 Extractta 4 de 4