Integração Sendeasy via Server

A API da Sendeasy permite que você envie mensagens e crie leads de forma programática, categorizando-os em setores específicos. Nesta página, vamos explorar como utilizar o endpoint /message para essas operações.

Modelo

O modelo de lead inclui todas as informações necessárias sobre os contatos que você deseja gerenciar, como o número de telefone, nome, e-mail, e tags derivadas dos parâmetros da URL.

Propriedades

Name
number
Type
string
Description
Telefone do lead em formato internacional (ex: "5511999999999").
Name
name
Type
string
Description
Nome do lead.
Name
email
Type
string
Description
Endereço de e-mail do lead.
Name
url
Type
string
Description
URL contendo parâmetros UTM que serão automaticamente registrados como tags.
Name
message
Type
string
Description
Mensagem a ser enviada para o lead. Se não for fornecida, apenas o lead será criado.
Name
sector
Type
string
Description
ID do setor para categorizar o lead.
Name
files
Type
array
Description
Lista de URLs de imagens/arquivos a serem enviadas com a mensagem.

POST/message

Modo de uso

Este endpoint permite que você envie uma mensagem e crie um lead ao mesmo tempo. Caso não seja fornecida uma mensagem ou arquivo de imagem, apenas o lead será criado.

Atributos obrigatórios

Name
number
Type
string
Description
O número de telefone do lead. Este é o único campo obrigatório.

Atributos opcionais

Name
name
Type
string
Description
O nome do lead.
Name
email
Type
string
Description
O endereço de e-mail do lead.
Name
url
Type
string
Description
URL contendo parâmetros UTM que serão automaticamente registrados como tags.
Name
message
Type
string
Description
Mensagem a ser enviada para o lead.
Name
sector
Type
string
Description
ID do setor para categorizar o lead.
Name
files
Type
array
Description
Lista de URLs de imagens/arquivos a serem enviadas com a mensagem.

Request

POST

/message

curl --location 'https://server.sendeasy.app/message' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer EXEMPLO_DE_TOKEN' \
--data-raw '{
    "name": "Exemplo Nome",
    "email": "exemplo@dominio.com",
    "number": "5511999999999",
    "url": "https://exemplo.com/webhook/?utm_source=google&utm_medium=cpc&utm_campaign=exemplo&utm_term=sendeasy&utm_content=TESTE",
    "message": "Mensagem de teste via API",
    "sector": "12",
    "files": [
        "https://exemplo.com/imagem.png"
    ]
}'

Response

{
    "success": true,
    "message": "Message queued successfully"
}

Considerações Finais

As requsições entram em uma fila de processamento e são processadas de forma assíncrona, o que significa que você pode continuar usando o seu aplicativo sem esperar por uma resposta. Isso também significa que você não receberá uma mensagem de erro caso seu payload tenha erros, portanto fique atento e precisar de mais assistência, entre em contato com o suporte da Sendeasy.