Utilizando dados do contato

Macros são uma forma de utilizar dados do contato que fala com você naquele determinado momento. Com eles, você pode ter acesso ao nome, variáveis, dentre outros atributos do contato de forma super simples. Atualmente possuímos dois macros:

• Contato, que representa o usuário que está dentro do fluxo naquele determinado momento, sendo identificado por @User

• Canal, que representa o canal da Suri pelo qual aquele contato está falando no momento, identificado por @Channel

Como exemplo podemos pegar o nome de um contato e uma variável capturada anteriormente e utilizar como parte do texto a ser enviado pela Suri. Suponha a seguinte frase:

Certo, <Primeiro nome do contato>! É uma honra ter a <Nome da empresa> como parceira!

Considerando que "Nome da empresa" foi capturada na variável de nome NomeEmpresa, podemos substituir a frase por:

Certo, @User.FirstName! É uma honra ter a @User.Variables.NomeEmpresa como parceira!

Da mesma forma, para utilizar algum dado único do Canal, basta utilizar @Channel seguido do atributo desejado. Por exemplo, para usar o telefone vinculado a uma canal do tipo WhatsApp, podemos adicionar @Channel.Username a qualquer frase ou campo de ação do fluxo.

Resumindo, com os macros, a Suri consegue entender que você deseja utilizar um dado do contato ou canal naquela frase e faz a substituição corretamente. Legal né? Segue abaixo todas as possibilidades de macro existentes até o momento e o significado de cada um deles:

// Contato - @User
{
    id: string; // Id único do contato
    Name: string; // Nome completo do contato (pode ser null caso não esteja definido)
    FirstName: string; // Primeiro nome do contato (pode ser null caso Name não esteja definido)
    LastName: string; // Último nome do contato (pode ser null caso Name não esteja definido ou não seja um nome com mais de uma palavra)
    Phone: string; // Telefone do contato (pode ser null caso não esteja definido)
    Email: string; // E-mail do contato (pode ser null caso não esteja definido)
    IdentificationDocument: string; // Documento de identificação (pode ser null caso não esteja definido)
    Note: string; // Observações adicionadas no contato via Portal de atendimento ou API (pode ser null caso não esteja definido)
    DateCreate: string; // Data de criação do contato no formato ISO
    Variables: { [key: string]: string }; // Objeto de variáveis do contato, capturadas via Flow ou inseridas via API
    ChatbotId: string; // Id do chatbot
    ChannelId: string; // Id do canal atrelado ao contato
    ChannelType: number; // Messenger = 0, WhatsApp = 1, WebChat = 2, Instagram = 3
    CampaignOptOut: boolean; // Se contato foi configurado para não receber campanhas do chatbot
    Blocked: boolean; // Se contato está bloqueado
}

// Canal - @Channel
{
    id: string; // Id único do canal
    ChatbotId: string; // Id do chatbot
    Name: string; // Nome do canal (é o mesmo nome informado na plataforma Suri)
    Username: string; // Para canais WhatsApp, é o telefone vinculado ao WhatsApp; Para canais Meta (Messenger/Inatagram), é o ID do usuário Meta; Para Webchat, sempre é null
    Type: number; // Tipo do canal. Messenger = 0, WhatsApp = 1, WebChat = 2, Instagram = 3
    Provider: number; // Provedor do canal. Suri = 0, TalkJs = 4, Gupshup = 5, Z-API = 6, Suri = 7
    MessengerChannelId: string; // Em caso de canal Instagram, é o Id do canal Messenger à qual a conta do Instagram está vinculada; caso contrário, é null
}

Para utilizar uma variável capturada no Flow ou criada via API, você deve utilizar o macro da seguinte maneira: @User.Variables.nomeDaVariavel, substituindonomeDaVariavelpelo nome dado à variável no momento da captura/registro. Lembre-se que ela é Case-sensitive!