Start Conversation

O evento Start Conversation é utilizado para iniciar a sessão ou conversa, é um evento obrigatório.

O JSON a seguir é um exemplo do evento:

{
    "start_conversation": {
        "session_id": "{session_id}",
        "tenant_id": "6e2ff6a7-d940-4100-b58d-9df8e35f6f91",
        "project_id": "a0d814e2-0166-4e5e-a816-f42bdfe4e51f",
        "channel": "whatsapp",
        "version": "v1.5",
        "session_data": {
            "key1": "value1"
        },
        "context": {
            "identifiers": {
                "phone_number": "222",
                "email": "222@example.com"
            },
            "data": {
                "context_key": "context_value"
            }
        }
    }
}

Os dados obrigatórios são:

• session_id - é um identificador único de sessão no formato UUID (por exemplo: f47ac10b-58cc-4372-a567-0e02b2c3d479);
• tenant_id - é um identificador do tenant;
• project_id - é um identificador do projeto;
• channel - indica o canal;
• version - versão do projeto.

O tenant_id e project_id são fornecidos pela plataforma, enquanto que os outros dados são gerados ou fornecidos pelo cliente.

Os seguintes dados são opcionais:

• session_data - dados da sessão, detalhes a seguir;
• context - dados de contexto.

Existe a possibilidade de associar dados a uma sessão, que possui o tempo de vida somente durante a conversa. A outra possibilidade é colocar dados num contexto que existirá além da conversa e pode ser acessível entre futuras conversas.

Os dados na sessão seguem o formato chave/valor dentro do atributo session_data. Pode ser qualquer chave/valor para os dados da sessão e que durarão somente na conversa.

Ao definir um contexto, é obrigatório definir os identificadores e, no momento, são aceitos: phone_number, email, cpf, cnpj e user_id. Eles são definidos no atributo context/identifiers.

Além dos identificadores, é possível adicionar informações complementares a um contexto no formato chave/valor no atributo context/data.