Carregando...

Controle de Mensagens

Controle de Mensagens

As integrações desse grupo permitem criar, editar ou listar as mensagens presentes na plataforma.

 

15.05 - Criação de Mensagem

 

Utilize essa integração para criar uma mensagem na plataforma. Nesse caso é necessário que a mensagem esteja em HTML.

XML de Envio:

<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>
*Itens em negrito são obrigatórios.

HTML: A mensagem html deve ter os caracteres "<", ">", " " e "&" substituídos por "&lt;", " &gt; ", "&quot;" e "&amp;" respectivamente. O código HTML deve ser inserido dentro de um CDATA.

Você pode utilizar o link abaixo para efetuar as substituições:

(https://www.web2generators.com/html-based-tools/online-html-entities-encoder-and-decoder)

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 (altera o idioma dos links adicionais como, por exemplo, o link de opt-out):

  •   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 que a mesma está vinculada. Caso a mensagem tenha sido atualiza em uma ou mais ações, o XML de retorno exibi o nome dessas ações.

  1.  A ação não pode estar excluída;
  2. Se for uma Ação Recorrente, a atualização será na principal (ou seja, a ação PAI);
  3. Se for uma Ação Transacional, a atualização é dada quando o status for ENVIADA;

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 listar as 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>
*Itens em negrito são obrigatórios.

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 de uma determinada mensagem como, por exemplo, data de criação, os links adicionais ou links inseridos, o HTML, entre outros.

XML  de Envio:

<main>
  <emkt trans="15.55">
    <titulo>[TITULO DA MENSAGEM]</titulo>
  </emkt>
</main>
*Itens em negrito são obrigatórios.

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>
Este conteúdo foi útil?30