inbox.quick_replies_list

Listar respostas rápidas. Respostas rápidas da conta, por ordem de nome. q filtra por nome ou atalho, sem diferenciar maiúsculas.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 100
    },
    "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)$"
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.quick_replies_list --json '{"q":"ola"}'

MCP: ferramenta inbox_quick_replies_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"
          },
          "name": {
            "type": "string"
          },
          "shortcut": {
            "type": [
              "string",
              "null"
            ]
          },
          "body": {
            "type": "string"
          },
          "uploadId": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": "string"
          },
          "channelKind": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "whatsapp_cloud",
                  "whatsapp_web",
                  "instagram"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "interactive"
            ]
          },
          "contents": {
            "type": "object",
            "properties": {
              "header": {
                "oneOf": [
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "const": "text"
                      },
                      "text": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 60
                      }
                    },
                    "required": [
                      "kind",
                      "text"
                    ],
                    "additionalProperties": false
                  },
                  {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "enum": [
                          "image",
                          "video",
                          "document"
                        ]
                      },
                      "uploadId": {
                        "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)$"
                      },
                      "filename": {
                        "type": "string",
                        "maxLength": 255
                      }
                    },
                    "required": [
                      "kind",
                      "uploadId"
                    ],
                    "additionalProperties": false
                  }
                ]
              },
              "footer": {
                "type": "string",
                "minLength": 1,
                "maxLength": 60
              },
              "buttons": {
                "minItems": 1,
                "maxItems": 3,
                "type": "array",
                "items": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "type": "string",
                          "const": "reply"
                        },
                        "label": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 20
                        }
                      },
                      "required": [
                        "kind",
                        "label"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "object",
                      "properties": {
                        "kind": {
                          "type": "string",
                          "const": "url"
                        },
                        "label": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 20
                        },
                        "url": {
                          "type": "string",
                          "maxLength": 2000,
                          "pattern": "^https:\\/\\/"
                        }
                      },
                      "required": [
                        "kind",
                        "label",
                        "url"
                      ],
                      "additionalProperties": false
                    }
                  ]
                }
              }
            },
            "additionalProperties": false
          },
          "usesVariables": {
            "type": "boolean"
          },
          "sendMode": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "interactive",
                  "numbered_list",
                  "text"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "name",
          "shortcut",
          "body",
          "uploadId",
          "updatedAt",
          "channelKind",
          "type",
          "contents",
          "usesVariables",
          "sendMode"
        ],
        "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).