API de envio WhatsApp

Com a API IAGENTEapp você envia e recebe mensagens pelo WhatsApp de forma automática e segura, acompanhando o status de cada envio diretamente da sua plataforma.

Apresentação

Integrando o IAGENTEapp ao seu sistema, você pode realizar envios e recebimentos de mensagens pelo canal mais utilizado do Brasil. Além disso, é possível acompanhar o status das interações através de chamadas HTTP, garantindo mais controle e eficiência no seu atendimento.

Documentação

Integre o IAGENTEapp à sua plataforma, ERP ou sistema e envie e-mails de acordo com a rotina de comunicação de sua empresa, gerencie grupo/contatos e acesse relatórios completos.

Whatsapp Cloud

Whatsapp QR Code

Iniciando uma conversa

Conecte sua plataforma, ERP ou sistema ao IAGENTEsmtp utilizando as informações abaixo. Importante: Todos os emails devem ser enviados utilizando UTF-8.

Host

smart.iagentesmtp.com.br

Usuário

seu usuário de acesso no sistema
Senha

senha smtp

Porta
25 ou 587
  • * Limite de 30MB para cada e-mail enviado, incluindo cabeçalhos e anexos;
  • * Limite de 500 destinatários para cada e-mail enviado;
  • * Limite de 50 conexões simultâneas;
  • * Opção "com cópia (CC)" será transformada em um e-mail avulso;
  • * Opção "com cópia oculta (BCC) não é suportada.

Parâmetros adicionais no cabeçalho
dos e-mails enviados

Parâmetro

Descrição

x-campanhaid

Especifica um identificador vinculado a seu e-mail (nome de campanha ou id interno)

Como enviar um Template

Use este endpoint para enviar um template no WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header:

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API


Parâmetros no Path:

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.


Body (JSON):

Nome

Tipo

Descrição

contact_name

String

Nome do contato que receberá a mensagem.

contact_phone

String

Número do contato (com DDI)

message

string (JSON.stringify)

Objeto de mensagem convertido em string JSON


Exemplo do corpo da requisição (body):

				
					{
  "contact_name": "Gabriel",
  "contact_phone": "5551981234567",
  "message": "Olá, Gabriel! Esta é uma mensagem enviada via integração WhatsApp QR."
}

Resposta em caso de sucesso (200)

				
					{
    "messaging_product": "whatsapp-qr",
    "contact": {
        "name": "Gabriel",
        "phone": "+5551981234567"
    },
    "message": {
        "id": "1234d429ab0723fd2d3e666",
        "status": "pending"
    }
}

Resposta em caso de erro (400)

				
					{  

  "status": "error",
    "message": "The channel exemple 99999999 is not able to send messages"
}

Como enviar um texto

Use este endpoint para enviar um texto no WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API

Content-Type

String

application/json

Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.

Body (JSON)

Nome

Tipo

Descrição

contact_name

String

Nome do contato que receberá a mensagem.

contact_phone

String

Número do contato (com DDI)

message

String (JSON.stringify)

Objeto de mensagem convertido em string JSON

Exemplo de requisição

				
					{
  "contact_name": "Gabriel",
  "contact_phone": "5551981234567",
  "message": "{\"messaging_product\": \"whatsapp\", \"to\": \"5551981234567\",\"type\": \"text\",  \"text\": {\"body\": \"Olá Gabriel! Este é um teste de envio pela API do WhatsApp Cloud.\" }}"
}

Resposta em caso de sucesso (200)

				
					{
    "messaging_product": "whatsapp",
    "contact": {
        "name": "Gabriel",
        "phone": "+5551981234567"
    },
    "message": {
        "id": "1234d429ab0723fd2d3e666",
        "status": "pending"
    }
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Channel 123456 not found"
}

Upload de mídia

Use este endpoint para enviar arquivos de mídia (como imagens, áudios ou documentos) para o WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header

Nome

Tipo

Descrição

iagente-key

String

Chave de autenticação fornecida pela plataforma.

Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.

Body (JSON)

Nome

Tipo

Descrição

file

File

Número do telefone utilizado para enviar as mensagens.

name

String

Nome do arquivo a ser enviado.

Exemplo de requisição

				
					{
  "midia": "file.jpg",
  "name": "foto123.jpg"
}

Resposta em caso de sucesso (200)

				
					{
  "messaging_product": "whatsapp",
  "id": "2111228666612345"
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Error message"
}

Upload de mídia

Use este endpoint para enviar arquivos de mídia (como imagens, áudios ou documentos) para o WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header

Nome

Tipo

Descrição

iagente-key

String

Chave de autenticação fornecida pela plataforma.

Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.

Body (JSON)

Nome

Tipo

Descrição

file

File

Número do telefone utilizado para enviar as mensagens.

name

String

Nome do arquivo a ser enviado.

Exemplo de requisição

				
					{
  "midia": "file.jpg",
  "name": "foto123.jpg"
}

Resposta em caso de sucesso (200)

				
					{
  "messaging_product": "whatsapp",
  "id": "2111228666612345"
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Error message"
}

Como enviar uma mídia

Use este endpoint para enviar um template no WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API

Content-Type

String

application/json

Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.

Body (JSON)

Nome

Tipo

Descrição

contact_name

String

Nome do contato que receberá a mensagem.

contact_phone

String

Número do contato (com DDI)

message

String (JSON.stringify)

Objeto de mensagem convertido em string JSON

Exemplo de requisição

				
					{
  "contact_name": "Gabriel",
  "contact_phone": "5551981234567",
  "message": "{ \"messaging_product\": \"whatsapp\", \"to\": \"5551981234567\", \"type\": \"image\", \"image\": { \"id\": \"2111228666612345\", \"caption\": \"Essa é a imagem de teste\" } }"
}

Resposta em caso de sucesso (200)

				
					{
    "messaging_product": "whatsapp",
    "contact": {
        "name": "Gabriel",
        "phone": "+5551981234567"
    },
    "message": {
        "id": "1234d429ab0723fd2d3e666",
        "status": "pending"
    }
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Channel 123456 not found"
}

Consulta Status da Mensagem

Use este endpoint para consultar o status de uma mensagem já enviada pelo WhatsApp Cloud.

GET

https://api.iagente.app/whatsappcloud/statusMessage/1234d429ab0723fd2d3e666

Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API

Parâmetros no Path

Nome

Tipo

Descrição

messageId

String

ID da mensagem que você quer verificar.

Resposta em caso de sucesso (200)

				
					{
  "messaging_product": "whatsapp",
  "messageId": "1234d429ab0723fd2d3e666",
  "status": "pending"
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Message not found"
}

Iniciando uma conversa

Use este endpoint para enviar mensagens utilizando a integração com o WhatsApp QR

POST

https://api.iagente.app/whatsapp-qr/sendMessage/5551981234567


Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API


Parâmetros Path

Nome

Tipo

Descrição

identifier

String

Numero correspondente ao canal utilizado.


Body (JSON)

Nome

Tipo

Descrição

contact_name

String

Nome do contato que receberá a mensagem.

contact_phone

String

Número do contato (com DDI)

message

string

mensagem que deseja enviar


Exemplo do corpo da requisição (body)

				
					{
  "contact_name": "Gabriel",
  "contact_phone": "5551981234567",
  "message": "Olá, Gabriel! Esta é uma mensagem enviada via integração WhatsApp QR."
}

Resposta em caso de sucesso (200)

				
					{
    "messaging_product": "whatsapp-qr",
    "contact": {
        "name": "Gabriel",
        "phone": "+5551981234567"
    },
    "message": {
        "id": "1234d429ab0723fd2d3e666",
        "status": "pending"
    }
}

Resposta em caso de erro (400)

				
					{  

  "status": "error",
    "message": "The channel exemple 99999999 is not able to send messages"
}

Upload de Mídia

Use este endpoint para enviar arquivos de mídia (como imagens, áudios ou documentos) para o WhatsApp QR.

POST

https://api.iagente.app/whatsapp-qr/uploadMedia/5551981234567


Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API


Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.


Body (form-data)

Nome

Tipo

Descrição

midia

file

Arquivo de mídia a ser enviado (imagem, áudio, vídeo ou documento).

name

String

Nome do arquivo, incluindo a extensão (ex: imagem.png)


Exemplo de requisição

				
					{
  "method": "POST",
  "url": "https://api.iagente.app/whatsapp-qr/uploadMedia/5551981234567",
  "headers": {
    "iagente-key": "3d50c07ce2fea0e4d3091e6f6687e8dd91abc89d1337b5f2b83288907b3b5f47"
  },
  "body": {
    "type": "form-data",
    "fields": {
      "midia": "(File) image.png",
      "name": "image.png"
    }
  }
}

Resposta em caso de sucesso (200)

				
					{
   "messaging_product": "whatsapp-qr",
   "media": {
       "id": "1234d429ab0723fd2d3e666",
       "filename": "image.png",
       "size": "0.12 MB"
   }
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "error_empty_file"
}

Upload de mídia

Use este endpoint para enviar arquivos de mídia (como imagens, áudios ou documentos) para o WhatsApp Cloud.

POST

https://api.iagente.app/whatsapp-cloud/sendMessage/5551981234567

Header

Nome

Tipo

Descrição

iagente-key

String

Chave de autenticação fornecida pela plataforma.

Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.

Body (JSON)

Nome

Tipo

Descrição

file

File

Número do telefone utilizado para enviar as mensagens.

name

String

Nome do arquivo a ser enviado.

Exemplo de requisição

				
					{
  "midia": "file.jpg",
  "name": "foto123.jpg"
}

Resposta em caso de sucesso (200)

				
					{
  "messaging_product": "whatsapp",
  "id": "2111228666612345"
}

Resposta em caso de erro (400)

				
					{
    "status": "error",
    "message": "Error message"
}

Como enviar uma mídia

Use este endpoint para enviar arquivos de mídia (como imagens, áudios ou documentos) como mensagem utilizando a integração com o WhatsApp QR.

POST

https://api.iagente.app/whatsapp-qr/sendMessage/5551981234567


Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API


Parâmetros no Path

Nome

Tipo

Descrição

identifier

String

Número do telefone utilizado para enviar as mensagens.


Body (JSON)

Nome

Tipo

Descrição

contact_name

String

Nome do contato que receberá a mídia.

contact_phone

String

Número do contato (com DDI)

mediaId

String 

Identificador da mídia previamente enviada.


Exemplo de requisição (body): 

				
					{
 "contact_name": "Gabriel",
 "contact_phone": "5551981234567",
 "mediaId": "1234d429ab0723fd2d3e666"
}

Resposta em caso de sucesso (200)

				
					{
   "messaging_product": "whatsapp-qr",
   "contact": {
       "name": "Gabriel",
       "phone": "+5551981234567"
   },
   "message": {
       "id": "1234d429ab0723fd2d3e666",
       "status": "pending"
   }
}

Resposta em caso de erro (400)

				
					{
  "status": "error",
  "message": "Invalid or missing parameters"
}

Consulta de Status da Mensagem

Use este endpoint para consultar o status de uma mensagem já enviada utilizando a integração com o WhatsApp QR.

GET

https://api.iagente.app/whatsapp-qr/statusMessage/1234d429ab0723fd2d3e666


Header

Nome

Tipo

Descrição

iagente-key

String

Token de autenticação da API


Parâmetros no Path

Nome

Tipo

Descrição

messageId

String

ID da mensagem que você quer verificar.

Resposta em caso de sucesso (200)

				
					{
    "messaging_product": "whatsapp-qr",
    "messageId": "1234d429ab0723fd2d3e666",
    "status": "pending"
}

Resposta em caso de erro (404)

				
					{
  "status": "error",
  "message": "Message 1234d429ab0723fd2d3e666 not found"
}

Política de Privacidade

Instagram Facebook-square Linkedin-in Youtube Twitter Whatsapp Tiktok

WhatsApp

E-mail transacional

E-mail marketing

SMS

Assine nossa newsletter