Skip to content

Canais

A API de canais permite visualizar os canais de comunicação disponíveis na sua empresa.

Listar Canais

GET https://chat.mehub.app/api/v1/channels

Retorna todos os canais disponíveis na empresa. Retorna apenas canais que o usuário tem permissão de acesso.

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação. Ex: Bearer seu_token

Query Parameters

NomeTipoObrigatórioDescrição
pageintegerNãoNúmero da página. Default: 1
per_pageintegerNãoRegistros por página (máx: 100). Default: 20
typestringNãoFiltrar por tipo: whatsapp, whatsapp_unofficial, instagram, messenger, telegram, widget
statusstringNãoFiltrar por status: connected, disconnected
searchstringNãoBuscar por nome do canal

Exemplo de requisição

bash
curl -X GET "https://chat.mehub.app/api/v1/channels?type=whatsapp&status=connected" \
  -H "Authorization: Bearer SEU_TOKEN"

Response

json
{
  "success": true,
  "data": [
    {
      "token": "abc123def456ghi7",
      "name": "WhatsApp Vendas",
      "type": "whatsapp",
      "status": "connected"
    },
    {
      "token": "xyz789abc123def4",
      "name": "WhatsApp Suporte",
      "type": "whatsapp_unofficial",
      "status": "connected"
    },
    {
      "token": "mno456pqr789stu0",
      "name": "Instagram",
      "type": "instagram",
      "status": "connected"
    },
    {
      "token": "def789ghi012jkl3",
      "name": "Chat do Site",
      "type": "widget",
      "status": "connected"
    }
  ],
  "pagination": {
    "total": 4,
    "per_page": 20,
    "current_page": 1,
    "last_page": 1
  }
}

Campos do Response

CampoTipoDescrição
tokenstringToken único do canal
namestringNome do canal
typestringTipo do canal
statusstringStatus: connected, disconnected

Tipos de Canal

TipoDescrição
whatsappWhatsApp Business API (oficial)
whatsapp_unofficialWhatsApp via conexão não oficial
instagramInstagram Direct
messengerFacebook Messenger
telegramTelegram
widgetWidget de chat para websites

Uso do Token

O token do canal é utilizado em diversas operações:

  • Enviar mensagens: especificando o canal de origem no campo channel
  • Transferir conversas: direcionando para outro canal
  • Vincular usuários: dando acesso a canais específicos
  • Listar templates: filtrando templates por canal