inbox.conversation_start

Iniciar conversa com um contato. Devolve a conversa do contato no número escolhido ou cria uma nova (aberta, sem atendente, no WhatsApp oficial a janela de 24 h começa fechada e a primeira mensagem tem de ser um modelo; no número por QR qualquer mensagem). O contato vem de contactId ou de phone (dígitos com DDI, 10 a 15; +, espaços e traços são ignorados): com phone o contato é achado pelo telefone ou criado agora (name só preenche nome vazio); no número por QR o telefone é conferido no WhatsApp (sem WhatsApp: invalid_input) e vale o telefone canônico dele. Exige acesso ao número e que ele esteja conectado.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "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)$"
    },
    "phone": {
      "type": "string",
      "maxLength": 40
    },
    "name": {
      "type": "string",
      "maxLength": 120
    },
    "channelId": {
      "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": [
    "channelId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs inbox.conversation_start --json '{"contactId":"00000000-0000-0000-0000-000000000000","channelId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta inbox_conversation_start com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

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