contacts.bulk_send_get

Andamento de um envio em massa. Quem criou o envio ou um administrador. status: queued (na fila), running, done ou failed. Contagens por item; failures traz até 100 contatos com falha ou pulados e o motivo.

• Endpoint: POST https://app.atomiks.com.br/api/v1/contacts.bulk_send_get (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_bulk_send_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId contacts.bulk_send_get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "jobId": {
      "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": [
    "jobId"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta contacts_bulk_send_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": {
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "done",
        "failed"
      ]
    },
    "total": {
      "type": "number"
    },
    "sent": {
      "type": "number"
    },
    "failed": {
      "type": "number"
    },
    "skipped": {
      "type": "number"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "failures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contactId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "failed",
              "skipped"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "contactId",
          "status",
          "error"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "status",
    "total",
    "sent",
    "failed",
    "skipped",
    "error",
    "failures"
  ],
  "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).