O que é uma API?
API (Application Programming Interface) é uma interface que permite que dois sistemas diferentes se comuniquem. No caso da MF Zap, a API permite que você envie mensagens de texto ou mídia (como imagens, PDFs etc.) diretamente para contatos do MF Zap usando requisições HTTP via código ou sistemas integrados.
Como a API funciona na plataforma MF Zap?
A MF Zap fornece dois métodos principais de envio de mensagens por meio da API:
- Mensagens de Texto
- Endpoint: https://api.mfzap.tech/api/messages/send
- Método: POST
- Headers:
- Authorization: Bearer [seu token cadastrado]
- Content-Type: application/json
Explicando os campos:
- number: Número do destinatário (sem símbolos ou espaços).
- body: Texto da mensagem.
- userId e queueId: Para controle interno (opcional).
- sendSignature: Se deve assinar a mensagem.
- closeTicket: Se deve encerrar o atendimento.
- Mensagens de Mídia
- Mesmo Endpoint: https://api.mfzap.tech/api/messages/send
- Método: POST
- Headers:
- Authorization: Bearer token
- Content-Type: multipart/form-data
- FormData (formulário de envio):
- number: Número do destinatário.
- body: Texto que acompanha o arquivo.
- userId: ID do usuário (opcional).
- queueId: ID da fila (opcional).
- medias: Arquivo que será enviado (imagem, PDF etc.).
- sendSignature: true/false.
- closeTicket: true/false.
⚠️ Observações Importantes
- Antes de usar a API, é obrigatório cadastrar o token da conexão que enviará as mensagens.
- Vá até o menu “Conexões” na plataforma.
- Edite a conexão e insira o token gerado.
- O número do destinatário não deve conter máscara ou caracteres especiais, e deve ter:
- Código do país (ex: 55 para Brasil)
- DDD (ex: 85)
- Número (ex: 999999999)
✅ Teste de Envio (Interface Gráfica)
Dentro da plataforma MF Zap, há uma área chamada Teste de Envio que permite testar a API manualmente preenchendo:
- Token
- Número
- Mensagem
- ID do usuário
- ID da fila
- (para mídia) Seleção de arquivo
