Interface IEnvioEmailServico

Esse serviço disponibiliza funcionalidades relacionadas ao envio de e-mail.

Importante

Por padrão esse serviço será iniciado no caminho SDE/Email. Para maiores informações sobre a composição da URL dos webservices clique aqui

Métodos

ConsultarSituacaoEnvioEmail(String, String, Int32, Int32, String)

Consulta a situação de envio de e-mail de um determinado documento.

  			[OperationContract]
IRetornoRequisicaoSde ConsultarSituacaoEnvioEmail(string usuario, string senha, int tipoDocumento, int tipoOperacao, string chave)
  		
Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.

System.String senha

Senha configurada na empresa para acesso ao webservice.

System.Int32 tipoDocumento

Tipo de documento a ser consultado. Para os possíveis valores ver TipoDocumentoEletronico.

System.Int32 tipoOperacao

Indica ao sistema se o e-mail a ser consultado deve ser de um documento ou evento. Os valores suportados são 1 - Emissão e 72 - Carta de correção.

System.String chave

Chave/identificador do documento a ser consultado.

Retorno
IRetornoRequisicaoSde

Sempre será retornado uma instância de RetornoIntegracaoGenerico, em caso de erro o campo Sucesso estará com o valor false e serão retornados um código e mensagem de erro. Caso o sistema consiga consultar a situação de envio de e-mail do documento o campo Sucesso será retornado com o valor true e o campo Codigo irá indicar a a situação de e-mail do documento por um dos seguintes códigos:

  • 10000
  • 10001
  • 10002
  • 10003
  • 10004

Para consultar os códigos de retorno do sistema clique aqui.

Exemplos
  • Requisição
  • Resposta erro
  • Resposta com XMLs

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe:ConsultarSituacaoEnvioEmail>
      <nfe:usuario>usuario</nfe:usuario>
      <nfe:senha>senha</nfe:senha>
      <nfe:tipoDocumento>1</nfe:tipoDocumento>
      <nfe:tipoOperacao>1</nfe:tipoOperacao>
      <nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
    </nfe:ConsultarSituacaoEnvioEmail>
  </soapenv:Body>
</soapenv:Envelope>

Exemplo da resposta com algum erro na requisição:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <ConsultarSituacaoEnvioEmailResponse xmlns="http://www.senior.com.br/nfe">
      <ConsultarSituacaoEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Codigo>10014</Codigo>
        <Mensagem>Usuário e/ou senha incorretos.</Mensagem>
        <Sucesso>false</Sucesso>
      </ConsultarSituacaoEnvioEmailResult>
    </ConsultarSituacaoEnvioEmailResponse>
  </s:Body>
</s:Envelope>

Exemplo da resposta quando o documento é consultado com sucesso:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <ConsultarSituacaoEnvioEmailResponse xmlns="http://www.senior.com.br/nfe">
      <ConsultarSituacaoEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Codigo>10002</Codigo>
        <Mensagem>Somente alguns e-mails vinculados ao documento ou evento foram enviados com sucesso.</Mensagem>
        <Sucesso>true</Sucesso>
      </ConsultarSituacaoEnvioEmailResult>
    </ConsultarSituacaoEnvioEmailResponse>
  </s:Body>
</s:Envelope>

MarcarEnvioEmail(String, String, Int32, Int32, String, IList<String>, Boolean, List<Arquivo>, String)

Permite a marcação de envio de email para um determinado documento no sistema.

  			[OperationContract]
IRetornoRequisicaoSde MarcarEnvioEmail(string usuario, string senha, int tipoDocumento, int tipoOperacao, string chave, IList<string> enderecosEnvio, bool enviarBoleto, List<Arquivo> arquivos, string conteudoAdicional)
  		
Parâmetros
System.String usuario

Usuário configurado na empresa para acesso ao webservice.

System.String senha

Senha configurada na empresa para acesso ao webservice.

System.Int32 tipoDocumento

Tipo de documento que será enviado o email. Para os possíveis valores ver TipoDocumentoEletronico.

System.Int32 tipoOperacao

Indica ao sistema se o e-mail a ser marcado deve ser de um documento ou evento. Os valores suportados são 1 - Emissão e 72 - Carta de correção.

System.String chave

Chave/identificador do documento referente ao e-mail.

System.Collections.Generic.IList<System.String> enderecosEnvio

Endereços que devem receber o e-mail.

System.Boolean enviarBoleto

Indica se deve ser enviado o boleto junto ao documento ou não, somente disponível para NF-e, NFS-e e CT-e.

System.Collections.Generic.List<Arquivo> arquivos

Lista de arquivos que será enviado por e-mail.

System.String conteudoAdicional

Conteúdo adicional que será incluído no final do corpo do e-mail. Esta informação não será enviada, caso o email seja de transportadora.

Retorno
IRetornoRequisicaoSde

Sempre será retornado uma instância de RetornoIntegracaoGenerico, em caso de erro o campo Sucesso estará com o valor false e serão retornados um código e mensagem de erro. Caso o sistema consiga marcar o envio de e-mail para o documento o campo Sucesso estará com o valor true.

Exemplos
  • Requisição
  • Resposta erro
  • Resposta com XMLs

Exemplo da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfe="http://www.senior.com.br/nfe" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <soapenv:Header/>
  <soapenv:Body>
    <nfe:MarcarEnvioEmail>
      <nfe:usuario>usuario</nfe:usuario>
      <nfe:senha>senha</nfe:senha>
      <nfe:tipoDocumento>1</nfe:tipoDocumento>
      <nfe:tipoOperacao>1</nfe:tipoOperacao>
      <nfe:chave>00000000000000000000000000000000000000000000</nfe:chave>
      <nfe:enderecosEnvio>
        <arr:string>teste@senior.com.br</arr:string>
      </nfe:enderecosEnvio>
      <nfe:enviarBoleto>true</nfe:enviarBoleto>
    </nfe:MarcarEnvioEmail>
  </soapenv:Body>
</soapenv:Envelope>

Exemplo da resposta com algum erro na requisição:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <MarcarEnvioEmailResponse xmlns="http://www.senior.com.br/nfe">
      <MarcarEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Codigo>10014</Codigo>
        <Mensagem>Usuário e/ou senha incorretos.</Mensagem>
        <Sucesso>false</Sucesso>
      </MarcarEnvioEmailResult>
    </MarcarEnvioEmailResponse>
  </s:Body>
</s:Envelope>

Exemplo da resposta quando o documento é marcado para o envio de e-mail:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <MarcarEnvioEmailResponse xmlns="http://www.senior.com.br/nfe">
      <MarcarEnvioEmailResult i:type="RetornoIntegracaoGenerico" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Sucesso>true</Sucesso>
      </MarcarEnvioEmailResult>
    </MarcarEnvioEmailResponse>
  </s:Body>
</s:Envelope>
Generated by DocFX