Carregando...

Controle de Ações

Controle de Ações

 

As integrações desse grupo permitem tratar os recursos relacionados a ações como: listas, incluir ações pontuais e transacionais, incluir contatos na ação pontual e transacional, agendar ação pontual, enviar teste e estatísticas da ação.

 

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:

XML de Retorno:

<main>
     <emkt trans="19.03">
     </emkt>
</main>
*Itens em negrito são obrigatórios.
<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 é disparada sobre demanda, ela não possui uma lista vinculada, ao receber o contato dispara. Utilize essa integração para criar esse tipo de ação na plataforma. Para inserir os contatos utilize a integração 20.05 desse documento.

XML de Envio:

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">[NOME OU LINK DA MENSAGEM]</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>
*Itens em negrito são obrigatórios.
<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.

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 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:

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

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.

Usuario: 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, profissao, tipoend(Tipo de endereço), endereco, 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 dsejado. 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:

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

Data/Hora: Data e Hora de envio da ação. Este campo deve ser informado no formato AAAA-MM-DD HH:MM:SS. Para cancelar um agendamento feito anteriormente envie 0000-00-00 00:00:00 no campo.

Menos de: O campo “menosde” deve ter o número de horas mínimas que o disparo deverá durar. Por exemplo, não enviar em menos de 2 horas. Assim é possível efetuar um disparo mais lento.

Total Parcial: Quantidade de e-mails a ser enviada por disparo. Assim é possível limitar a quantidade de contatos na ação. Por exemplo, a lista contem 1000 contatos porem você deseja enviar apenas para 500 contatos no primeiro momento.

Reiniciar: Agenda um reenvio dos e-mails restantes após X horas do último e-mail enviado no último disparo.

Envio Complementar: A ferramenta faz um reenvio após 24 horas do disparo da ação para os contatos que ainda não abriram.

Atenção: Certifique-se que a ação possua contatos antes de agendar o envio. Você pode utilizar a integração 19.11 para isso.

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 disparo real. Os testes não consomem créditos. Você pode enviar para até 10 endereços de e-mail.

XML  de Envio:

<main>
  <emkt trans="19.07">
    <titulo>[NOME DA AÇÃO]</titulo>
    <assunto_teste>[S]</assunto_teste>
    <email>[EMAIL]</email>
    <email>[EMAIL]</email>
    ( ... )
  </emkt>
</main>
*Itens em negrito são obrigatórios.
Dica: assunto_teste: Se tiver “S” neste campo será inserido o texto "[Teste]" no início do assunto da mensagem facilita para quem receberá o teste.

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 receber informações sobre as estatísticas das ações em um determinado período. Serão retornadas informações como: nome da ação, remetente, os destinatários e seus status.

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

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 essa integração para receber informações, como: total de destinatário, total de mensagens enviadas, total de erros, entre outros.

XML de Envio:

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

*Itens em negrito são obrigatórios.

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

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 relacionadas a configuração da ação como: os dados do remetente, quantidade de enviados, se os links estão sendo monitorados, informações sobre as áreas de interesse e motivos de remoção.

XML de Envio:

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

*Itens em negrito são obrigatórios.

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 retorno uma lista dos endereços que foram invalidados em uma determinada ação.

XML de Envio

<main>
  <emkt trans="19.80">
  <titulo>[TITULO DA AÇÃO]</titulo>
  </emkt>
</main>
*Itens em negrito são obrigatórios.

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 injeta contatos diretamente em uma ação pontual. Nesse formato não há utilização de lista. Você poderá utilizar uma ação pontual já criada, porem que ainda não teve inserção de lista nem agendamento de envio.

XML de Envio:

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

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

  • E = nesse caso 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. Assim o campo e-mail pode se repetir na ação e o campo código externo não se repete. Exemplo de uso: o código externo é o RA do aluno, portanto o campo e-mail pode se repetir, porem o campo RA não se repete.

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

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

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

XML de Envio:

<main>
 <emkt trans="11.45">
  <titulo>Titulo da lista</titulo>
   <destinatarios>
    <celular>11999999999</celular>
    <celular>11999999999</celular>
    <celular>11999999999</celular>
    <celular>11999999999</celular>
   </destinatarios>
  </emkt>
</main>
*Itens em negrito são obrigatórios.

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 poderá eventualmente apresentar uma lista de e-mails que foram considerados inválidos pelo sistema na tag EMAIL_INVALIDO. Também poderá ocorrer erro de inserção do contato, este tipo de erro será retornado na tag FALHA_INSERIR. Será feita uma checagem para verificar se o endereço de e-mail passado é opt-out para a “área de interesse” desta ação. Caso seja constatado que ele é opt-out para a mesma, ou se ele for para todas as “áreas de interesses” não será possível o envio para este endereço. Neste caso o email será apresentado na tag EMAIL_OPTOUT e no atributo MENSAGEM será apresentado a área de interesse que o contato é opt-out. Mesmo que ocorrera qualquer um dos erros acima mencionado a API irá 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 sobre demanda ela não possui uma lista vinculada, ao receber o contato, dispara. Utilize essa integração para inserir contatos em uma ação já criada. Você poderá cria-la manualmente acessando a plataforma ou utilizar a integração 19.04 desse grupo de integrações.

XML  de Envio:

XML de Retorno:

<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>
    <destinatario codigo="[CODIGO]">
      (...)
    </destinatario>
    (...)
  </emkt>
</main>
*Itens em negrito são obrigatórios.
<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>

Atenção 1: O arquivo de retorno poderá eventualmente apresentar uma lista de e-mails que foram considerados inválidos pelo sistema na tag EMAIL_INVALIDO. Também poderá ocorrer erro de inserção do contato, este tipo de erro será retornado na tag FALHA_INSERIR. Mesmo que ocorra qualquer um dos erros acima mencionados a API irá fazer a inserção de todos os e-mails válidos.

Atenção 2: No envio dos dados para a ação, deve-se selecionar o tipo de lista utilizada. Com dado primário "e-mail" ou "código externo" optando-se pelo E ou C respectivamente.

Atenção 3:  o [MINUTOS] é definido pelo tempo em que os dados serão inseridos na ação após a integração. O padrão do sistema é de 5 minutos caso este dado não seja fornecido.

Atenção 4: o campo deve ser preenchido sempre que se utilizar um disparo utilizando código externo. Este campo é controlado pelo próprio cliente e necessita ser único (desta forma permite a duplicidade de envios para um mesmo email em um mesmo bloco de dados).

Atenção 5: No caso de envio de dados para a ação do tipo "E-mail" os eventos serão considerados sempre de acordo com o status do evento mais recente (não mantendo os anteriores armazenados) 

 

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

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

XML de Envio:E

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

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

  • E = nesse caso 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. Assim o campo e-mail pode se repetir na ação e o campo código externo não se repete. Exemplo de uso: o código externo é o RA do aluno, portanto o campo e-mail pode se repetir, porem o campo RA não se repete.

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, aceita 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õem 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 tem cabeçalho.
  • Reenviar: Informa se o mesmo contato pode receber mais de uma vez essa mesma ação.

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 essa integração para consultar como está o processo de importação de contatos para ação quando utilizada a integração 20.10.

XML de Envio:

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

*Itens em negrito são obrigatórios.

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