Envio direto
Envia uma notificação diretamente para um identificador de dispositivo (um token válido, conforme expresso pelo tipo de notificação ). Os usuários dessa API não precisam usar registros ou instalações. Em vez disso, você gerencia todos os dispositivos por conta própria e usa os Hubs de Notificação do Azure apenas como um serviço de passagem para se comunicar com os vários Serviços de Notificação por Push.
Importante
O Firebase Cloud Messaging (FCM) é um serviço que, entre outras coisas, facilita o envio de notificações por push para dispositivos Android compatíveis com o Google Play. Atualmente, os Hubs de Notificação do Azure se comunicam com a FCM por meio do protocolo HTTP herdado. A FCM v1 é uma API atualizada que oferece mais recursos e funcionalidades. O Google anunciou que está substituindo o HTTP herdado da FCM e deixará de dar suporte a ele em 20 de junho de 2024. Portanto, os desenvolvedores que usam os Hubs de Notificação do Azure para se comunicar com dispositivos Android compatíveis com o Google Play hoje precisarão migrar seus aplicativos e cargas de notificação para o formato mais recente. Os Hubs de Notificação do Azure continuarão a dar suporte ao HTTP herdado da FCM até que o Google pare de aceitar solicitações. Depois que a nova integração de FCM for concluída, os Hubs de Notificação do Azure anunciarão quando você puder começar a migrar. Para obter mais detalhes, consulte as etapas de migração neste artigo.
Solicitação
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| POST | https://{namespace}.servicebus.windows.net/{NotificationHub}/messages/?direct&api-version=2015-04 |
HTTP/1.1 |
Cabeçalhos da solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
| Cabeçalho da solicitação | Descrição |
|---|---|
| Autorização | Token SAS gerado conforme especificado na Autenticação de Assinatura de Acesso Compartilhado com o Barramento de Serviço. |
| Tipo de conteúdo | Defina o cabeçalho Content-Type com base no serviço de notificação da plataforma de destino:
|
| ServiceBusNotification-DeviceHandle | O identificador do dispositivo PNS. |
| ServiceBusNotification-Tags | {identificador de marca única} (opcional) |
| ServiceBusNotification-Format | Defina como um dos seguintes valores válidos de PlatformType: windows, apple, gcm, windowsphone, adm, , nokiaxbaidu |
| x-ms-version | 2015-04 (com suporte em 2015-01 e posterior) |
Corpo da solicitação
Com base no tipo de plataforma, o corpo da solicitação formata alterações. Consulte os formatos de corpo para cada plataforma individual em APIs REST de envio nativas.
- Enviar uma notificação nativa de APNS
- Enviar uma notificação nativa do FCM
- Enviar uma notificação nativa do GCM
- Enviar uma notificação nativa do MPNS
- Enviar uma notificação nativa do WNS
Resposta
A resposta inclui um código de status HTTP e um conjunto de cabeçalhos de resposta. O corpo da resposta é retornado com êxito.
Códigos de resposta
| Código | Descrição |
|---|---|
| 201 | Mensagem enviada com êxito. |
| 400 | A solicitação está malformada (por exemplo, cabeçalhos de roteamento não válidos, tipo de conteúdo inválido, mensagem excede o tamanho, formato de mensagem inválido). |
| 401 | Falha de autorização. A chave de acesso estava incorreta. |
| 403 | Cota excedida ou mensagem muito grande; mensagem foi rejeitada. |
| 404 | Nenhum branch de mensagem no URI. |
| 413 | Entidade solicitada muito grande. O tamanho da mensagem não pode ter mais de 64 Kb. |
Para obter informações sobre códigos de status, consulte Códigos de status e de erro.
Cabeçalhos de resposta
Ao usar HTTP 1.1, os comentários PNS não funcionam ao usar a autenticação baseada em certificado; ele não retorna nenhum dado. Ao usar a autenticação baseada em token.
| Cabeçalho de resposta | Descrição |
|---|---|
| Tipo de conteúdo | application/xml; charset=utf-8 |
| Localização | Esse cabeçalho só está disponível para Hubs de Notificação da camada Standard. Esse cabeçalho contém a ID da mensagem de notificação. Ele é usado com telemetria por mensagem: obter telemetria de mensagem de notificação e correlacionar comentários PNS. O cabeçalho de local usa o seguinte formato: https://{your namespace}.servicebus.windows.net/{your hub name}/messages/{notification message id}?api-version=2015-04. |
Corpo da resposta
Nenhum.