Mudanças entre as edições de "Manuais:UniNFe/EnviandoXMLMessageBroker"
(Adicionado documentação da tag <UseHomologServer>) |
|||
| Linha 1: | Linha 1: | ||
__NOTITLE__ | __NOTITLE__ | ||
| − | =<font color=#2E8B57>'''Como utilizar o serviço do | + | =<font color=#2E8B57>'''Como utilizar o serviço do uMessenger?'''</font>= |
| − | Após realizar a [[Manuais:UniNFe/ConfigurandoMessageBroker|configuração do | + | Após realizar a [[Manuais:UniNFe/ConfigurandoMessageBroker|configuração do uMessenger no UniNFe]], vamos consumir o serviço de envio livre de mensagens. Bora conferir? |
| − | ==<font color=#2E8B57>''' | + | ==<font color=#2E8B57>'''Envio livre de mensagens'''</font>== |
| − | + | O serviço do UniNFe é consumido por meio da troca de arquivos. Criamos um [https://www.unimake.com.br/uninfe/modelos.php?p=MessageBroker exemplo em XML] para ilustrar esse processo. Para enviar, gere 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" | {| class="wikitable" | ||
|- | |- | ||
| − | || | + | ||MensagemASerEnviada |
||Conteúdo livre | ||Conteúdo livre | ||
|- | |- | ||
| Linha 19: | Linha 19: | ||
|} | |} | ||
| − | O nome do arquivo de retorno é o mesmo do | + | 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 | ou | ||
| − | + | MensagemASerEnviada-ret-mb.err (''se houve algum erro'') | |
---- | ---- | ||
| Linha 31: | Linha 31: | ||
===<font color=#2E8B57>Estrutura do XML de envio</font>=== | ===<font color=#2E8B57>Estrutura do XML de envio</font>=== | ||
| − | A estrutura de envio é | + | A estrutura de envio é compacta; vamos conferir. |
<pre> | <pre> | ||
<?xml version="1.0" encoding="utf-8"?> | <?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> | |
| − | + | </SendTextMessage> | |
| − | + | </uMessenger> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | </ | ||
</pre> | </pre> | ||
* <font color=#2E8B57>'''Legenda:'''</font> | * <font color=#2E8B57>'''Legenda:'''</font> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória; | ** A tag '''<To>''' é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória; | ||
| − | ** A tag '''< | + | ** A tag '''<Text>''' 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 '''<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 eBank, 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 eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código. | ||
| Linha 73: | Linha 57: | ||
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: | 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: | E sua estrutura é a seguinte: | ||
| Linha 80: | Linha 64: | ||
<?xml version="1.0" encoding="utf-8"?> | <?xml version="1.0" encoding="utf-8"?> | ||
<MessageBrokerResponse> | <MessageBrokerResponse> | ||
| − | + | <Status>1</Status> | |
| − | + | <Motivo>Mensagem enviada com sucesso.</Motivo> | |
| − | + | <messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID> | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</MessageBrokerResponse> | </MessageBrokerResponse> | ||
</pre> | </pre> | ||
Edição atual tal como às 09h05min de 5 de agosto de 2024
Índice
Como utilizar o serviço do uMessenger?
Após realizar a configuração do uMessenger no UniNFe, vamos consumir o serviço de envio livre de mensagens. Bora conferir?
Envio livre de mensagens
O serviço do UniNFe é consumido por meio da troca de arquivos. Criamos um exemplo em XML para ilustrar esse processo. Para enviar, gere 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>
<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>
</SendTextMessage>
</uMessenger>
- Legenda:
- A tag <To> é o número do WhatsApp para onde será enviada a mensagem sendo uma tag obrigatória;
- A tag <Text> 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 eBank, naturalmente isso só pode ocorrer se um desenvolvedor do eBank solicitar esta tag no XML para facilitar depuração de código.
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"?> <MessageBrokerResponse> <Status>1</Status> <Motivo>Mensagem enviada com sucesso.</Motivo> <messageID>wamid.HBgMNTU0NDkxNDIzMDc4FQIAERgSMjAyQTNGMDczMjhGMUE0NTI1AA==</messageID> </MessageBrokerResponse>
- 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.
- A tag <Status> é o status da mensagem tendo os valores:
