Listar canais

dev

https://api-dev.messagefy.io

GET

/api/v1/admin/channel

📄 Paginação da Listagem

A listagem de dados é paginada para evitar o carregamento de muitos registros de uma só vez e melhorar a performance da API.

🔢 Regras de Paginação

Por padrão, cada página retorna 10 itens

O parâmetro perPage define a quantidade de itens por página

O valor máximo permitido para perPage é 50 itens

⚠️ Se um valor maior que 50 for informado, o sistema irá limitar automaticamente para 50 itens.

🔧 Parâmetros da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
`page`	number	Não	Número da página que deseja consultar
`perPage`	number	Não	Quantidade de itens por página (máx: 50)
`name`	string	Não	Filtro opcional por nome (busca parcial, case-insensitive)
`channelType`	string	Não	Filtro opcional (whatsapp-web, http-sender)

🔎 O parâmetro name realiza uma busca (parcial, case-insensitive) no backend, não diferencia letras maiúsculas de minúsculas.

📌 Exemplo de Requisição

Requisição

Authorization

Adicionar parâmetro em header

api-key

Exemplo:

api-key: ********************

Parâmetros Header

Respostas

🟢200Sucesso

application/json

Body

🔴500Erro Interno

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api-dev.messagefy.io/api/v1/admin/channel' \
--header 'api-key: <api-key>' \
--header 'Content-Type: application/json'

Response Example

200 - Sucesso

[
  {
    "channelId": "channel-id",
    "feedbackChannelId": null,
    "name": "Suporte webhook",
    "description": "webhook feedback",
    "createdAt": "2026-01-01T00:00:00",
    "account": {
      "accountId": "account-id",
      "name": "ChatGuru",
      "description": "Conta principal do ChatGuru",
      "createdAt": "2026-01-01T00:00:00",
      "status": {
        "accountStatusId": 2,
        "name": "Ativo",
        "icon": null,
        "description": "Pronto para uso",
        "canManageChildObjects": true,
        "canSendAndReceiveMessage": true
      },
      "organization": {
        "organizationId": "organizarion-id",
        "name": "ChatGuru",
        "description": "Organização do ChatGuru",
        "status": {
          "organizationStatusId": 2,
          "name": "Ativo",
          "icon": null,
          "description": "Pronto para uso",
          "canManageChildObjects": true,
          "canSendAndReceiveMessage": true
        }
      }
    },
    "channelType": {
      "channelTypeId": 4,
      "key": "http",
      "name": "HTTP API & WebHook",
      "description": ""
    },
    "status": {
      "channelStatusId": 1,
      "name": "Created",
      "icon": null,
      "description": "Está cadastrado mas não disponível para utilização",
      "canSendAndReceiveMessage": false,
      "canConfigure": false
    },
    "provider": {
      "providerId": "provider-id",
      "key": "http",
      "name": "http",
      "priority": 1
    },
    "parameters": {
      "url": "https://app.chatguru.com.br/api/messagefy/receive"
    },
    "devices": null
  }
]

Modificado em 2026-01-26 18:49:57

Página anterior

Cancelar Mensagem no Outbox do Canal

Próxima página

Buscar por id

Listar canais

📄 Paginação da Listagem#

🔢 Regras de Paginação#