# Documentação da API - Matec Chat
Bem-vindo à documentação oficial da API do Matec Chat.
Base URL:
https://connect.matec.ai/
Todas as requisições exigem autenticação via apikey no cabeçalho da requisição:
Headers obrigatórios
apikey: SUA_CHAVE_DE_API
Content-Type: application/json
Solicite o token de API para o suporte da Matec
Enviar Mensagem de Texto
**POST** `/message/sendText/{{instance}}`
Envia uma mensagem de texto para um número de WhatsApp.
Parâmetros (body):
{
"number": "5591999999999",
"options": {
"delay": 1200,
"presence": "composing",
"linkPreview": false
},
"textMessage": {
"text": "Olá! Tudo bem?"
}
}
Enviar PDF por URL
**POST** `/message/sendDocument/{{instance}}`
Envia um arquivo PDF via URL.
Parâmetros (body):
{
"number": "5591999999999",
"documentMessage": {
"url": "https://dominio.com.br/arquivo.pdf",
"fileName": "arquivo.pdf",
"caption": "Segue o documento"
}
}
Enviar Mídia por URL (imagem, áudio ou vídeo)
**POST** `/message/sendMedia/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999",
"mediaMessage": {
"url": "https://dominio.com.br/imagem.jpg",
"mimetype": "image/jpeg",
"caption": "Aqui está a imagem"
}
}
Enviar Localização
**POST** `/message/sendLocation/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999",
"locationMessage": {
"latitude": "-23.55052",
"longitude": "-46.633308",
"name": "Endereço"
}
}
Enviar Contato
**POST** `/message/sendContact/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999",
"contactMessage": {
"fullName": "João Silva",
"phoneNumber": "5591988888888"
}
}
Enviar Lista
**POST** `/message/sendList/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999",
"listMessage": {
"buttonText": "Ver opções",
"description": "Escolha uma opção abaixo:",
"sections": [
{
"title": "Serviços",
"rows": [
{"rowId": "1", "title": "Agendar consulta"},
{"rowId": "2", "title": "Falar com atendente"}
]
}
]
}
}
Verificar se é um número de WhatsApp
**POST** `/client/checkNumber/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999"
}
Alterar Status do Atendimento (Pausa BOT)
**POST** `/chat/changeStatus/{{instance}}`
Parâmetros (body):
{
"number": "5591999999999",
"status": "closed"
}
Integração com o Chat
Base URL:
https://chat.matec.ai/api/v1/accounts/:account_id/
Solicite seu account_id com o suporte da Matec.
Headers obrigatórios
api_access_token: SUA_CHAVE_DE_API
Content-Type: application/json
Solicite o token de API para o suporte da Matec
Respostas Rápidas (Canned Responses)
**GET** `/canned_responses`
Lista todas as respostas rápidas cadastradas para a conta.
**POST** /canned_responses
Cria nova resposta rápida
Body
{
"content": "string",
"short_code": "string"
}
Atribuir Conversa (Conversation Assignment)
**POST** `/conversations/:id/assignments`
Atribui conversa a um agente
Body:
{
"assignee_id": 123
}
Etiquetas da Conversa (Conversation Labels)
**POST** `/conversations/:id/labels`
Body:
{
"labels": ["prioridade", "vip"]
}
Atributos Personalizados (Custom Attributes)
**PATCH** `/conversations/:id/custom_attributes`
Body:
{
"cpf": "12345678900",
"plano": "premium"
}
Mensagens (Messages)
**POST** `/api/v1/accounts/:account_id/conversations/:conversation_id/messages`
Body:
{
"content": "Olá! Como posso ajudar?",
"message_type": "outgoing"
}
Dúvidas? Entre em contato com o suporte da Matec.ia. 💬