inbox.scheduled_list

Listar mensagens agendadas de uma conversa. Agendadas da conversa, da mais próxima à mais distante, com status (scheduled, sending, sent, failed, cancelled), error, errorKind, resumo, autor (createdByName) e mensagem citada (replyTo). Falhas dispensadas (inbox.scheduled_dismiss) não voltam. Até 100.

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

Entrada

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

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.scheduled_list --json '{"conversationId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta inbox_scheduled_list 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",
            "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)$"
          },
          "scheduledAt": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "scheduled",
              "sending",
              "sent",
              "failed",
              "cancelled"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          },
          "contents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "text",
                    "upload"
                  ]
                },
                "text": {
                  "type": "string"
                },
                "caption": {
                  "type": "string"
                },
                "uploadId": {
                  "type": "string"
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            }
          },
          "summary": {
            "type": "string"
          },
          "replyToMessageId": {
            "type": [
              "string",
              "null"
            ]
          },
          "sentMessageIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "createdBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdByName": {
            "type": [
              "string",
              "null"
            ]
          },
          "replyTo": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "body": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "body",
                  "type"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "errorKind": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "window_closed",
                  "uncertain",
                  "rejected",
                  "other"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "scheduledAt",
          "timezone",
          "status",
          "error",
          "contents",
          "summary",
          "replyToMessageId",
          "sentMessageIds",
          "createdBy",
          "createdByName",
          "replyTo",
          "errorKind"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).