Mail API

A Mail API permite o envio de SMS, RCS e em breve também mensagens de voz através da seven por e-mail. Envie um e-mail para o gateway, que será automaticamente convertido em uma mensagem por nós. Através de vários parâmetros, você pode controlar o envio de forma direcionada e também enviar mensagens para contatos ou grupos.

Configuração

No seu login na área de Desenvolvedor em Mail API, você pode configurar a API para sua conta. Você pode especificar quantos endereços de remetente desejar, cada um com uma chave diferente.

  1. 1

    Configurar endereço do remetente

    Através do ícone verde + no canto inferior direito da área Mail API, você acessa a janela onde pode criar um novo endereço de remetente.

  2. 2

    Definir chave

    Você deve escolher uma chave para cada endereço de e-mail, que tornará o envio mais seguro. Você pode escolher a chave livremente, mas apenas letras maiúsculas e minúsculas, números e os caracteres especiais hífen, sublinhado e cifrão são permitidos.

  3. 3

    Tratamento de erros

    Aqui você também pode especificar um endereço de e-mail opcional para receber mensagens de erro. Se você não especificar, receberá as mensagens de erro no endereço do remetente, se ativar a função "Notificar em caso de erros" nas configurações (veja abaixo). Novos remetentes configurados estão disponíveis imediatamente após o salvamento.

  4. 4

    Configurações

    Clicando nas engrenagens azuis, você acessa as opções de configuração para a Mail API.

Configurações Mail API

  • Comprimento máximo: Defina um número máximo de caracteres para evitar mensagens muito longas devido ao envio de assinaturas. Insira 0 para desativar esta função.
  • Remover citações: Se ativado, a API tentará remover automaticamente o texto citado no e-mail.
  • Notificar em caso de erro: Esta opção determina se você deseja receber uma notificação por e-mail em caso de erros. Se, por exemplo, o envio da mensagem falhar ou dados como número, chave, etc., estiverem incorretos ou ausentes em seu e-mail, enviaremos diretamente um e-mail com informações sobre o erro. Ao criar um novo endereço de remetente, você pode opcionalmente especificar um endereço de e-mail alternativo para receber as mensagens de erro.
  • Incluir remetente do e-mail no texto: Aqui você pode definir se deseja enviar uma parte do endereço de e-mail no início da sua mensagem. Você pode escolher entre três opções:
ConfiguraçõesExplicação
Endereço completoInsere o endereço completo, por exemplo, "umusuario@dominio.de"
Parte local do endereçoPor exemplo, em umusuario@dominio.de será inserido "umusuario"
NãoNão envia o endereço do remetente

Enviar mensagem

Estrutura do e-mail

Por favor, use o formato descrito abaixo para seus e-mails ao nosso gateway. Caso sua aplicação não possa ser ajustada para enviar e-mails neste formato, entre em contato conosco – a API de e-mail é flexivelmente ajustável!

Destinatário

Para enviar uma mensagem através da API de e-mail, envie um e-mail para destinatario@gateway.seven.io substituindo destinatario pelo número do destinatário ou pelo nome do contato do seu catálogo de endereços.

Por exemplo, se você deseja enviar uma mensagem para o número 01761234567890, o destinatário deve ser 01761234567890@gateway.seven.io.

Assunto

No assunto, insira os parâmetros necessários para controlar o envio da mensagem. Estes devem ser separados por um espaço. Para definir um parâmetro, escreva o nome do parâmetro seguido de um sinal de igual e o valor do parâmetro.

Por exemplo, com umParametro=umValor, o parâmetro umParametro é definido como umValor. Se o parâmetro contiver espaços, você deve colocá-lo entre aspas duplas – por exemplo, umParametro="Um valor com espaços".

Conteúdo

O texto da mensagem deve ser enviado no corpo do e-mail. O gateway utiliza primeiro a parte text/plain do e-mail. Se o e-mail contiver apenas uma parte text/html sem alternativa de texto, tentará analisar e extrair o texto do conteúdo HTML. Naturalmente, este método nem sempre funciona como desejado.

Você pode opcionalmente envolver o texto da mensagem com ## para evitar que linhas vazias ou a assinatura do e-mail sejam incluídas na mensagem. O texto ficaria assim: ##Este é o texto## - apenas a parte entre ##...## será enviada na mensagem.

Parâmetros

Todos os parâmetros são especificados no assunto do e-mail, conforme mencionado acima. Se não for possível alterar o assunto do e-mail, você pode especificar os parâmetros no endereço do destinatário da seguinte forma:

  • 01761234567890.from=ZahnPraxis@gateway.seven.io
  • 01761234567890.from=ZahnPraxis.type=rcs@gateway.seven.io
  • key=MAIL_API_KEY.from=ZahnPraxis.to=01761234567890@gateway.seven.io

Aqui está uma visão geral dos possíveis parâmetros:

  • Name
    key
    Type
    string
    Optional
    Optional
    Description
    A chave de acesso que você especificou nas configurações da sua Mail-API para o respectivo e-mail do remetente.
  • Name
    from
    Type
    string
    Optional
    Optional
    Description
    O remetente da mensagem. Se nada for especificado aqui, o remetente padrão das suas configurações de SMS será usado. São permitidos até 11 caracteres alfanuméricos ou até 16 caracteres numéricos.
  • Name
    to
    Type
    string
    Optional
    Optional
    Description
    O destinatário da mensagem. Este parâmetro substitui, se especificado, o destinatário que foi especificado no endereço do destinatário do e-mail. Assim, você poderia enviar um e-mail para acme-inc@gateway.seven.io com o parâmetro to=0176123456789. A mensagem será enviada para 0176123456789.
  • Name
    label
    Type
    string
    Optional
    Optional
    Description
    Opcionalmente, defina um rótulo próprio para cada mensagem para poder identificá-las em suas estatísticas. Se não especificado, o remetente do e-mail será usado automaticamente como rótulo. Caracteres permitidos: a-z, A-Z, 0-9, .-_@
  • Name
    text
    Type
    string
    Optional
    Optional
    Description
    Se não for possível colocar o texto da mensagem no conteúdo do e-mail, você pode inseri-lo através do parâmetro text no assunto.
  • Name
    flash
    Type
    boolean
    Optional
    Optional
    Description
    Envie um SMS Flash, que é exibido diretamente na tela do destinatário e não é salvo. Apenas para o tipo de mensagem SMS.
  • Name
    unicode
    Type
    boolean
    Deprecated
    Deprecated
    Optional
    Optional
    Description
    Permite a codificação da mensagem como Unicode ou força GSM 03.38.
  • Name
    performance_tracking
    Type
    boolean
    Optional
    Optional
    Description
    Ativa nosso encurtador de URL e o Rastreamento de Performance para links encontrados no texto.
  • Name
    foreign_id
    Type
    string
    Optional
    Optional
    Description
    Forneça seu próprio ID para esta mensagem. Você receberá o foreign_id de volta em callbacks para relatórios de status, etc. Máx. 64 caracteres, caracteres permitidos: a-z, A-Z, 0-9, .-_@.
  • Name
    delay
    Type
    string
    Optional
    Optional
    Description
    Agenda o envio da mensagem para o futuro. Insira aqui um Unix Timestamp ou o momento no formato AAAA-MM-DD hh:mm:ss.
  • Name
    type
    Type
    enum
    Optional
    Optional
    Description
    Defina o tipo de mensagem que deseja enviar. As opções são sms (padrão), rcs e em breve também voice.

Segurança

O caminho de transporte entre os servidores SMTP individuais ou o cliente SMTP geralmente é criptografado por TLS. No entanto, por vários motivos, é sensato criptografar o e-mail, razão pela qual a API de e-mail suporta criptografia por PGP e S/MIME:

  1. Confidencialidade: PGP e S/MIME criptografam o conteúdo dos e-mails, de modo que apenas o destinatário pretendido pode descriptografá-los e lê-los. Isso garante a confidencialidade da comunicação.

  2. Autenticação: Ambos os padrões permitem verificar a identidade do remetente. Assinaturas digitais, criadas com a chave privada do remetente, permitem que o destinatário assegure-se de que o e-mail realmente veio da fonte indicada e não foi manipulado.

  3. Integridade: PGP e S/MIME oferecem mecanismos para verificar a integridade dos e-mails. Através de assinaturas digitais, o destinatário pode garantir que o conteúdo do e-mail não foi alterado desde o envio.

  4. Defesa contra ataques Man-in-the-Middle: Através da criptografia e autenticação, PGP e S/MIME ajudam a prevenir ataques Man-in-the-Middle, onde um invasor intercepta, manipula e depois retransmite o tráfego de dados sem que as partes envolvidas percebam.

No geral, PGP e S/MIME são, portanto, úteis para garantir a segurança, confidencialidade e integridade da comunicação por e-mail, especialmente em ambientes onde informações sensíveis ou confidenciais são trocadas.

Para um envio criptografado dos e-mails, por favor, baixe o respectivo certificado e instale-o em seu sistema. Como os certificados PGP e S/MIME só podem ser vinculados a um único endereço de e-mail, envie seus e-mails para o endereço de e-mail indicado abaixo para o certificado.

Dados como o destinatário da mensagem devem ser especificados no assunto através dos respectivos parâmetros, como por exemplo to=017612345678.

Este procedimento não é seguro, pois os dados são enviados nos cabeçalhos do e-mail sem criptografia. Já estamos trabalhando em uma solução alternativa.

Aqui você pode baixar o respectivo certificado:

PGP

Baixar certificado

Endereço de e-mail: gateway@gateway.seven.io

S/MIME

Baixar certificado

Endereço de e-mail: mail@gateway.sms77.io

DMARC, DKIM, SPF

DKIM, SPF e DMARC são mecanismos para melhorar a segurança de e-mails. Eles ajudam a verificar a autenticidade dos e-mails, combater spam e phishing, além de melhorar a entregabilidade dos e-mails.

A API de e-mail rejeita e-mails se eles não atenderem aos padrões de autenticação definidos pela sua configuração de DKIM, SPF e DMARC. Isso pode ocorrer, por exemplo, se um e-mail não tiver uma assinatura DKIM válida, se o endereço IP do remetente não estiver autorizado nos registros SPF ou se as políticas DMARC do proprietário do domínio preverem a rejeição de e-mails não autenticados.

Por favor, tenha isso em mente ao implementar a API de e-mail. Você pode visualizar e-mails rejeitados no seu Depurador.

Exemplos

Primeiro exemplo

No primeiro exemplo, uma SMS é enviada para o número 0163123456789 do remetente ZahnPraxis. A chave neste caso é email2sms_key.

Mail-para-SMS primeiro exemplo

O texto que deve ser transmitido na SMS é:

Olá Sr. Schubert, gostaríamos de lembrá-lo sobre sua consulta em 20 de janeiro em nosso consultório. Estamos ansiosos para vê-lo! Até lá, seu consultório odontológico

Segundo Exemplo

Neste segundo exemplo, uma SMS é enviada para o contato Bartscher do remetente Optiker. O número padrão 0163123456789, que está no destinatário do e-mail, é sobrescrito pelo parâmetro to. A chave aqui é 123456789.

Mail-zu-SMS segundo exemplo

O texto que deve ser transmitido na SMS é:

Olá Sra. Bartscher, seus óculos estão prontos! Por favor, venha buscá-los em breve. Estamos ansiosos para vê-la! Até lá, seu Optiker – a assinatura do e-mail abaixo não será enviada na SMS, pois o texto está delimitado por ##.

Terceiro Exemplo

Neste exemplo, uma SMS é enviada para o número 0163123456789. As configurações para o remetente são usadas a partir das configurações padrão da sua conta em Configurações > SMS. A chave está diretamente integrada no destinatário do e-mail e definida como abcd123456.

Mail-zu-SMS terceiro exemplo

O texto que deve ser transmitido na SMS é:

Olá Sra. Bartscher, seus óculos estão prontos! Por favor, venha buscá-los em breve. Estamos ansiosos para vê-la! Até lá, seu Optiker

A assinatura do e-mail abaixo não será enviada na SMS, pois o texto está delimitado por ##.

Legado

Por razões de compatibilidade retroativa, a API de e-mail permanece disponível no antigo endereço de destinatário email2sms@sms77.de para e-mails no formato da época. Os e-mails continuarão a ser processados como de costume. No entanto, recomendamos a mudança para esta nova API para aproveitar todas as funcionalidades.

Parece que não há conteúdo para traduzir. Por favor, cole o conteúdo MDX que você gostaria que eu traduzisse.