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

16 Minutes to read

Print
Dark
Light
PDF

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

16 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 fornecem recursos para lidar com ações, incluindo o gerenciamento de listas, criação de ações pontuais e transacionais, adição de contatos a ações pontuais e transacionais, agendamento de ações pontuais, envio de testes e obtenção de estatísticas das ações. Essas integrações permitem um controle abrangente sobre os recursos relacionados às ações em sua plataforma.

19.03 – Retorna o Nome das Ações Transacionais do Sistema

Utilize essa integração para listar as ações transacionais presentes na plataforma.

XML de envio

<main>
     <emkt trans="19.03">
     </emkt>
</main>

XML de retorno

<main>
     <emkt trans=“19.03” key= “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”>
        <ACAO ID=“[ID]”> [NOME_DA_ACAO_TRANSACIONAL]</ACAO> 
        <ACAO ID=“[ID]”> [NOME_DA_ACAO_TRANSACIONAL]</ACAO> 
        <ACAO ID=“[ID]”> [NOME_DA_ACAO_TRANSACIONAL]</ACAO>    
        (...)   
     </emkt>
</main>

ID: Número Identificador da ação Transacional.

19.04 - Inclusão de Ação Transacional

Uma ação transacional é um tipo de ação que é acionada sob demanda, ou seja, ela não está vinculada a uma lista específica e é disparada quando um contato é recebido. Utilize essa integração para criar esse tipo de ação na plataforma. Para adicionar contatos a essa ação, utilize a integração 20.05 deste documento.

XML de envio estrutura completa

Mensagem: Caso for utilizar uma URL o atributo deve ser indicado como TRUE. Segue exemplo abaixo do formato:

**<main>**
  <emkt trans="19.04">
    <nome>[NOME DA ACAO]</nome>
    <mensagem url="true"><![CDATA[ URL ]]></mensagem>
    <usuario>[E-MAIL USUARIO]</usuario>
    <opcao>
    	<idioma>[pt-br/es/en]</idioma>
    	<area_interesse>[ÁREA DE INTERESSE]</area_interesse>
    	<marca_envio>[ENVIAR SOMENTE QUANDO A MENSAGEM CONTIVER]</marca_envio>
    </opcao>
    <nome_remetente>[NOME DO REMETENTE]</nome_remetente>
    <email_remetente>[EMAIL DO REMETENTE]</email_remetente>
    <email_retorno>[EMAIL PARA RETORNO]</email_retorno>
    <assunto>[ASSUNTO]</assunto>
    <remocao tipo="SO/SC/CC" areainteresse="S/N" motivo="S/N" />
  </emkt>
</main>

Atenção

Quando utilizar URL o campo MARCA_ENVIO é obrigatório.

Usuário: Este campo contém o e-mail do usuário a quem pertence à ação.

Nome/E-mail do Remetente: É o nome e endereço de e-mail exibidos como remetente da ação.

E-mail de retorno: É o endereço de e-mail que aparece quando o contato clica em responder.

E-mail de término: É o endereço de e-mail ou lista de endereços de e-mails separados por ';' (ponto e vírgula) que informarão sobre o término da ação.

Remoção: Possui três atributos no campo tipo:

Sem Opt-out (SO): Envia mesmo para contatos com o status de opt-out e não exibe o link para solicitação de remoção .
Sem Confirmação (SC): Realiza opt-out direto após o clique no link.
Com Confirmação (CC): É necessário confirmar o pedido de opt-out após o clique no link.

Para habilitar a área de interesse ou motivo de remoção na solicitação de opt-out é obrigatório o tipo estar com o valor (CC).
areainteresse: Solicita a área de interesse no pedido de remoção.
motivo: Solicita que o contato informe o motivo do pedido de remoção.

XML de envio estrutura básica

<main>
  <emkt trans="19.04">
    <nome>[NOME DA ACAO]</nome>
    <mensagem url="true">[NOME OU LINK DA MENSAGEM]</mensagem>
    <nome_remetente>[NOME DO REMETENTE]</nome_remetente>
    <email_remetente>[EMAIL DO REMETENTE]</email_remetente>
    <email_retorno>[EMAIL PARA RETORNO]</email_retorno>
    <assunto>[ASSUNTO]</assunto>
  </emkt>
</main>

XML de retorno

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

19.05 - Inclusão de uma Ação Pontual

Utilize essa integração para criar uma ação do tipo pontual. Você poderá escolher entre apenas criar a ação ou criar e agendar. Se optar por agendar o envio, será obrigatório à inclusão da lista também.

Atenção

Use a ação pontual apenas se ela for única. Se essa ação se repetir com frequência utilize a ação transacional. Integração 20.05 desse grupo de integrações.

XML de envio estrutura completa

<main>
  <emkt trans="19.05">
    <nome>[NOME DA ACAO]</nome>
    <mensagem url="true">[NOME OU LINK DA MENSAGEM]</mensagem>
    <usuario>[E-MAIL USUARIO]</usuario>
    <opcao>
    	<idioma>[SIGLA DO IDIOMA]</idioma>
    	<area_interesse>[ÁREA DE INTERESSE]</area_interesse>
    	<marca_envio>[ENVIAR SOMENTE QUANDO A MENSAGEM CONTIVER]</marca_envio>
    </opcao>
    <data_encerramento>[AAAA-MM-DD]</data_encerramento>
    <nome_remetente>[NOME DO REMETENTE]</nome_remetente>
    <email_remetente>[EMAIL DO REMETENTE]</email_remetente>
    <email_retorno>[EMAIL PARA RETORNO]</email_retorno>
    <assunto>[ASSUNTO]</assunto>
    <email_termino>[EMAIL DE TERMINO]</email_termino>
    <solicita_motivo>[S/N]</solicita_motivo>
    <lista>[NOME DA LISTA]</lista>
    <lista>[NOME DA LISTA]</lista>
    (...)
    <filtro type="avancado">
      <grupo tipo="[E/OU]">
	<regra campo="[CAMPO]" operador="[TIPO_DE_OPERADOR]" valor1="[VALOR1]" valor2="[VALOR2]" />
      </grupo>
    </filtro>
    <agendar>
      <datahora>YYYY-MM-DD HH:MM:SS</datahora>
    </agendar>
  </emkt>
</main>

XML de envio estrutura básica

<main>
  <emkt trans="19.05">
    <nome>[NOME DA ACAO]</nome>
    <mensagem url="true">[NOME OU LINK DA MENSAGEM]</mensagem>
    <data_encerramento>[AAAA-MM-DD]</data_encerramento>
    <nome_remetente>[NOME DO REMETENTE]</nome_remetente>
    <email_remetente>[EMAIL DO REMETENTE]</email_remetente>
    <email_retorno>[EMAIL PARA RETORNO]</email_retorno>
    <assunto>[ASSUNTO]</assunto>
  </emkt>
</main>

Mensagem: Caso for utilizar uma URL o atributo deve ser indicado como TRUE. Segue exemplo abaixo do formato:

<mensagem url="true"><![CDATA[ URL ]]></mensagem>

Atenção

Quando utilizar URL o campo MARCA_ENVIO é obrigatório.

Usuário: Este campo contém o e-mail do usuário a quem pertence à ação.
Data de Encerramento: É a data limite que o sistema vai contabilizar as informações (visualização, cliques, opt-out, etc.) nas estatísticas da ação. O período pode ser de cinco dias a seis meses após a data de envio.
Nome/E-mail do Remetente: É o nome e endereço de e-mail exibidos como remetentes da ação.
E-mail de retorno: É o endereço de e-mail que aparece quando o contato clica em responder.
E-mail de término: É o endereço de e-mail ou lista de endereços de e-mails separados por ';' (ponto e vírgula) que informarão sobre o término da ação.
Solicita Motivo: Informa se deve solicitar o motivo de remoção no momento que o contato faz o opt-out.
Filtro: Para montar um filtro é preciso passar pelo menos um grupo com o seu tipo de operador e uma regra que deverá conter: campo, operador e valor(es). Para lógicas mais precisas, pode ser adicionado um grupo dentro de outro.
Os atributos que devem ser adicionados são:
• Grupo: tipo -> E/OU;
• Regra: campo -> nome do campo (vide abaixo padrão);
• Operador -> tipo de operador (vide abaixo padrão);
• Valor1(ou somente valor) -> primeiro ou único valor desejado;
• Valor2 -> segundo valor desejado, somente se for preciso usar dois valores (ex: entre 15 e 20);
Campo - os nomes dos campos baseado no padrão da plataforma: email, sexo, idade, data_nascimento, empresa, cpf, atividade, profissão, tipoend (Tipo de endereço), endereço, complemento, bairro, cidade, estado, pais, cep, telefone1, telefone2, telefone3, fax, data_validade.
Ou os campos adicionais, seguindo o padrão ca1, ca2, ca3, … ca20.
Operador - lista dos valores que podem ser usados para todos os campos: igual, diferente, contém, não contém, começa com, termina com.
Com exceção dos seguintes campos, que tem operador(es) únicos:
• Sexo: é
• Estado: é, não é
• Idade e CEP: está entre
Exemplo de uso do filtro
Para montar um filtro com as seguintes regras:
"O email não seja do yahoo.com ou gmail.com, e que tenha de 18 a 25, ou seja do sexo Feminino, ou que seja de estado de São Paulo, mas que não seja da cidade de Piracaia"

<filtro type="avancado">
  <grupo tipo="e">   		
    <regra campo="email" operador="não contém" valor="yahoo.com" />
    <regra campo="email" operador="não contém" valor="gmail.com" />	
    <grupo tipo="ou">
      <regra campo="idade" operador="está entre" valor1="18" valor2="25" />
      <regra campo="sexo" operador="igual" valor="F" />
        <grupo tipo="e">
          <regra campo="estado" operador="igual" valor="SP"  />
          <regra campo="cidade" operador="diferente" valor="Piracaia"  />
        </grupo>	
    </grupo>
  </grupo>
</filtro>

Agendar: Tag utilizada para que após a inclusão da ação a mesma seja agendada para horário desejado. A utilização desta tag equivale à utilização da integração 19.06.
Data/Hora: Data e Hora de envio da ação. Este campo deve ser informado no formato AAAA-MM-DD HH:MM:SS. Quando a tag "Agendar" é utilizada este campo é obrigatório.

XML de Retorno

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

19.06 - Agendar o Envio da Ação

Utilize essa integração para agendar uma ação pontual. O agendamento pode já ocorrer na integração de criação da ação (19.05).

XML de envio estrutura completa

<main>
  <emkt trans="19.06">
    <titulo>[NOME DA AÇÃO]</titulo>
    <datahora>AAAA-MM-DD HH:MM:SS</datahora>
    <menosde>[NÃO ENVIAR EM MENOS DE X HORAS]</menosde>
    <totalparcial>[NUMERO DE ENVIOS NO DISPARO]</totalparcial>
    <reiniciar>[REINICIAR O ENVIO APÓS X HORAS]</reiniciar>
    <envio_complementar>[S/N]</envio_complementar>
  </emkt>
</main>

Data/Hora: É a data e hora programada para o envio da ação. Esse campo deve seguir o formato AAAA-MM-DD HH:MM:SS. Para cancelar um agendamento anteriormente feito, envie "0000-00-00 00:00:00" nesse campo.

Menos de: O campo "menosde" especifica o número mínimo de horas que o envio da ação deve durar. Por exemplo, você pode configurar para que o envio seja realizado em um período de no mínimo 2 horas, evitando um envio muito rápido.

Total Parcial: Define a quantidade parcial de e-mails a serem enviados em cada disparo. Com isso, é possível limitar a quantidade de contatos atingidos em cada etapa da ação. Por exemplo, se a lista contém 1000 contatos, você pode optar por enviar apenas para 500 contatos em cada disparo.

Reiniciar: Agenda um reenvio dos e-mails restantes após um determinado período de horas a partir do envio do último e-mail no disparo anterior.

Envio Complementar: Realiza um reenvio automático após 24 horas do envio inicial da ação, direcionado aos contatos que ainda não abriram o e-mail.

Atenção

Certifique-se de que a ação possua contatos antes de agendar o envio. Para isso, você pode utilizar a integração 19.11.

XML de envio estrutura básica

<main>
  <emkt trans="19.06">
    <titulo>[NOME DA AÇÃO]</titulo>
    <datahora>AAAA-MM-DD HH:MM:SS</datahora>
  </emkt>
</main>

XML de retorno

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

19.07 - Envio de E-mail de Teste da Ação

Utilize essa integração para enviar um teste da ação antes do envio oficial. Os testes não consomem créditos. Você pode enviar para até 10 endereços de e-mail diferentes para verificar a aparência e o conteúdo da ação antes de enviá-la para o público-alvo.

XML de envio estrutura completa

<main>
  <emkt trans="19.07">
    <titulo>[NOME DA AÇÃO]</titulo>
    <assunto_teste>[S]</assunto_teste>
    <email>[EMAIL]</email>
    <email>[EMAIL]</email>
    ( ... )
  </emkt>
</main>

Dica

Utilize o campo "assunto_teste" com o valor "S" para inserir automaticamente o texto "[Teste]" no início do assunto da mensagem. Isso facilitará a identificação da mensagem como um teste para aqueles que a receberem.

XML de envio estrutra básica

<main>
  <emkt trans="19.07">
    <titulo>[NOME DA AÇÃO]</titulo>
    <email>[EMAIL]</email>
    <email>[EMAIL]</email>
    
( ... )
  </emkt>
</main>

XML de retorno

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

19.10 - Estatísticas das Ações Por Período

Utilize essa integração para obter informações estatísticas das ações em um período específico. O retorno incluirá detalhes como o nome da ação, remetente, destinatários e seus respectivos status. Essas informações ajudarão a acompanhar o desempenho das ações realizadas.

XML de envio

<main>
  <emkt trans="19.10">
  <datainicial>AAAA-MM-DD HH:MM:SS</datainicial>
  <datafinal>AAAA-MM-DD HH:MM:SS</datafinal>
  </emkt>
</main>

XML de retorno

<main>
  <emkt trans="19.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
  <return id="00">Ok</return>
  <campanha>
    <codigo>[CODIGO]</codigo>
    <nome>[NOME]</nome>
    <email>[REMETENTE]</email>
    <destinatario codigo="[CODIGO]" clicado="[S/N]">[EMAIL]</destinatario>
    <destinatario codigo="[CODIGO1]" clicado="[S/N]">[EMAIL2]</destinatario>
    (...)
  </campanha>
  <campanha>
    (...)
  </campanha>
  (...)
  </emkt>
</main>

19.11 - Totais da Ação

Utilize esta integração para obter informações essenciais, como o número total de destinatários, mensagens enviadas e erros ocorridos, entre outros dados relevantes.

XML de Envio:

<main>
  <emkt trans="19.11">
    <titulo>[NOME DA AÇÃO]</titulo>
  </emkt>
</main>

XML de Retorno

<main>
  <emkt trans="19.11" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <campanha>
      <totaldestinatarios>[TOTAL DE DESTINATARIOS]</totaldestinatarios>
      <totalenviado>[TOTAL ENVIADO]</totalenviado>
      <totalentregue>[TOTAL ENTREGUE]</totalentregue>
      <totalerros>[TOTAL DE ERROS]</totalerros>
      <totalvisualizacao>[TOTAL DE VISUALIZAÇÕES]</totalvisualizacao>
      <totalindicacoes>[TOTAL DE INDICAÇÕES]</totalindicacoes>
      <totalremocoes>[TOTAL DE PEDIDOS DE REMOÇÃO]</totalremocoes>
      <totalclicks>[TOTAL DE CLICKS]</totalclicks>
      <link>
        <titulo>[TITULO DO LINK]</titulo>
        <unicos>[TOTAL DE CLICKS UNICOS]</unicos>
        <total>[TOTAL DE CLICKS]</total>
      </link>
      (...)
      <erro>
        <titulo>[TIPO DE ERRO]</titulo>
        <total>[TOTAL DE ERROS]</total>
      </erro>
      (...)
    </campanha>
  </emkt>
</main>

19.31- Contatos que Visualizaram a Ação

Essa integração fornece uma lista dos endereços de e-mail que abriram a mensagem.

XML de Envio

<main>
  <emkt trans="19.31">
    <titulo>[NOME DA AÇAO]</titulo>
  </emkt>
</main>

XML de Retorno

<main>
  <emkt trans="19.31" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <campanha>
      <email>[E-MAIL]</email>
      (...)
    </campanha>
  </emkt>
</main>

19.55 - Informações da Ação

Utilize essa integração para receber informações relevantes sobre a configuração da ação, como os dados do remetente, quantidade de mensagens enviadas, monitoramento de links, detalhes sobre áreas de interesse e motivos de remoção.

XML de Envio

<main>
  <emkt trans="19.55">
    <titulo>[TITULO DA AÇÃO]</titulo>
  </emkt>
</main>

XML de Retorno

<main>
 <emkt trans="19.55" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
  <acao>
   <titulo>[TITULO DA AÇÃO]</titulo>
   <criacao>AAAA-MM-DD</criacao>
    <remetente>
     <nome>[NOME DO REMETENTE]</nome>
     <email>[E-MAIL DO REMETENTE]</email>
     <retorno>[E-MAIL DE RETORNO]</retorno>
    </remetente>
    <campanha>[CAMPANHA DA AÇÃO]</campanha>
     <mensagem>
      <titulo>[TITULO DA MENSAGEM UTILIZADA]</titulo>
      <url>[URL DE ORIGEM DA MENSAGEM]</url>
      <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>
    <area_interesse>[AREA DE INTERESSE]</area_interesse>
    <envio>AAAA-MM-DD HH:MM:SS</envio>
    <reenvio>AAAA-MM-DD HH:MM:SS</reenvio>
    <contatos>
      <total>[TOTAL DE CONTATOS DA AÇÃO]</total>
      <enviado>[TOTAL DE ENVIOS]</enviado>
    </contatos>
  </acao>
 </emkt>
</main>

19.80 - Lista de E-mails Inválidos da Ação

Essa integração retorna uma lista dos endereços que foram invalidados durante uma determinada ação.

XML de Envio

<main>
  <emkt trans="19.80">
  <titulo>[TITULO DA AÇÃO]</titulo>
  </emkt>
</main>

XML de Retorno

<main>
  <emkt trans="19.80" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
  <return id="00">Ok</return>
  <campanha>
    <codigo>[CODIGO]</codigo>
    <nome>[NOME]</nome>
    <email>[REMETENTE]</email>
    <destinatario codigo="[CODIGO]">[EMAIL]</destinatario>
    <destinatario codigo="[CODIGO1]">[EMAIL2]</destinatario>
    (...)
  </campanha>
  </emkt>
</main>

20.01 - Inclusão de Contatos Direto em uma Ação Sem o Envio Imediato

Essa integração possibilita a inserção direta de contatos em uma ação pontual. Nesse formato, não é necessário o uso de uma lista. Você pode utilizar uma ação pontual já criada, porém ainda sem a inserção de lista ou agendamento de envio.

XML de Envio estrutura completa

<main>
  <emkt trans="20.01">
    <acao>[TITULO DA AÇÃO]</acao>
    <indice>[E/C]</indice>
    <destinatario codigo="[CODIGO]">
      <nome>[NOME]</nome>
      <email>[EMAIL]</email>
      <sexo>[SEXO]</sexo>
      <idade>[IDADE]</idade>
      <data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
      <empresa>[EMPRESA]</empresa>
      <cpf>[CPF]</cpf>
      <atividade>[ATIVIDADE]</atividade>
      <profissao>[PROFISSAO]</profissao>
      <tipoend>[TIPO DE ENDERECO]</tipoend>
      <endereco>[ENDERECO]</endereco>
      <complemento>[COMPLEMENTO]</complemento>
      <bairro>[BAIRRO]</bairro>
      <cidade>[CIDADE]</cidade>
      <estado>[ESTADO]</estado>
      <pais>[PAIS]</pais>
      <cep>[CEP]</Cep>
      <telefone1>[TELEFONE 1]</telefone1>
      <telefone2>[TELEFONE 2]</telefone2>
      <telefone3>[TELEFONE 3]</telefone3>
      <fax>[FAX]</fax>
      <infoadc1>[INFO 01]</infoadc1>
      <infoadc2>[INFO 02]</infoadc2>
      <infoadc3>[INFO 03]</infoadc3>
      <infoadc4>[INFO 04]</infoadc4>
      <infoadc5>[INFO 05]</infoadc5>
      <infoadc6>[INFO 06]</infoadc6>
      <infoadc7>[INFO 07]</infoadc7>
      <infoadc8>[INFO 08]</infoadc8>
      <infoadc9>[INFO 09]</infoadc9>
      <infoadc10>[INFO 10]</infoadc10>
      <infoadc11>[INFO 11]</infoadc11>
      <infoadc12>[INFO 12]</infoadc12>
      <infoadc13>[INFO 13]</infoadc13>
      <infoadc14>[INFO 14]</infoadc14>
      <infoadc15>[INFO 15]</infoadc15>
      <infoadc16>[INFO 16]</infoadc16>
      <infoadc17>[INFO 17]</infoadc17>
      <infoadc18>[INFO 18]</infoadc18>
      <infoadc19>[INFO 19]</infoadc19>
      <infoadc20>[INFO 20]</infoadc20>
      <data_validade>[DATA VALIDADE]</data_validade>
    </destinatario>
    <destinatario codigo="[CODIGO]">
      (...)
    </destinatario>
 </emkt> 
</main>

Índice: (o valor padrão é E)

E = Nesse caso, o endereço de e-mail é o índice da lista, ou seja, esse campo não se repete.
C = Nesse caso, o índice é o campo código externo. Dessa forma, o campo de e-mail pode se repetir na ação, mas o campo de código externo não se repete. Exemplo de uso: o código externo pode ser o RA do aluno, permitindo que o campo de e-mail se repita, mas o campo de RA não.

Todos os campos do destinatário, exceto e-mail, são de uso opcional.

A ação a ser utilizada não pode ter a data de encerramento menor que a data atual.

Para que o disparo ocorra com os novos endereços inseridos, é necessário chamar a integração "19.06 agenda uma ação do tipo pontual".

XML de envio estrutura básica

<main>
  <emkt trans="20.01">
    <acao>[TITULO DA AÇÃO]</acao>
    <destinatario>
      <email>[EMAIL]</email>
    </destinatario>
 </emkt> 
</main>

XML de Retorno

<main>
  <emkt trans="20.01" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <return id="99">
      <EMAIL_INVALIDO>[EMAIL]</EMAIL_INVALIDO>
      ( … )
      <FALHA_INSERIR>[EMAIL]</FALHA_INSERIR>
      ( … )
      <EMAIL_OPTOUT MENSAGEM="[MENSAGEM]">[EMAIL]</EMAIL_OPTOUT>
      ( … )
    </return>
  </emkt>
</main>

Atenção

O arquivo de retorno pode eventualmente conter uma lista de e-mails que foram considerados inválidos pelo sistema, identificados pela tag EMAIL_INVALIDO. Além disso, podem ocorrer erros de inserção do contato, que serão retornados na tag FALHA_INSERIR.

Será realizada uma checagem para verificar se o endereço de e-mail fornecido está marcado como opt-out para a "área de interesse" desta ação. Se for constatado que o contato é opt-out para essa área específica ou se estiver marcado como opt-out para todas as "áreas de interesse", o envio para esse endereço não será possível. Nesse caso, o e-mail será apresentado na tag EMAIL_OPTOUT, e no atributo MENSAGEM será indicada a área de interesse para a qual o contato é opt-out.

Mesmo que ocorram quaisquer dos erros mencionados acima, a API continuará a fazer a inserção de todos os e-mails válidos.

20.05 Disparando uma Ação Transacional

Uma ação transacional é um tipo de ação que é disparada sob demanda, sem a necessidade de uma lista vinculada. Ao receber o contato, a ação é imediatamente disparada. Utilize esta integração para inserir contatos em uma ação que já tenha sido criada. Você pode criá-la manualmente acessando a plataforma ou optar por utilizar a integração 19.04 desse grupo de integrações.

XML de envio estrutura completa

<main>
  <emkt trans="20.05">
    <acao>[TITULO DA AÇÃO]</acao>
    <indice>[E/C]</indice>
    <envio_minutos>[MINUTOS]</envio_minutos>
    <destinatario codigo="[CODIGO]">
      <nome>[NOME]</nome>
      <email>[EMAIL]</email>
      <sexo>[SEXO]</sexo>
      <idade>[IDADE]</idade>
      <data_nascimento>[DATA_NASCIMENTO]</data_nascimento>
      <empresa>[EMPRESA]</empresa>
      <cpf>[CPF]</cpf>
      <atividade>[ATIVIDADE]</atividade>
      <profissao>[PROFISSAO]</profissao>
      <tipoend>[TIPO DE ENDERECO]</tipoend>
      <endereco>[ENDERECO]</endereco>
      <complemento>[COMPLEMENTO]</complemento>
      <bairro>[BAIRRO]</bairro>
      <cidade>[CIDADE]</cidade>
      <estado>[ESTADO]</estado>
      <pais>[PAIS]</pais>
      <cep>[CEP]</cep>
      <telefone1>[TELEFONE 1]</telefone1>
      <telefone2>[TELEFONE 2]</telefone2>
      <telefone3>[TELEFONE 3]</telefone3>
      <fax>[FAX]</fax>
      <infoadc1>[INFO 01]</infoadc1>
      <infoadc2>[INFO 02]</infoadc2>
      <infoadc3>[INFO 03]</infoadc3>
      <infoadc4>[INFO 04]</infoadc4>
      <infoadc5>[INFO 05]</infoadc5>
      <infoadc6>[INFO 06]</infoadc6>
      <infoadc7>[INFO 07]</infoadc7>
      <infoadc8>[INFO 08]</infoadc8>
      <infoadc9>[INFO 09]</infoadc9>
      <infoadc10>[INFO 10]</infoadc10>
      <infoadc11>[INFO 11]</infoadc11>
      <infoadc12>[INFO 12]</infoadc12>
      <infoadc13>[INFO 13]</infoadc13>
      <infoadc14>[INFO 14]</infoadc14>
      <infoadc15>[INFO 15]</infoadc15>
      <infoadc16>[INFO 16]</infoadc16>
      <infoadc17>[INFO 17]</infoadc17>
      <infoadc18>[INFO 18]</infoadc18>
      <infoadc19>[INFO 19]</infoadc19>
      <infoadc20>[INFO 20]</infoadc20>
      <data_validade>[DATA VALIDADE]</data_validade>
    </destinatario>
    (...)
  </emkt>
</main>

XML de envio estrutura básica

<main>
  <emkt trans="20.05">
    <acao>[TITULO DA AÇÃO]</acao>
    <destinatario>
      <email>[EMAIL]</email>
     </destinatario>
    (...)
  </emkt>
</main>

XMl de Retorno

<main>
  <emkt trans="20.05" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <return id="99">
      <EMAIL_INVALIDO>[EMAIL]</EMAIL_INVALIDO>
      ( … )
      <FALHA_INSERIR>[EMAIL]</FALHA_INSERIR>
      ( … )
    </return>
  </emkt>
</main>

20.10 - Importação de Arquivo para a Ação

Utilize esta integração para importar um arquivo contendo os contatos para uma ação do tipo pontual.

XML de Envio

<main>
  <emkt trans="20.10">
    <acao>[TITULO DA AÇÃO]</acao>
    <indice>[E/C]</indice>
    <envio>0000-00-00 00:00</envio>
    <arquivo>[URL DO ARQUIVO]</arquivo>
    <separador>[SEPARADOR]</separador>
    <opcoes cabecalho="[S/N]" reenviar="[S/N]" />
    <campos>
      <email col="[NUMERO DA COLUNA]" />
      <nome col="[NUMERO DA COLUNA]" />
      <sexo col="[NUMERO DA COLUNA]" />
      <idade col="[NUMERO DA COLUNA]" />
      <data_nascimento col="[NUMERO DA COLUNA]" />
      <codigo_externo col="[NUMERO DA COLUNA]" />
      <empresa col="[NUMERO DA COLUNA]" />
      <cpf col="[NUMERO DA COLUNA]" />
      <atividade col="[NUMERO DA COLUNA]" />
      <profissao col="[NUMERO DA COLUNA]" />
      <tipoend col="[NUMERO DA COLUNA]" />
      <endereco col="[NUMERO DA COLUNA]" />
      <complemento col="[NUMERO DA COLUNA]" />
      <bairro col="[NUMERO DA COLUNA]" />
      <cidade col="[NUMERO DA COLUNA]" />
      <estado col="[NUMERO DA COLUNA]" />
      <pais col="[NUMERO DA COLUNA]" />
      <cep col="[NUMERO DA COLUNA]" />
      <telefone1 col="[NUMERO DA COLUNA]" />
      <telefone2 col="[NUMERO DA COLUNA]" />
      <telefone3 col="[NUMERO DA COLUNA]" />
      <fax col=20) Alterações de listas das ações"[NUMERO DA COLUNA]" />
      <infoadc1 col="[NUMERO DA COLUNA]" />
      <infoadc2 col="[NUMERO DA COLUNA]" />
      <infoadc3 col="[NUMERO DA COLUNA]" />
      <infoadc4 col="[NUMERO DA COLUNA]" />
      <infoadc5 col="[NUMERO DA COLUNA]" />
      <infoadc6 col="[NUMERO DA COLUNA]" />
      <infoadc7 col="[NUMERO DA COLUNA]" />
      <infoadc8 col="[NUMERO DA COLUNA]" />
      <infoadc9 col="[NUMERO DA COLUNA]" />
      <infoadc10 col="[NUMERO DA COLUNA]" />
      <infoadc11 col="[NUMERO DA COLUNA]" />
      <infoadc12 col="[NUMERO DA COLUNA]" />
      <infoadc13 col="[NUMERO DA COLUNA]" />
      <infoadc14 col="[NUMERO DA COLUNA]" />
      <infoadc15 col="[NUMERO DA COLUNA]" />
      <infoadc16 col="[NUMERO DA COLUNA]" />
      <infoadc17 col="[NUMERO DA COLUNA]" />
      <infoadc18 col="[NUMERO DA COLUNA]" />
      <infoadc19 col="[NUMERO DA COLUNA]" />
      <infoadc20 col="[NUMERO DA COLUNA]" />
    </campos>
  </emkt>
</main>

Índice: (o valor padrão é E)
E = Nesse caso, o endereço de e-mail é o índice da lista, ou seja, esse campo não se repete.
C = Nesse caso, o índice é o campo código externo. Dessa forma, o campo de e-mail pode se repetir na ação, enquanto o campo de código externo não se repete. Exemplo de uso: o código externo pode ser o RA do aluno, permitindo que o campo de e-mail se repita, mas o campo de RA não.

Envio: É a data/hora de envio da ação; caso não seja informada, ela é agendada para ser enviada 5 minutos após a requisição.

Arquivo: Endereço do arquivo a ser importado, aceitando os protocolos HTTP, HTTPS, FTP e FTPS. O sistema suporta arquivos nos formatos .ZIP, .XLS, .CSV e .Txt. No caso do uso compactado, deve haver somente um arquivo dentro do .zip. O arquivo que o compõe poderá estar nos seguintes formatos: .XLS, .CSV ou .Txt.

Exemplo: ftps://user:senha@ftp.dominio.com.br/pasta/arquivo.zip

Separador: Deve-se informar qual o caractere que separa as colunas do arquivo. No caso do formato Excel (.XLS ou .CSV), esse campo não é obrigatório.

Opções:
Cabeçalho: Informa se o arquivo a ser importado possui cabeçalho.
Reenviar: Informa se o mesmo contato pode receber a mesma ação mais de uma vez.

Todos os campos, exceto e-mail, são opcionais.

XML de Retorno

<main>
  <emkt trans="20.10" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <processo>[CODIGO MD5]</processo>
  </emkt>
</main>

20.11 - Situação de Importação de Arquivo para a Ação (20.10)

Utilize esta integração para consultar o status do processo de importação de contatos para uma ação quando utilizada a integração 20.10.

XML de Envio

<main>
  <emkt trans="20.11">
    <processo>[CODIGO MD5]</processo>
  </emkt>
</main>

XML de Retorno

<main>
  <emkt trans="20.11" key="XXXXXXXXXXXXXXXXXXXXXXXXXXXX">
    <return id="00">Ok</return>
    <progresso>[PERCENTUAL]</progresso>
    <resultado>
      <erro>[MENSAGEM DE ERRO]</erro>
      <acao>[NOME DA LISTA]</acao>
      <arquivo>[NOME DO ARQUIVO]</arquivo>
      <linhas>[LINHAS NO ARQUIVO]</linhas>
      <duplicados>[CONTATOS DUPLICADOS NO ARQUIVO]</duplicados>
      <inseridos>[CONTATOS INSERIDOS]</inseridos>
      <atualizados>[CONTATOS ATUALIZADOS]</atualizados>
      <cadastrados>[CONTATOS JÁ CADASTRADOS]</cadastrados>
      <validos_antes>[CONTATOS ANTES DA IMPORTAÇÃO]</validos_antes>
      <validos_apos>[CONTATOS APÓS IMPORTAÇÃO]</validos_apos>
    </resultado>
  </emkt>
</main>

Was this article helpful?

What's Next

Como Gerenciar as Automações

Table of contents

Sobre a função