Manuais:UniNFe/EnviandoXMLuMessenger

Como utilizar o serviço do u-Messenger?

Após realizar a configuração do u-Messenger no UniNFe, vamos consumir o serviço de envio livre de mensagens. Bora conferir?

Envio de mensagens com ou sem arquivos

Agora o ERP pode enviar mensagem para o WhatsApp através do UniNFe. Criamos um exemplo em XML para ilustrar esse processo. Para enviar, ERP deve gerar o arquivo na pasta de envio com o nome e formato indicados a seguir:

MensagemASerEnviada-mb.xml

MensagemASerEnviada	Conteúdo livre
-mb.xml	Conteúdo fixo. Sempre será "-mb.xml"

O nome do arquivo de retorno é o mesmo do arquivo enviado, alterando apenas o prefixo final, veja:

MensagemASerEnviada-ret-mb.xml (se tudo ocorreu bem)

ou

MensagemASerEnviada-ret-mb.err (se houve algum erro)

---

Estrutura do XML de envio

A estrutura de envio é compacta, vamos conferir.

<?xml version="1.0" encoding="utf-8"?>
<uMessenger versao="1.00">
	<SendTextMessage Id="01">
		<InstanceName>vbnribvrivbr11818fff18f1</InstanceName>
		<To>5544991423078</To>
		<Text>*Olá!*\r\n\r\nEu sou uma _mensagem_ de teste 🌜\r\n\r\n- Eu sou mais\r\n- Eu sou mais 1\r\n\r\nhttps://www.unimake.com.br</Text>
		<Testing>true</Testing>
		<UseHomologServer>true</UseHomologServer>
		<Files>
			<File>
				<FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250317_162121.png</FullPath>
				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
				<MediaType>1</MediaType>
			</File>
			<File>
				<FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250312_170821.png</FullPath>
				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
				<MediaType>1</MediaType>
			</File>
		</Files>
	</SendTextMessage>
	<SendTextMessage Id="02">
		<InstanceName>vbnribvrivbr11818fff18f1</InstanceName>
		<To>5544991423078</To>
		<Text>*Olá!*\r\n\r\nEu sou uma _mensagem_ de teste 🌜\r\n\r\n- Eu sou mais\r\n- Eu sou mais 1\r\n\r\nhttps://www.unimake.com.br</Text>
		<Testing>true</Testing>
		<UseHomologServer>true</UseHomologServer>
		<Files>
			<File>
				<FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250317_162121.png</FullPath>
				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
				<MediaType>1</MediaType>
			</File>
			<File>
				<FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250312_170821.png</FullPath>
				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
				<MediaType>1</MediaType>
			</File>
		</Files>
	</SendTextMessage>
</uMessenger>

• Legenda:
  • O grupo de tags <SendTextMessage> pode ser repetida até 50 vezes;
  • O atributo ID da tag <SendTextMessage> não é obrigatório mas facilita controlar as mensagens enviadas e os retornos;
  • A tag <<InstanceName> é o nome ou identificador da instância responsável pelo envio da mensagem (número de WhatsApp que vai enviar a mensagem), essa informação será repassada pela Unimake;
  • A tag <To> é o número do WhatsApp para onde será enviada a mensagem, sendo uma tag obrigatória;
  • A tag <Text> é o texto livre a ser enviado ao destinatário da mensagem;
  • A tag <Testing> é o que indica se é ambiente de teste ou não (True: ambiente de teste, False: ambiente de produção);
  • A tag <UseHomologServer> é uma tag opcional no XML tendo o valor padrão false. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do u-Messenger, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código;
  • O grupo <Files> é onde ficará as informações dos arquivos que serão enviados com LIMITE DE 10 ARQUIVOS:
    • O grupo <File> indica as informações de um arquivo específico que será enviado:
      • A tag <FullPath> é o caminho do arquivo a ser enviado, sendo uma tag obrigatória;
      • A tag <Description> é o texto ou descrição que acompanhará o arquivo, não sendo obrigatória;
      • A tag <MediaType> é o tipo da mídia que está sendo enviada com os valores: 0 para nenhum, 1 para imagem, 2 para documento, 3 para áudio e 4 para vídeo, não sendo obrigatória.

---

XML de retorno do envio: O que fazer?

Para verificar se a mensagem foi enviada, seu ERP deve verificar as informações no XML de retorno. Esse XML será gerado na pasta de retorno com o nome a seguir:

MensagemASerEnviada-ret-mb.xml

E sua estrutura é a seguinte:

<?xml version="1.0" encoding="utf-8"?>
<uMessengerResponse>
	<Mensagem Id="01">
		<Status>1</Status>
		<Motivo>Mensagem enviada com sucesso.</Motivo>
		<messageID>BAE572D1B77AFA4E</messageID>
		<UniNFeVersao>5.1.0.138 | 07-04-2025 - 14:02:13</UniNFeVersao>
	</Mensagem>
	<Mensagem Id="02">
		<Status>1</Status>
		<Motivo>Mensagem enviada com sucesso.</Motivo>
		<messageID>BAE5A16DBDB20899</messageID>
		<UniNFeVersao>5.1.0.138 | 07-04-2025 - 14:02:13</UniNFeVersao>
	</Mensagem>
</uMessengerResponse>

• Legenda:
  • O grupo <Mensagem> são as informações da mensagem enviada;
  • O atributo ID da tag <Mensagem> será o mesmo ID que o ERP enviou no primeiro XML, isso ajuda no momento de rastrear o retorno da mensagem certa;
  • A tag <Status> é o status da mensagem tendo os valores:
    • 1 = Mensagem enviada com sucesso.
  • A tag <Motivo> é a descrição do status;
  • A tag <messageID> é o ID da mensagem enviada.

Veja também

• O que é o u-Messenger?
• Como configurar o u-Messenger no UniNFe?