API Reference

opened_session

Evento disparado após abertura de sessão.

Exemplo

{
  "event": "opened_session", // String. Tipo de evento, nesse caso, abertura de sessão.
  "event_ts": "2025-03-14T16:41:53.935332", // String. Timestamp do evento no formato ISO 8601.
  "session_data": {
    "assing_to": "INVALID-ID", // String. ID do usuário ou agente ao qual a sessão está atribuída.
    "autod_user_id": null, // String | null. ID do usuário da distribuição automática, se aplicável.
    "bot_active": null, // Boolean | null. Indica se um bot está ativo na sessão.
    "bot_expires_at": null, // String | null. Timestamp de expiração do bot, se aplicável.
    "close_tag": null, // String | null. Tag associada ao fechamento da sessão, se aplicável.
    "close_ts": null, // String | null. Timestamp do fechamento da sessão, se já foi fechada.
    "count": null, // Integer | null. Quantidade de mensagens não lidas.
    "created_by": "agent", // String. Indica quem criou a sessão ("agent" para sessão criado por agent no sistema ou "customer" se foi criado pelo cliente).
    "date_assign": "2025-03-14T16:41:53.932+01:00", // String. Data/hora da atribuição da sessão a um agente.
    "deleted_at": null, // String | null. Timestamp da exclusão da sessão, se aplicável.
    "department_id": null, // String | null. ID do departamento responsável pela sessão, se houver.
    "expires_at": null, // String | null. Data de expiração da sessão, se configurada.
    "group": false, // Boolean. Indica se a sessão pertence a um grupo.
    "id": "INVALID-UUID-123", // String. ID único da sessão.
    "instance_id": "chatpro-1234567891", // String. ID da instância do sistema de chat.
    "last_from_me": null, // Boolean | null. Indica se a última mensagem foi enviada pelo usuário ou pelo sistema.
    "last_interaction_by": null, // String | null. Última interação na sessão, podendo ser agent ou customer
    "last_message": "Nova sessão criada", // String. Última mensagem trocada na sessão.
    "last_type": "create_session", // String. Tipo do último evento ocorrido na sessão.
    "last_update": "2025-03-14T16:41:53.932+01:00", // String. Timestamp da última atualização da sessão.
    "lead_id": "INVALID-UUID-123", // String. ID do lead (cliente) associado à sessão.
    "nps": null, 
    "nps_grade": 0,
    "open": true, // Boolean. Indica se a sessão está aberta.
    "open_ts": "2025-03-14T16:41:53.932+01:00", // String. Timestamp da abertura da sessão.
    "owner_id": null, // String | null. ID do responsável pela sessão, se houver carteirização.
    "page_id": null, // String | null. ID da página associada à sessão, se aplicável.
    "protocoll": null, // String | null. Número de protocolo da sessão, se houver.
    "provider": "whatsapp", // String. provider utilizado (exemplo: "whatsapp", "instagram", "facebook", "cloud").
    "ura_json": null, // JSON | null. Dados da URA (Unidade de Resposta Audível), se houver.
    "ura_ts": null, // String | null. Timestamp do evento de URA, se aplicável.
    "waiting_nps": false, // Boolean. Indica se a sessão está aguardando resposta do NPS.
    "widget_id": null // String | null. ID do widget associado à sessão, se houver.
  }
}