channel_connections.get

Ver uma conta conectada de WhatsApp ou Instagram. O mesmo item de channel_connections.list para uma conta só (GET /channel-instances/{id}). not_found se a conta não existe, foi desconectada ou o membro não pode usá-la.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "channelId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channel_connections.get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs channel_connections.get --json '{"channelId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta channel_connections_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "channel": {
      "type": "string",
      "enum": [
        "whatsapp",
        "whatsapp_unofficial",
        "instagram"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "connecting",
        "live",
        "error"
      ]
    },
    "syncing": {
      "type": "boolean"
    },
    "stableKey": {
      "type": "string"
    },
    "displayName": {
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "type": [
        "string",
        "null"
      ]
    },
    "wabaId": {
      "type": [
        "string",
        "null"
      ]
    },
    "numberStatus": {
      "type": [
        "string",
        "null"
      ]
    },
    "businessVerified": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "qualityRating": {
      "type": [
        "string",
        "null"
      ]
    },
    "messagingLimitTier": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestedNameStatus": {
      "type": [
        "string",
        "null"
      ]
    },
    "instagramName": {
      "type": [
        "string",
        "null"
      ]
    },
    "instagramUsername": {
      "type": [
        "string",
        "null"
      ]
    },
    "instagramBio": {
      "type": [
        "string",
        "null"
      ]
    },
    "instagramWebsite": {
      "type": [
        "string",
        "null"
      ]
    },
    "instagramFollowersCount": {
      "type": [
        "number",
        "null"
      ]
    },
    "instagramFollowsCount": {
      "type": [
        "number",
        "null"
      ]
    },
    "instagramMediaCount": {
      "type": [
        "number",
        "null"
      ]
    },
    "instagramAccountType": {
      "type": [
        "string",
        "null"
      ]
    },
    "profilePhotoUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "usagePermissions": {
      "type": "object",
      "properties": {
        "liveChat": {
          "type": "boolean"
        },
        "automations": {
          "type": "boolean"
        },
        "broadcast": {
          "type": "boolean"
        }
      },
      "required": [
        "liveChat",
        "automations",
        "broadcast"
      ],
      "additionalProperties": false
    },
    "connectionType": {
      "type": "string"
    },
    "humanAgent": {
      "type": "boolean"
    },
    "receiveGroups": {
      "type": "boolean"
    },
    "alwaysOnline": {
      "type": "boolean"
    },
    "providerUpdateAvailable": {
      "type": "boolean"
    },
    "lastWebhookAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "syncedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "archivedAt": {
      "type": "null"
    },
    "createdAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "channel",
    "status",
    "syncing",
    "stableKey",
    "displayName",
    "phone",
    "wabaId",
    "numberStatus",
    "businessVerified",
    "qualityRating",
    "messagingLimitTier",
    "requestedNameStatus",
    "instagramName",
    "instagramUsername",
    "instagramBio",
    "instagramWebsite",
    "instagramFollowersCount",
    "instagramFollowsCount",
    "instagramMediaCount",
    "instagramAccountType",
    "profilePhotoUrl",
    "usagePermissions",
    "connectionType",
    "humanAgent",
    "receiveGroups",
    "alwaysOnline",
    "providerUpdateAvailable",
    "lastWebhookAt",
    "syncedAt",
    "archivedAt",
    "createdAt"
  ],
  "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).