Como Gerenciar as Mensagens via Integração

3 Minutes to read

Print
Dark
Light
PDF

Como Gerenciar as Mensagens via Integração

3 Minutes to read

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Sobre a função

As integrações deste grupo oferecem funcionalidades para criar, editar e listar as mensagens disponíveis na plataforma. Com essas integrações, você pode facilmente gerenciar o conteúdo das suas mensagens, personalizá-las de acordo com as suas necessidades e visualizar todas as mensagens existentes. Isso permite um controle completo sobre as comunicações realizadas pela plataforma, garantindo que você possa criar e ajustar as mensagens de forma eficiente e eficaz.

15.05 - Criação de Mensagem

Utilize essa integração para criar uma mensagem na plataforma. É importante observar que a mensagem deve ser fornecida em formato HTML.
XML de envio estrutura completa

<main>
  <emkt trans="15.05">
    <nome>[NOME DA MENSAGEM]</nome>
    <categoria>[NOME DA CATEGORIA]</categoria>
    <idioma>[CÓDIGO DO IDIOMA]</idioma>
    <html>[HTML]</html>
    <texto tipo="[P/H/C]">[TEXTO ALTERNATIVO]</texto>
    <alternativa>[MENSAGEM DE VISUALIZAÇÃO ALTERNATIVA]</alternativa>
    <optout>[MENSAGEM DE OPT-OUT]</optout>
    <encaminhar>[MENSAGEM DE ENCAMINHAMENTO]</encaminhar>
    <msg_redes_sociais>[MENSAGEM REDES SOCIAIS]</msg_redes_sociais>
    <redes_sociais>[REDES SOCIAIS]</redes_sociais>
    <link url="[LINK]" tipo="[N/P/A/O/E]">[NOME DO LINK]</link>
    <link url="[LINK]" tipo="[N/P/A/O/E]">[NOME DO LINK]</link>
        <atualizar_acoes>S</atualizar_acoes>
    (...)
  </emkt>
</main>

HTML: A mensagem HTML deve ter os caracteres "<", ">", " " e "&" substituídos por "<", ">", """ e "&" respectivamente. Além disso, o código HTML deve ser inserido dentro de uma seção CDATA para garantir a correta interpretação dos caracteres especiais.

Para facilitar as substituições necessárias, você pode utilizar o link abaixo:
(https://www.web2generators.com/html-based-tools/online-html-entities-encoder-and-decoder)
Essa ferramenta irá ajudá-lo a realizar as substituições corretas para que o código HTML seja interpretado adequadamente pela plataforma. Certifique-se de realizar essas substituições antes de inserir o código HTML na integração.
Segue um exemplo de como deve ficar o HTML:

<![CDATA[&lt;HTML&gt; &lt;HEAD&gt;&lt;/HEAD&gt; &lt;BODY&gt;TESTE&lt;/BODY&gt; &lt;/HTML&gt;]]>

Categoria: É a área de interesse da mensagem.

Idioma: Essa configuração permite definir o idioma dos links adicionais na mensagem, como por exemplo, o link de opt-out (cancelamento de assinatura). Ao selecionar o idioma desejado, os links serão exibidos no idioma correspondente para melhorar a experiência do destinatário.

pt-br => Português, valor padrão caso não seja enviado o idioma
en => Inglês
es => Espanhol
Texto - Tipo:
P - Texto padrão do sistema.
H - HTML da mensagem em formato texto.
C - Texto customizado pelo cliente.

Link - Tipo:

  N – Normal.
  P – Alteração de dados cadastrais.
  A – Visualização alternativa.
  O – Solicitação de OptOut.
  E – Encaminhamento de mensagem.

Link - Monitorar:

Quando link - Tipo for igual a “N” (normal), podemos opcionalmente monitorá-lo. Informar os códigos de monitoramento separados por “|”, conforme lista abaixo:

WA - Web Analytics
GA - Google Analytics

Exemplos:

<link url="[LINK]" tipo="N” monitorar=“GA”>[NOME DO LINK]</link>
<link url="[LINK]" tipo="N” monitorar=“GA|WA”>[NOME DO LINK]</link>

Redes sociais, enviar os códigos das redes desejadas separados por vírgula, segue abaixo lista de redes disponíveis.

DLC => Delicious
DIG => Digg
FCB => Facebook
FSQ => Fresqui
GBM => Google Bookmarks
MNM => Menéame
MYY => My Yahoo
MYS => Myspace
ORK => Orkut
TWT => Twitter
WLV => Windows Live

Atualizar Ações: Esse parâmetro tem como objetivo atualizar a mensagem nas ações em que ela está vinculada. Caso a mensagem seja atualizada em uma ou mais ações, o XML de retorno exibirá o nome dessas ações.

A ação não pode estar excluída.
Se for uma Ação Recorrente, a atualização será feita na ação principal (ou seja, na ação pai).
Se for uma Ação Transacional, a atualização ocorrerá quando o status for ENVIADA.

XML de envio estrutura básica

<main>
  <emkt trans="15.05">
    <nome>[NOME DA MENSAGEM]</nome>
    <html>[HTML]</html>
   </emkt>
</main>

XML de retorno utilizando a atualização

<?xml version="1.0" encoding="UTF-8"?>
<MAIN>
    <EMKT TRANS="15.05" KEY="07d0011387c37884c03518276667">
        <RETURN ID="00">Ok</RETURN>
        <CAMPANHAS_ATUALIZADAS>
            ...
            <CAMPANHA CODIGO="Código da Ação">Título da Ação</CAMPANHA>
            <CAMPANHA CODIGO="Código da Ação">Título da Ação</CAMPANHA>
            ...
        </CAMPANHAS_ATUALIZADAS>
    </EMKT>
</MAIN>

XML de Retorno sem atualização

<main>
  <emkt trans="15.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </emkt>
</main>

XML de retorno

<main>
  <func trans="01.15" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
  </func>
</main>

15.50 - Lista as Mensagens Cadastradas

Utilize essa integração para obter a lista das mensagens cadastradas na plataforma.

XML de envio

<main>
  <emkt trans="15.50">
    <data_inicial>AAAA-MM-DD</data_inicial>
    <data_final> AAAA-MM-DD</data_final>
  </emkt>
</main>

XML de retorno

<main>
  <emkt trans="15.50" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <mensagem>
      <titulo>[TITULO DA MENSAGEM]</titulo>
      <data>AAAA-MM-DD</data>
    </mensagem>
  </emkt>
</main>

15.55 - Informações da Mensagem

Utilize essa integração para recuperar informações detalhadas de uma determinada mensagem, como a data de criação, os links adicionais ou links inseridos, o código HTML e outros dados relevantes. Isso permite obter informações específicas sobre a mensagem desejada.

XML de envio

<main>
  <emkt trans="15.55">
    <titulo>[TITULO DA MENSAGEM]</titulo>
  </emkt>
</main>

XML de retorno

<main>
 <emkt trans="15.55" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
  <mensagem>
   <titulo>[TITULO DA MENSAGEM]</titulo>
    <data>AAAA-MM-DD</data>
    <html>[CONTEUDO DA MENSAGEM]</html>
    <texto_alternativo>[TEXTO ALTERNATIVO]</texto_alternativo>
    <texto_optout>[MENSAGEM DE OPTOUT]</texto_optout>
    <texto_visalternativa>[MENSAGEM DE VISUALIZACAO ALTERNATIVA]</texto_visalternativa>
    <texto_encaminhamento>[MENSAGEM DE ENCAMINHAMENTO]</texto_encaminhamento>
    <texto_altcadastro>[MENSAGEM DE ALTERAÇÃO DE CADASTRO]</texto_altcadastro>
    <anexo>[NOME DO ARQUIVO]</anexo>
    <anexo>(...)</anexo>
    <link MONITORADO="[S/N]" OPTOUT="[S/N]" VISALTERNATIVA="[S/N]" 
ENCAMINHAR="[S/N]" ALTCADASTRO="[S/N]">
     <titulo>[TITULO DO LINK]</titulo>
     <url>[URL DO LINK]</url>
    </link>
    <link>
     (...)
    </link>
  </mensagem>
 </emkt>
</main>

Was this article helpful?

What's Next

Como Gerenciar as Ações via Integração

Table of contents

Sobre a função