inbox.conversation_get

Ver uma conversa e a origem do lead. Conversa com contato, número de atendimento, janela de 24 h (windowExpiresAt) e a origem completa do lead (origin.kind, referral, ad), na mesma forma de contacts.get.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "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)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta inbox_conversation_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": {
    "id": {
      "type": "string"
    },
    "channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "enum": [
            "whatsapp_cloud",
            "whatsapp_web"
          ]
        },
        "connectionType": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "coexistence",
                "new_number",
                "qr"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "webProvider": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "evolution",
                "waha"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "displayPhone": {
          "type": [
            "string",
            "null"
          ]
        },
        "verifiedName": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "kind",
        "connectionType",
        "displayPhone",
        "verifiedName"
      ],
      "additionalProperties": false
    },
    "contact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "phone": {
          "type": [
            "string",
            "null"
          ]
        },
        "avatarUrl": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "name",
        "phone",
        "avatarUrl"
      ],
      "additionalProperties": false
    },
    "lastMessageAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastMessagePreview": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastMessageSender": {
      "type": [
        "string",
        "null"
      ]
    },
    "windowExpiresAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "unreadCount": {
      "type": "number"
    },
    "unreadByMe": {
      "type": "boolean"
    },
    "origin": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "ad",
            "organic"
          ]
        },
        "referral": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ]
        },
        "ad": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "kind",
        "referral",
        "ad"
      ],
      "additionalProperties": false
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "assigned",
        "resolved",
        "closed"
      ]
    },
    "priority": {
      "type": "string",
      "enum": [
        "low",
        "normal",
        "high",
        "urgent"
      ]
    },
    "assignee": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "name": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "id",
            "name"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "ticket": {
      "type": [
        "string",
        "null"
      ]
    },
    "mutedByMe": {
      "type": "boolean"
    },
    "pinnedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "windowState": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "open",
            "closing",
            "closed"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "isGroup": {
      "type": "boolean"
    },
    "groupSubject": {
      "type": [
        "string",
        "null"
      ]
    },
    "archivedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "blockedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "unreadMentionId": {
      "type": [
        "string",
        "null"
      ]
    },
    "capabilities": {
      "type": "object",
      "properties": {
        "text": {
          "type": "boolean",
          "const": true
        },
        "media": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "image",
              "video",
              "audio",
              "file"
            ]
          }
        },
        "reply": {
          "type": "boolean"
        },
        "reaction": {
          "type": "boolean"
        },
        "deliveryStatus": {
          "type": "boolean"
        },
        "readReceipt": {
          "type": "boolean"
        },
        "windowMs": {
          "type": [
            "number",
            "null"
          ]
        },
        "templates": {
          "type": "boolean"
        },
        "scheduling": {
          "type": "boolean"
        },
        "quickReplies": {
          "type": "boolean"
        }
      },
      "required": [
        "text",
        "media",
        "reply",
        "reaction",
        "deliveryStatus",
        "readReceipt",
        "windowMs",
        "templates",
        "scheduling",
        "quickReplies"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "channel",
    "contact",
    "lastMessageAt",
    "lastMessagePreview",
    "windowExpiresAt",
    "unreadCount",
    "unreadByMe",
    "origin",
    "status",
    "priority",
    "assignee",
    "ticket",
    "mutedByMe",
    "windowState",
    "isGroup",
    "groupSubject",
    "capabilities"
  ],
  "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).