inbox.favorites_list

Listar mensagens favoritas. Favoritas do usuário, da mais recente favoritada à mais antiga (até 100), de uma conversa (conversationId) ou de todas. q filtra pelo texto.

• Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.favorites_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_favorites_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.favorites_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)$"
    },
    "q": {
      "type": "string",
      "maxLength": 80
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.favorites_list --json '{}'

MCP: ferramenta inbox_favorites_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"
          },
          "conversationId": {
            "type": "string"
          },
          "direction": {
            "type": "string",
            "enum": [
              "inbound",
              "outbound",
              "outbound_echo",
              "internal",
              "system"
            ]
          },
          "source": {
            "type": "string",
            "enum": [
              "live",
              "history"
            ]
          },
          "type": {
            "type": "string"
          },
          "body": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": [
              "string",
              "null"
            ]
          },
          "errorMessage": {
            "type": [
              "string",
              "null"
            ]
          },
          "metaTimestamp": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "sentBy": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "name": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "id",
                  "name"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "media": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "mimeType": {
                    "type": "string"
                  },
                  "filename": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "sizeBytes": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "state": {
                    "type": "string",
                    "enum": [
                      "pending",
                      "available",
                      "failed",
                      "expired"
                    ]
                  }
                },
                "required": [
                  "id",
                  "mimeType",
                  "filename",
                  "sizeBytes",
                  "state"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "payload": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "replyTo": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "body": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "type": {
                    "type": "string"
                  },
                  "senderName": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "required": [
                  "id",
                  "body",
                  "type",
                  "senderName"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "reactions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "emoji": {
                  "type": "string"
                },
                "mine": {
                  "type": "boolean"
                },
                "fromContact": {
                  "type": "boolean"
                }
              },
              "required": [
                "emoji",
                "mine",
                "fromContact"
              ],
              "additionalProperties": false
            }
          },
          "isFavorited": {
            "type": "boolean"
          },
          "parentNoteId": {
            "type": [
              "string",
              "null"
            ]
          },
          "edited": {
            "type": "boolean"
          },
          "deleted": {
            "type": "boolean"
          },
          "editedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "deletedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "clientRequestId": {
            "type": [
              "string",
              "null"
            ]
          },
          "scheduled": {
            "type": "boolean"
          },
          "senderName": {
            "type": [
              "string",
              "null"
            ]
          },
          "senderJid": {
            "type": [
              "string",
              "null"
            ]
          },
          "meta": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "rawType": {
            "type": [
              "string",
              "null"
            ]
          },
          "origin": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "phone",
                  "automation",
                  "flow"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "originLabel": {
            "type": [
              "string",
              "null"
            ]
          },
          "conversation": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "contact": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "name": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "phone": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "phone"
                    ],
                    "additionalProperties": false
                  },
                  "channel": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "id",
                      "kind"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "id",
                  "contact",
                  "channel"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "conversationId",
          "direction",
          "source",
          "type",
          "body",
          "status",
          "errorMessage",
          "metaTimestamp",
          "createdAt",
          "sentBy",
          "media",
          "payload",
          "replyTo",
          "reactions",
          "isFavorited",
          "parentNoteId",
          "edited",
          "deleted",
          "editedAt",
          "deletedAt",
          "senderName",
          "senderJid",
          "conversation"
        ],
        "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).