Registre seu serviço no painel do desenvolvedor de emails acionáveis

  • Artigo

Importante

A integração de novos provedores de Mensagens Acionáveis com um escopo Global está temporariamente pausada até 30 de junho de 2024 devido a atualizações de serviço. Os provedores de escopo global existentes e a integração de provedores de escopo de organização e teste não são afetados. Para obter mais detalhes, confira Perguntas frequentes para Mensagens Acionáveis.

Para testar e publicar acionáveis mensagens a partir do seu serviço, você precisa fornecer determinadas informações à Microsoft para a habilitação dessa funcionalidade para emails do seu serviço. O painel do desenvolvedor ajuda você a enviá-las e acompanhar o status do seu envio por meio do portal da Web.

Observação

Você pode facilmente experimentar mensagens acionáveis por email enviando email para si mesmo com a marcação necessária sem qualquer intervenção da Microsoft. Geralmente, esta é a primeira etapa a ser testada antes de se aprofundar nesse recurso. Confira esses exemplos para enviar uma mensagem acionável para sua caixa de correio ou use a mensagem acionável Designer para enviar uma mensagem acionável para si mesmo.

Se você é um desenvolvedor que trabalha com mensagens acionáveis por email, use o portal nos seguintes casos:

  • Para testar mensagens acionáveis do seu serviço para sua própria caixa de correio
  • Para publicar mensagens acionáveis do seu serviço de modo que qualquer usuário de email da sua organização que use o Office 365 possa receber essas mensagens especialmente formatadas (isso costuma ser usado para habilitar mensagens acionáveis de um serviço específico para sua organização, como um aplicativo de linha de negócios)
  • Para publicar mensagens acionáveis do seu serviço, de forma a que qualquer usuário de email no Office 365 que use seu serviço possa receber essas mensagens especialmente formatadas

Em todos os casos acima, você enviará certos detalhes para a Microsoft, que os analisará e os aprovará, para depois habilitar as mensagens acionáveis em seu serviço.

Seções do painel

O painel do desenvolvedor é dividido em algumas seções lógicas que você precisa preencher com base no escopo desejado para solicitar à Microsoft a habilitação das mensagens acionáveis em seu serviço.

Dados do provedor

Nesta seção, você precisa fornecer detalhes importantes que permitirão que o Office 365 aceite emails com marcação do seu serviço, bem como URLs que possam ser invocadas por meio dos botões de ação desses emails.

Os principais campos são:

  • Endereço de email do remetente: trata-se de um ou mais endereços de email estáticos correspondentes ao serviço que enviará emails com marcação de ação. Exemplo: myservice@contoso.com.

  • URLs de destino: trata-se de um ou mais domínios correspondentes a URLs que processarão as ações. Sua URL de destino pode corresponder ao domínio de nível superior ou ao sub domínio do TLD. Ela precisa ser habilitada para https. Exemplo. https://api.myservice.com.

  • Chave pública: se você planeja enviar mensagens acionáveis como cartão assinado, é necessário especificar a chave pública correspondente à chave privada que você usará para assinar o cartão. O formato deste campo é um elemento RSAKeyValue.

    <RSAKeyValue>
  <Modulus>xA7SEU+e0yQ...</Modulus>
  <Exponent>AQAB</Exponent>
</RSAKeyValue>

Um par de chaves RSA pode ser gerado e exportado no formato correto usando o PowerShell (7.3 ou posterior):

# Generate a key pair:
$rsa = [System.Security.Cryptography.RSA]::Create();

# Private Key, ensure this is saved securely and kept secret:
$rsa.ToXmlString($true)

## Public Key, copy output to dashboard:
$rsa.ToXmlString($false)

Para obter um exemplo de como obter XML de chave pública de um arquivo .cert, consulte Classe PublicKey.

Observação

Depois que seu envio for aprovado, pode levar algum tempo para entrar em vigor. Se você encontrar o erro abaixo ao enviar cartões assinados e tiver certeza de que sua carga está correta, tente novamente após algumas horas.

Adaptive card signature validation failed - Failed to validate signature

Escopo do envio

Nesta seção, você precisa especificar em qual escopo deseja habilitar as mensagens acionáveis em seu serviço. Os escopos aplicáveis são:

  • Usuários de teste: permite emails acionáveis do seu serviço para alguns dos usuários de email do O365 na sua organização. Este escopo é, geralmente, usado para testar a integração de mensagens acionáveis com alguns usuários de teste especificados.
  • Organização: Permite mensagens acionáveis de um serviço para qualquer usuário de email do Microsoft 365 dentro da sua organização. Geralmente, esse escopo é usado para habilitar mensagens acionáveis de um serviço específico da sua organização, como um aplicativo de linha de negócios interno.
  • Global: habilita o envio de mensagens acionáveis do seu serviço para qualquer usuário de email do Office 365.

Cada uma das etapas acima são independentes. Ou seja, você pode escolher apenas um escopo para cada envio e estará sujeito ao processo de aprovação pela Microsoft.

Observação

Lembre-se de que você pode facilmente experimentar mensagens acionáveis enviando um email para si mesmo com a marcação necessária sem qualquer intervenção da Microsoft. Você pode usar a mensagem acionável Designer para enviar a si mesmo sem escrever nenhum código. Geralmente, essa é a primeira etapa para testar mensagens acionáveis.

Registro de autoatendimento

O autoatendimento de registros está disponível para os registros com os seguintes escopos.

  • Usuários de teste: a solicitação de registro é aprovada automaticamente para os usuários de teste especificados. Permitirá o envio de emails acionáveis do seu serviço para usuários de teste.
  • Organização: esta solicitação de registro será enviada para os administradores da organização com permissões de Administrador do Exchange. Qualquer administrador com essas permissões receberá um e-mail com detalhes de envio e poderá analisar e aprovar a solicitação. Se nenhum usuário tiver função de Administrador do Exchange atribuída, os usuários com a funçã de Administrador global receberão esse e-mail.

Depois que o envio for aprovado, seja aprovado automaticamente ou pelo administrador, levará até 24 horas para que o registro entre em vigor.

Para registros de Minha organização, as contas de administradores receberão um email e o remetente também será copiado. Isso permitirá que você contate seu administrador se precisar fornecer mais detalhes ou esclarecimentos. Depois que a solicitação for aprovada, o remetente e os administradores serão notificados com outro email.

Após 24 horas, você pode verificar se o registro entrou em vigor enviando uma mensagem acionável de seu serviço para sua caixa de correio ou usuários de teste especificados (para escopo de Usuários de Teste ) ou qualquer caixa de correio do usuário em sua organização (para escopo da Organização ). Se 24 horas se passaram e o registro ainda não estiver em vigor, entre em contato conosco usando o link de comentários na parte superior do registro dashboard registro rotulado Registro não funcionando?.

Endereços de email de usuários de teste

Esta seção só é aplicável quando seu escopo de envio para permitir mensagens acionáveis é Usuários de teste.

Nesta seção, forneça uma lista de usuários de email do Microsoft 365 da sua organização, separados por ponto e vírgula (;). Isso ajudará você a testar a integração de mensagens acionáveis em alguns usuários, antes de criar um envio de escopo de Organização ou Global.

Informações de contato

Esta seção só é aplicável quando seu escopo de envio para a habilitação de mensagens acionáveis é Global.

Nesta seção, você precisará fornecer dados do contato, para podermos entrar em contato com você se tivermos mais perguntas sobre o envio. Todas as informações fornecidas devem ser válidas e corretas.

Informações do fornecedor

Esta seção só é aplicável quando seu escopo de envio para a habilitação de mensagens acionáveis é Global.

Nesta seção, você precisa fornecer dados sobre o serviço que enviará mensagens acionáveis e informações de apoio relacionadas, para que possamos entrar em contato com você ou encaminhar os clientes ao seu site de suporte. Essas informações também serão usadas como parte do processo de aprovação pela Microsoft para o seu provedor.

Dados do cenário

Esta seção só é aplicável quando seu escopo de envio para a habilitação de mensagens acionáveis é Global.

Nesta seção, você precisa fornecer dados sobre o cenário nos quais os usuários receberão mensagens acionáveis do seu serviço e outros detalhes relevantes. Esses dados ajudam a Microsoft a determinar a validade e utilidade da solução fornecida pelo seu serviço.

Dados da verificação

Esta seção só é aplicável quando seu escopo de envio para a habilitação de mensagens acionáveis é Global.

Nesta seção, você precisa fornecer dados para que a Microsoft verifique a mensagem acionável e as ações correspondentes invocadas do email enviado pelo seu provedor/serviço.

Além disso, envie um email válido proveniente de seus servidores de produção (ou um servidor com DKIM/SPF/From:/Return-Path: cabeçalhos) incluindo a marcação para onboardoam@microsoft.com. Esse procedimento permitirá que a Microsoft determine que a solução esteja em conformidade com todas as diretrizes e requisitos listados em Critérios de Registro.

  • Verifique se a marcação está correta antes de enviar o email.
  • O Office 365 remove todas as marcações ao encaminhar um email. Não encaminhe o email, envie-o diretamente.

Critérios de registro

Lembre-se de alguns pontos ao enviar sua solução para aprovação no escopo Global, pois ela pode ter um impacto significativo sobre os usuários do Office 365.

Diretrizes de qualidade para o remetente do email

  • É preciso autenticar emails por DKIM ou SPF.
  • O domínio primário (TLD) da verificação de SPF ou da assinatura DKIM deve corresponder ao TLD do seu endereço de email From:. Por exemplo, se você usar From: myservice@contoso.com, a DKIM ou SPF deve ser para contoso.com ou -.contoso.com.
  • Os emails devem vir de um endereço estático, por exemplo, myservice@contoso.com.
  • Os emails devem seguir as diretrizes para remetente de email.
  • O histórico consistente do envio de um grande volume de emails do seu domínio (ordem de centenas emails por dia para o Office 365) por algumas semanas, pelo menos.
  • Uma taxa muito baixa de reclamações de spam por parte dos usuários.
  • Devem ser usadas ações simples, rotineiras e de alta fidelidade no seu serviço. Em caso de interações mais complexas, é possível usar ações OpenURI.
  • As ações devem ser usadas em emails transacionais em que uma alta taxa de interação é esperada. Não use em emails promocionais em massa.

Diretrizes para ações

  • O rótulo do botão precisa refletir claramente a ação a ser realizada.
  • A ação Action.OpenUrl deve criar um link profundo com a página específica associada à entidade/informação apresentada na mensagem acionável.
  • Baixa taxa de falhas e resposta rápida em serviços que lidam com solicitações de ação.
  • Confira Criando cartões de mensagens acionáveis do Outlook com o formato Cartão Adaptável para diretrizes adicionais sobre a criação de mensagens acionáveis.

Aprovação do envio

Notificaremos você pelo endereço de email fornecido durante o envio, portanto, forneça as informações de contato corretas.