Ver .md

channel_connections.test_status

Ver se o número já recebeu uma mensagem para o teste. A conversa mais recente deste número com a janela de 24 h aberta (quem escreveu por último), para o passo "Teste a conexão": received diz se já chegou mensagem, com conversationId para responder por inbox.send, o telefone e quando a janela fecha. Só número da API oficial.

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

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
JSON Schema
{
  "$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.test_status \
  -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.test_status --json '{"channelId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta channel_connections_test_status com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "received": {
      "type": "boolean"
    },
    "conversationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "phone": {
      "type": [
        "string",
        "null"
      ]
    },
    "windowExpiresAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "received",
    "conversationId",
    "phone",
    "windowExpiresAt"
  ],
  "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).

channel_connections.test_status · Atomiks API