channels.list

Listar canais de WhatsApp. Números de WhatsApp conectados à conta atual que o membro pode usar, com estado e hora do último webhook recebido.

• Endpoint: POST https://app.atomiks.com.br/api/v1/channels.list (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: channels:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: channels_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channels.list)

Entrada

Sem campos: envie {}.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channels.list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs channels.list --json '{}'

MCP: ferramenta channels_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "kind": {
        "type": "string"
      },
      "connectionType": {
        "type": "string",
        "enum": [
          "coexistence",
          "new_number",
          "qr",
          "instagram_login",
          "unified_login"
        ]
      },
      "status": {
        "type": "string",
        "enum": [
          "connecting",
          "syncing",
          "ready",
          "failed",
          "disconnected"
        ]
      },
      "displayPhone": {
        "type": [
          "string",
          "null"
        ]
      },
      "verifiedName": {
        "type": [
          "string",
          "null"
        ]
      },
      "lastWebhookAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "humanAgent": {
        "type": "boolean"
      },
      "receiveGroups": {
        "type": "boolean"
      },
      "alwaysOnline": {
        "type": "boolean"
      },
      "provider": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "evolution",
              "waha"
            ]
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "required": [
      "id",
      "kind",
      "connectionType",
      "status",
      "displayPhone",
      "verifiedName",
      "lastWebhookAt",
      "humanAgent",
      "receiveGroups",
      "alwaysOnline",
      "provider"
    ],
    "additionalProperties": false
  }
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).