api-v1-docs.leaddigital.marketing Open in urlscan Pro
35.174.135.234 Public Scan

Back to summary
URL:
https://api-v1-docs.leaddigital.marketing/
Submission: On November 07 via api (November 7th 2024, 2:42:32 pm UTC) from US — Scanned from DE
Form analysis
0 forms found in the DOM

Text Content

 * Body
 * Headers (8)

 * Body
 * Headers (8)

 * Body
 * Headers (8)




Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Single Column

LANGUAGE
cURL - cURL



Documentação API LeadDigital
Introduction
Autenticação
Retornos
Endpoints
Campanhas
Contatos
Canais


DOCUMENTAÇÃO API LEADDIGITAL


SEJA BEM-VINDO(A)!

Aqui você vai encontrar tudo que precisa para realizar a sua integração da
melhor forma possível. Venha conosco e ajudaremos a alavancar o seu negócio!


AUTENTICAÇÃO

Para acessar os EndPoints é necessário o api token do usuário. Isto é feito
acessando a conta pelo portal com o nome de usuário e senha do cliente.

Dentro da conta, basta clicar no menu lateral API, depois copie o token do
cliente e utilize enviando na requisição no cabeçalho HTTP como Bearer Token.


RETORNOS

200 - Sucesso.

401 - Falha na autenticação.

400 - Erro na solicitação, verifique o response do retorno.

500 - Erro interno.


ENDPOINTS

AUTHORIZATIONBearer Token
Token

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3MjMyMTMyOTgsInN1YiI6ImU5ZTE5NzhlLTM0Y2UtNDZmMS1iN2Q5LWQyZGFkYzE4OGNiMiJ9.ux_kaSc_STGe1EDcNKotzzXVOPNMwnL7R_Q9N4wEXPo

CAMPANHAS

AUTHORIZATIONBearer Token
This folder is using Bearer Token from collectionDocumentação API LeadDigital


GETFIND


https://api-v1.leaddigital.marketing/campaigns/find

Consulta as campanhas

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionDocumentação API LeadDigital
PARAMS
title

Título da campanha

Busca por uma campanha através do seu título

number

Número do whatsapp

Busca por um contato através do seu número de whatsapp

channel

UUID

ID do canal cadastrado

type

broadcast

Tipo da campanha. Defina "broadcast" para transmissão ou "status" para campanha
de status

triggerStatus

pending

Status do envio da campanha. pending = pendente; sending = enviando; cancelled =
cancelada; postponed = adiada

withReport

true

Campanhas com os relatórios disponíveis

page

1

perPage

10

all

true

Consulta sem paginação

Example Request
200 - Success

curl


curl --location 'https://api-v1.leaddigital.marketing/campaigns/find'

200 OK
Example Response
 * Body
 * Headers (8)

View More
json


{
  "data": [
    {
      "id": "69e1abed-593c-4446-9153-cf0d2795940c",
      "title": "Teste status automático",
      "message": null,
      "fileId": null,
      "clientId": "e9e1978e-34ce-46f1-b7d9-d2dadc188cb2",
      "fileType": "image",
      "type": "status",
      "bgStatusColor": "#242424",
      "status": "active",
      "triggerStatus": "completed",
      "triggerMode": "automatic",
      "triggerDate": "2024-05-28",
      "triggerHour": "14:50",
      "triggerTime": "2024-05-28T14:50:00.000Z",
      "triggerQuantity": 2,
      "triggerSentQuantity": 1,
      "dispatchPrevisionTime": 23,
      "startDate": null,
      "finishDate": null,
      "createdAt": "2024-05-28T14:43:28.000Z",
      "updatedAt": "2024-05-28T15:15:25.000Z",
      "cancelledAt": null,
      "editedAt": null,
      "channels": [
        {
          "channel": {
            "id": "326fb46d-5e49-4b0c-81b0-e4520318be45",
            "name": "Teste atendimento",
            "number": "+5573981460308"
          }
        }
      ],
      "file": null
    },
    {
      "id": "2a575d38-abe4-43bb-b7c5-35daca7b3411",
      "title": "Teste",
      "message": null,
      "fileId": null,
      "clientId": "e9e1978e-34ce-46f1-b7d9-d2dadc188cb2",
      "fileType": "image",
      "type": "status",
      "bgStatusColor": "#242424",
      "status": "active",
      "triggerStatus": "completed",
      "triggerMode": "manual",
      "triggerDate": "2024-05-15",
      "triggerHour": "16:03",
      "triggerTime": "2024-05-15T16:03:00.000Z",
      "triggerQuantity": 10,
      "triggerSentQuantity": 9,
      "dispatchPrevisionTime": 24,
      "editedCount": 0,
      "startDate": null,
      "finishDate": null,
      "createdAt": "2024-05-15T16:00:29.000Z",
      "updatedAt": "2024-05-28T14:22:37.000Z",
      "cancelledAt": null,
      "editedAt": null,
      "channels": [],
      "file": null
    }
  ],
  "pagination": {
    "total": 2,
    "totalPages": 1,
    "currentPage": 1,
    "perPage": 10
  }
}

Server

nginx/1.18.0 (Ubuntu)

Date

Fri, 09 Aug 2024 20:29:58 GMT

Content-Type

application/json; charset=utf-8

Content-Length

1743

Connection

keep-alive

X-Powered-By

Express

Access-Control-Allow-Origin

*

ETag

W/"6cf-TPdO1f3tekDQ/9a0WPMEnd4RpUE"


GETFINDONE


https://api-v1.leaddigital.marketing/campaigns/find/69e1abed-593c-4446-9153-cf0d2795940c

Consulta uma determinada campanha através do seu ID

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionDocumentação API LeadDigital
Example Request
200 - Success

curl


curl --location 'https://api-v1.leaddigital.marketing/campaigns/find/69e1abed-593c-4446-9153-cf0d2795940c'

200 OK
Example Response
 * Body
 * Headers (8)

View More
json


{
    "id": "69e1abed-593c-4446-9153-cf0d2795940c",
    "title": "Teste status automático", // Título da campanha
    "message": null, // Mensagem da camapanha
    "fileId": null, // ID do arquiv
    "clientId": "e9e1978e-34ce-46f1-b7d9-d2dadc188cb2", // ID do cliente
    "fileType": "image", // Tipo de arquivo
    "type": "status", // Tipo da campanha (status, broadcast, whatsappChannel)
    "bgStatusColor": "#242424", // Cor de background do status
    "status": "active", // Status da campanha (active, inactive, expired)
    "triggerStatus": "completed", // Status do disparo (pending = Pendente, sending = Enviando, completed = Envio concluído, cancelled = Cancelado, postponed = Adiado, sendError = Falha no envio)
    "triggerMode": "automatic", // Tipo de envio
    "triggerDate": "2024-05-28", // Data do disparo
    "triggerHour": "14:50", // Hora do disparo
    "triggerTime": "2024-05-28T14:50:00.000Z", // Timestamp data e hora do disparo
    "triggerQuantity": 2, // Total de contatos das listas
    "triggerSentQuantity": 1, // Total de contatos a disparar
    "dispatchPrevisionTime": 23, // Tempo previsto do disparo em minutos
    "editedCount": 0,
    "startDate": null, // Data de início do disparo
    "finishDate": null, // Data fim do disparo
    "createdAt": "2024-05-28T14:43:28.000Z",
    "updatedAt": "2024-05-28T15:15:25.000Z",
    "cancelledAt": null,
    "editedAt": null,
    "channels": [
        {
            "channel": {
                "id": "326fb46d-5e49-4b0c-81b0-e4520318be45",
                "name": "Teste atendimento",
                "number": "+5573981460308"
            }
        }
    ],
    "file": null,
    "report": {
        "id": "3e748784-725c-4e5b-9d54-64ed5f7af53b",
        "campaignId": "69e1abed-593c-4446-9153-cf0d2795940c", // ID da campanha
        "dispatchPrevisionTime": 23, // Tempo previsto do disparo em minutos
        "dispatchInitDate": "2024-05-28T11:50:00.000Z", // Horário inicial do disparo
        "dispatchFinishDate": "2024-05-28T12:15:25.000Z", // Horário do término do diparo
        "broadcastListsTotal": null, // Total de listas de transmissão
        "progressWhatsappSendTotal": 2, // Total de mensagens enviadas
        "progressWhatsappReceivedTotal": 2, // Total recebido pelo servidor do whatsapp
        "progressContactsReceivedTotal": null, // Total recebido nos dispositivos dos contatos
        "progressReadTotal": 1, // Total lidas
        "progressDownloadTotal": null, // Total de mídias visualizadas
        "progressReport": 100, // Percentual do progresso do disparo
        "contactsChannel": "Teste atendimento=2", // Total de contatos por canal
        "contactsRegion": "Bahia=1|Paraná=1", // Total de contatos por região
        "contactsGender": "Não identificado=2|Feminino=0|Masculino=0|Outro=0", // Total de contatos por gênero
        "createdAt": "2024-05-28T15:15:25.000Z",
        "updatedAt": "2024-05-28T15:15:25.000Z"
    }
}

Server

nginx/1.18.0 (Ubuntu)

Date

Fri, 09 Aug 2024 20:31:00 GMT

Content-Type

application/json; charset=utf-8

Content-Length

1550

Connection

keep-alive

X-Powered-By

Express

Access-Control-Allow-Origin

*

ETag

W/"60e-HRDZJCpxBKx2JIobW1t4Drxgf2I"


POSTCREATE


https://api-v1.leaddigital.marketing/campaigns/create

Cadastra uma campanha

AUTHORIZATIONBearer Token
This request is using Bearer Token from collectionDocumentação API LeadDigital
Bodyraw (json)
View More
json


{
    // Título da campanha
    "title": "Teste",

    // Mensagem da campanha (Opcional). Em caso de envio de imagem ou vídeo, esta mensagem será a leganda
    "message": "teste de mensagem",

    // Tipo da campanha (Transmissão ou status). broadcast = lista de transmissão; status = status do whatsapp
    "type": "broadcast",

    // Array de IDs dos canais para disparo da campanha (Opcional)
    "channelsIds": ["326fb46d-5e49-4b0c-81b0-e4520318be45"],

    // ID do grupo de canais (Opcional)
    // "channelsGroupId": "2cb799ba-fd47-4703-a5d5-d9688589c6f0",

    // Data de disparo
    "triggerDate": "2024-08-10",

    // Hora do disparo
    "triggerHour": "12:30:00"

    // Cor de fundo do status (Opcional)
    // "bgStatusColor": "#ccc",

    // Data inicial do período de vigência da campanha (Opcional)
    // "startDate": "2024-08-09",

    // Data final do período de vigência da campanha (Opcional)
    // "finishDate": "2024-08-12",
}

Example Request
200 - Success

View More
curl


curl --location 'https://api-v1.leaddigital.marketing/campaigns/create' \
--data '{
    // Array de IDs dos canais para disparo da campanha (Opcional)
    "channelsIds": ["326fb46d-5e49-4b0c-81b0-e4520318be45"],

    // ID do grupo de canais (Opcional)
    // "channelsGroupId": "2cb799ba-fd47-4703-a5d5-d9688589c6f0",

    // Título da campanha
    "title": "Teste",

    // Mensagem da campanha. (Em caso de envio de imagem ou vídeo, esta mensagem será a leganda)
    "message": "teste de mensagem",

    // Tipo da campanha (Transmissão ou status). broadcast = lista de transmissão; status = status do whatsapp
    "type": "broadcast",

    // Data de disparo
    "triggerDate": "2024-08-10",

    // Hora do disparo
    "triggerHour": "12:30:00"

    // Cor de fundo do status (Opcional)
    // "bgStatusColor": "#ccc",

    // Data inicial do período de vigência da campanha (Opcional)
    // "startDate": "2024-08-09",

    // Data final do período de vigência da campanha (Opcional)
    // "finishDate": "2024-08-09",
}'

200 OK
Example Response
 * Body
 * Headers (8)

View More
json


{
  "id": "f5fdb85f-b6e7-42aa-91b9-fa3cf0161a54",
  "title": "Teste",
  "message": "teste de mensagem",
  "fileId": null,
  "clientId": "e9e1978e-34ce-46f1-b7d9-d2dadc188cb2",
  "fileType": null,
  "type": "broadcast",
  "bgStatusColor": null,
  "status": "active",
  "triggerStatus": "pending",
  "triggerMode": "manual",
  "triggerDate": "2024-08-10",
  "triggerHour": "12:30:00",
  "triggerTime": "2024-08-10T12:30:00.000Z",
  "triggerQuantity": 0,
  "triggerSentQuantity": 0,
  "dispatchPrevisionTime": null,
  "editedCount": 0,
  "startDate": null,
  "finishDate": null,
  "createdAt": "2024-08-09T21:15:00.000Z",
  "updatedAt": "2024-08-09T18:14:59.000Z",
  "cancelledAt": null,
  "editedAt": null,
  "channels": [],
  "file": null
}

Server

nginx/1.18.0 (Ubuntu)

Date

Fri, 09 Aug 2024 21:14:59 GMT

Content-Type

application/json; charset=utf-8

Content-Length

777

Connection

keep-alive

X-Powered-By

Express

Access-Control-Allow-Origin

*

ETag

W/"309-HMgun+j9RtcUXVPWFFc1jSyWv24"
api-v1-docs.leaddigital.marketing Open in urlscan Pro 35.174.135.234 Public Scan

Form analysis 0 forms found in the DOM

Text Content

api-v1-docs.leaddigital.marketing Open in urlscan Pro
35.174.135.234 Public Scan

Form analysis
0 forms found in the DOM
