Ver .md

contacts.outbound_messages

Mensagens enviadas ao contato. Aba Histórico de Conversas: mensagens que saíram para o contato em todas as conversas dele (mais recentes primeiro). channel filtra pelo tipo do canal. source: bulk (envio em massa), flow (automação), automation (automação do Instagram) ou manual (atendente, API ou celular). Paginação: before = nextBefore da resposta anterior.

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

Entrada

CampoTipoObrigatórioNota
contactIdstring (uuid)sim
channel"whatsapp_cloud" | "whatsapp_web" | "instagram"não
beforestring (date-time)não
limitintegernão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "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)$"
    },
    "channel": {
      "type": "string",
      "enum": [
        "whatsapp_cloud",
        "whatsapp_web",
        "instagram"
      ]
    },
    "before": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "contactId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs contacts.outbound_messages --json '{"contactId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta contacts_outbound_messages com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "conversationId": {
            "type": "string"
          },
          "channel": {
            "type": "string",
            "enum": [
              "whatsapp_cloud",
              "whatsapp_web",
              "instagram"
            ]
          },
          "kind": {
            "type": "string"
          },
          "preview": {
            "type": [
              "string",
              "null"
            ]
          },
          "sentAt": {
            "type": "string"
          },
          "status": {
            "type": [
              "string",
              "null"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "manual",
              "flow",
              "bulk",
              "automation"
            ]
          }
        },
        "required": [
          "id",
          "conversationId",
          "channel",
          "kind",
          "preview",
          "sentAt",
          "status",
          "source"
        ],
        "additionalProperties": false
      }
    },
    "nextBefore": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "items",
    "nextBefore"
  ],
  "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).