Manuais:UniNFe/EnviandoXMLuMessenger - Histórico de revisão

Wesley em 12h17min de 8 de julho de 2025

2025-07-08T12:17:23Z

Wesley: /* Estrutura do XML de envio */

2025-06-12T14:20:57Z

‎Estrutura do XML de envio

Wesley em 17h34min de 9 de abril de 2025

2025-04-09T17:34:59Z

Wesley: Criou página com 'NOTITLE ='''Como utilizar o serviço do uMessenger?'''= Após realizar a Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger n...'

2025-04-04T12:56:59Z

Criou página com '__NOTITLE__ ='''Como utilizar o serviço do uMessenger?'''= Após realizar a Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger n...'

Página nova

__NOTITLE__
='''Como utilizar o serviço do uMessenger?'''=

Após realizar a [[Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger 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 [https://www.unimake.com.br/uninfe/modelos.php?p=uMessenger exemplo em XML] para ilustrar esse processo. Para enviar, ERP deve gerar o arquivo na [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de envio|pasta de envio]] com o nome e formato indicados a seguir:

MensagemASerEnviada-mb.xml

{| class="wikitable"
|-
||MensagemASerEnviada
||Conteúdo livre
|-
| style="width: 120px;"|-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.

<pre>
<?xml version="1.0" encoding="utf-8"?>
<uMessenger versao="1.00">
<SendTextMessage>
<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>
</pre>

* '''Legenda:'''
** 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 uMessenger, 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 [[Manuais:UniNFe/Configurando o UniNFe/Configuracoes Empresas/ConfigAbaPastas/Pasta de retorno|pasta de retorno]] com o nome a seguir:

MensagemASerEnviada-ret-mb.xml

E sua estrutura é a seguinte:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<MessageBrokerResponse>
<Status>1</Status>
<Motivo>Mensagem enviada com sucesso.</Motivo>
<messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID>
</MessageBrokerResponse>
</pre>

* '''Legenda:'''
** 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'''=

* [[Manuais:uMessenger/uMessenger|O que é o uMessenger?]]
* [[Manuais:UniNFe/ConfigurandoUMessenger|Como configurar o uMessenger no UniNFe?]]

@@ Linha 1: / Linha 1: @@
 __NOTITLE__
-=<font color=#2E8B57>'''Como utilizar o serviço do uMessenger?'''</font>=
+=<font color=#2E8B57>'''Como utilizar o serviço do u-Messenger?'''</font>=
-Após realizar a [[Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger no UniNFe]], vamos consumir o serviço de envio livre de mensagens. Bora conferir?
+Após realizar a [[Manuais:UniNFe/ConfigurandoUMessenger|configuração do u-Messenger no UniNFe]], vamos consumir o serviço de envio livre de mensagens. Bora conferir?
 ==<font color=#2E8B57>'''Envio de mensagens com ou sem arquivos'''</font>==
@@ Linha 85: / Linha 85: @@
 ** 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 <font color="#FF0000">'''false'''</font>. Só utilize quando é necessário fazer testes para possibilitar DEBUG do lado do uMessenger, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código;
+** A tag '''<UseHomologServer>''' é uma tag opcional no XML tendo o valor padrão <font color="#FF0000">'''false'''</font>. 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 <span style="color: red">'''LIMITE DE 10 ARQUIVOS'''</span>:
 *** O grupo '''<File>''' indica as informações de um arquivo específico que será enviado:
@@ Linha 130: / Linha 130: @@
 =<font color=#2E8B57>'''Veja também'''</font>=
-* [[Manuais:uMessenger/uMessenger|O que é o uMessenger?]]
+* [[Manuais:uMessenger/uMessenger|O que é o u-Messenger?]]
-* [[Manuais:UniNFe/ConfigurandoUMessenger|Como configurar o uMessenger no UniNFe?]]
+* [[Manuais:UniNFe/ConfigurandoUMessenger|Como configurar o u-Messenger no UniNFe?]]

@@ Linha 37: / Linha 37: @@
 <uMessenger versao="1.00">
 	<SendTextMessage Id="01">
 		<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>
@@ Linha 55: / Linha 56: @@
 	</SendTextMessage>
 	<SendTextMessage Id="02">
 		<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>
@@ Linha 79: / Linha 81: @@
 ** 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 '''<To>''' é o número do WhatsApp para onde será enviada a mensagem, <span style="color: red">'''sendo uma tag obrigatória'''</span>;
 ** A tag '''<Text>''' é o texto livre a ser enviado ao destinatário da mensagem;

@@ Linha 36: / Linha 36: @@
 <?xml version="1.0" encoding="utf-8"?>
 <uMessenger versao="1.00">
-   <SendTextMessage>
+	<SendTextMessage Id="01">
-      <To>5544991423078</To>
+		<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>
+		<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>
+		<Testing>true</Testing>
-      <UseHomologServer>true</UseHomologServer>
+		<UseHomologServer>true</UseHomologServer>
-      <Files>
+		<Files>
-            <File>
+			<File>
-                  <FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250317_162121.png</FullPath>
+				<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>
+				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
-                  <MediaType>1</MediaType>
+				<MediaType>1</MediaType>
-            </File>
+			</File>
-            <File>
+			<File>
-                  <FullPath>D:\Wandrey\OneDrive\Imagens\Capturas de tela\Screenpresso\ScreenShot_20250312_170821.png</FullPath>
+				<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>
+				<Description>Texto ou descrição qualquer para acompanhar o arquivo</Description>
-                  <MediaType>1</MediaType>
+				<MediaType>1</MediaType>
-            </File>
+			</File>
-        </Files>
+		</Files>
-   </SendTextMessage>
+	</SendTextMessage>
 </uMessenger>
 </pre>
 * <font color=#2E8B57>'''Legenda:'''</font>
 ** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem, <span style="color: red">'''sendo uma tag obrigatória'''</span>;
 ** A tag '''<Text>''' é o texto livre a ser enviado ao destinatário da mensagem;
@@ Linha 80: / Linha 101: @@
 <pre>
 <?xml version="1.0" encoding="utf-8"?>
-<MessageBrokerResponse>
+<uMessengerResponse>
-   <Status>1</Status>
+	<Mensagem Id="01">
-   <Motivo>Mensagem enviada com sucesso.</Motivo>
+		<Status>1</Status>
-   <messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID>
+		<Motivo>Mensagem enviada com sucesso.</Motivo>
-</MessageBrokerResponse>
+		<messageID>BAE572D1B77AFA4E</messageID>
 </pre>
 * <font color=#2E8B57>'''Legenda:'''</font>
 ** A tag '''<Status>''' é o status da mensagem tendo os valores:
 *** 1 = Mensagem enviada com sucesso.

Manuais:UniNFe/EnviandoXMLuMessenger - Histórico de revisão

Wesley em 12h17min de 8 de julho de 2025

Wesley: /* Estrutura do XML de envio */

Wesley em 17h34min de 9 de abril de 2025

Wesley: Criou página com '__NOTITLE__ ='''Como utilizar o serviço do uMessenger?'''= Após realizar a Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger n...'

Wesley: Criou página com 'NOTITLE ='''Como utilizar o serviço do uMessenger?'''= Após realizar a Manuais:UniNFe/ConfigurandoUMessenger|configuração do uMessenger n...'