📱 Omnichat API

API completa para gestão de atendimento omnichannel, conversas e mensagens em múltiplos canais.

Introdução

O módulo Omnichat permite integrar e gerenciar todos os seus canais de atendimento através de uma API unificada. Com ela, você pode:

• Enviar e receber mensagens em tempo real
• Gerenciar conversas com clientes
• Configurar múltiplos canais de atendimento
• Criar mensagens rápidas e respostas automáticas
• Atribuir conversas a agentes específicos
• Organizar conversas com tags e etiquetas

Canais Suportados

Recursos Principais

Canais da Empresa

Gerencie os canais de atendimento configurados na sua empresa. Cada canal representa uma conexão com uma plataforma (WhatsApp, Instagram, etc).

curl -X GET \
  'https://api.atys.pro/v1/company-channels' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json'

{
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "WhatsApp Suporte",
      "channel_type_id": 1,
      "channel_type": {
        "id": 1,
        "name": "WhatsApp"
      },
      "status": "active",
      "phone": "+5511999999999",
      "is_official": true,
      "created_at": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "per_page": 15
  }
}

Conversas (Contact Channels)

As conversas representam interações com contatos em diferentes canais. Aqui você pode listar, criar, atualizar e gerenciar conversas.

const response = await fetch(
  'https://api.atys.pro/v1/assign-contact-channel',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      contact_channel_id: 123,
      user_id: 5
    })
  }
);

const data = await response.json();

Mensagens

Envie e receba mensagens em qualquer canal. Suporta texto, imagens, vídeos, áudios e documentos.

const response = await fetch(
  'https://api.atys.pro/v1/send-message',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      contact_channel_id: 123,
      message_type_id: 1, // text
      content: 'Olá! Como posso ajudar?',
      metadata: {
        reply_to_id: null,
        mentions: []
      }
    })
  }
);

const data = await response.json();
console.log('Mensagem enviada:', data.data.id);

// 1. Primeiro fazer upload do arquivo
const formData = new FormData();
formData.append('file', imageFile);

const uploadResponse = await fetch(
  'https://api.atys.pro/v1/message-files',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: formData
  }
);

const fileData = await uploadResponse.json();

// 2. Enviar mensagem com o arquivo
const messageResponse = await fetch(
  'https://api.atys.pro/v1/send-message',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'Bearer YOUR_API_KEY'
    },
    body: JSON.stringify({
      contact_channel_id: 123,
      message_type_id: 2, // image
      content: 'Confira esta imagem',
      message_file_id: fileData.data.id
    })
  }
);

Mensagens Rápidas

Crie e gerencie mensagens pré-definidas para respostas rápidas. Útil para perguntas frequentes.

WhatsApp

Gerencie conexões do WhatsApp (oficial e não oficial), gere QR codes e importe contatos.

Minichat

Configure widgets de chat web para seu site.

Telegram

Integre bots do Telegram com a plataforma.

Webhooks Disponíveis

Receba notificações em tempo real de eventos do Omnichat:

• omnichat.message.received - Nova mensagem recebida
• omnichat.message.sent - Mensagem enviada com sucesso
• omnichat.conversation.created - Nova conversa criada
• omnichat.conversation.assigned - Conversa atribuída a agente
• omnichat.conversation.closed - Conversa encerrada
• omnichat.agent.status_changed - Status de agente alterado

Ver documentação de Webhooks →

Limites de Taxa

A API do Omnichat tem os seguintes limites: