Notificações push VoIP

• Registrar tokens VoIP em seu aplicativo usando o Apple PushKit
• Criar um aplicativo OneSignal dedicado com um certificado VoIP Services
• Registrar tokens e enviar pushs pela API REST do OneSignal

​

Diferenças de plataforma

​

iOS: enviar notificações push VoIP

1

Registrar um token VoIP usando PushKit

Use o framework PushKit da Apple para se registrar para notificações VoIP e receber um token VoIP.

• Implemente o PushKit em seu aplicativo
• Armazene e atualize o token VoIP conforme a Apple o alterna
• Siga atentamente as políticas de VoIP da Apple

Exemplo: implementação do delegate PushKit

import PushKit

class AppDelegate: NSObject, PKPushRegistryDelegate {
    func registerForVoIPPushes() {
        let registry = PKPushRegistry(queue: .main)
        registry.delegate = self
        registry.desiredPushTypes = [.voIP]
    }

    func pushRegistry(_ registry: PKPushRegistry, didUpdatePushCredentials credentials: PKPushCredentials, for type: PKPushType) {
        let token = credentials.token.map { String(format: "%02x", $0) }.joined()
        // Pass this token to OneSignal — see Step 4
    }
}

Este é o código padrão do Apple PushKit. O OneSignal não fornece um SDK para PushKit — você registra o token você mesmo e o passa para o OneSignal na Etapa 4.

Recursos da Apple:

• Documentação do PushKit
• Respondendo a pushs VoIP
• Melhores práticas de VoIP da Apple

2

Criar um aplicativo OneSignal separado para VoIP

Os pushs VoIP do iOS requerem um tipo de certificado diferente das notificações push padrão. Um único aplicativo OneSignal pode usar apenas um tipo de certificado, portanto você deve criar dois aplicativos OneSignal separados:

• Aplicativo Push Principal: Usa seu certificado APNs para notificações push padrão
• Aplicativo Push VoIP: Usa um certificado VoIP Services para notificações exclusivamente VoIP

Ambos os aplicativos devem usar o mesmo bundle ID do iOS e estar associados ao mesmo aplicativo iOS nativo. Você não precisa inicializar o SDK do OneSignal duas vezes — o aplicativo VoIP é usado apenas no lado do servidor para enviar pushs VoIP via API.

O bundle ID (ex.: com.suaempresa.nomedoapp) é encontrado no Xcode na aba General do seu target.

3

Fazer upload de um certificado VoIP Services

No seu aplicativo VoIP do OneSignal, faça upload de um Certificado VoIP Services (.p12). Este é um tipo de certificado diferente do certificado APNs push padrão usado para notificações regulares.Para criar um:

1. Acesse o Portal do Desenvolvedor Apple
2. Selecione VoIP Services Certificate
3. Siga as instruções para gerar e baixar o certificado
4. Abra-o no Keychain Access e exporte-o como arquivo .p12
5. Faça upload do arquivo .p12 nas configurações de iOS do seu aplicativo VoIP do OneSignal

Não faça upload do seu certificado APNs push padrão no aplicativo VoIP. Se você usar o tipo de certificado errado, a API aceitará sua solicitação de push, mas a Apple a rejeitará e a notificação nunca chegará.

4

Registrar o token VoIP com o OneSignal

Use a API Create User para registrar o token VoIP com seu aplicativo VoIP do OneSignal.

Compilações sandbox/desenvolvimento requerem "test_type": 1. Se você omitir este campo, a chamada da API tem sucesso e não retorna erro, mas a Apple trata o token como produção e rejeita silenciosamente todos os pushs enviados para ele.

curl --request POST \
     --url https://api.onesignal.com/apps/YOUR_VOIP_APP_ID/users \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "subscriptions": [
    {
      "type": "iOSPush",
      "token": "YOUR_VOIP_TOKEN",
      "test_type": 1
    }
  ]
}
'

Um token VoIP válido é uma string hexadecimal minúscula de 64 caracteres (ex.: a1b2c3d4e5f6...). O PushKit não funciona no Simulador do iOS — você deve usar um dispositivo real para obter um token válido.

Para atualizar o token posteriormente, use a API Update Subscription.

5

Enviar notificações VoIP

Use a API Create Notification com os seguintes parâmetros:

• "apns_push_type_override": "voip" — informa à Apple que este é um push VoIP
• app_id — o ID do seu aplicativo VoIP
• include_subscription_ids — o ID de assinatura VoIP que você registrou
• contents ou content_available é obrigatório

curl --include \
     --request POST \
     --header "Content-Type: application/json; charset=utf-8" \
     --header "Authorization: key YOUR_REST_API_KEY" \
     --data-binary '{
  "app_id": "YOUR_VOIP_APP_ID",
  "content_available": true,
  "data": {
    "your_custom_data": "your_custom_value"
  },
  "apns_push_type_override": "voip",
  "include_subscription_ids": ["YOUR_VOIP_SUBSCRIPTION_ID"]
}' \
https://api.onesignal.com/notifications

6

Verificar sua configuração VoIP

Sua integração VoIP do iOS está funcionando corretamente se:

1. O token VoIP aparece como uma assinatura de push do iOS no seu aplicativo VoIP
2. Um push VoIP aciona pushRegistry(_:didReceiveIncomingPushWith:for:completion:) em seu aplicativo
3. O aplicativo desperta mesmo quando está encerrado ou em segundo plano

​

Android: simular comportamento estilo VoIP

• Notificações push somente de dados
• Serviços em primeiro plano
• Interface de usuário personalizada estilo chamada

• Enviar notificações somente de dados
• Tratá-las em seu aplicativo para:
  • Iniciar um serviço em primeiro plano
  • Iniciar uma atividade de interface de chamada
  • Exibir uma notificação personalizada de chamada recebida

• Guia de aplicativo de chamadas do Android
• Exemplo de interface de chamada recebida

​

Perguntas frequentes

​

As entregas confirmadas funcionam com VoIP?

pushRegistry(_:didReceiveIncomingPushWith:for:completion:)

​

Posso enviar notificações VoIP pelo painel do OneSignal?

​

Por que meu push VoIP está falhando silenciosamente?

1. Você está usando uma compilação sandbox/desenvolvimento? Você deve incluir "test_type": 1 ao registrar o token pela API Create User. Sem isso, o token é registrado como produção, a Apple rejeita o push e ele falha silenciosamente.
2. Você fez upload do certificado correto? O aplicativo VoIP do OneSignal deve usar um Certificado VoIP Services (.p12), não um certificado APNs push padrão. Ambos parecem semelhantes no Keychain Access — verifique se o nome do certificado começa com “VoIP Services”.
3. Você está enviando para o aplicativo OneSignal correto? O app_id na sua solicitação de envio deve ser o seu aplicativo VoIP, não o seu aplicativo de push principal. A REST API Key também deve vir do aplicativo VoIP.
4. O token VoIP é válido? Os tokens expiram quando o aplicativo é reinstalado ou o dispositivo é restaurado. Verifique se o token é uma string hexadecimal minúscula de 64 caracteres e foi registrado recentemente.
5. Seu aplicativo chama reportNewIncomingVoIPPushPayload? A partir do iOS 13, a Apple encerra aplicativos que recebem um push VoIP, mas não reportam uma chamada ao CallKit. Este é um requisito da Apple, não uma limitação do OneSignal.

​

Páginas relacionadas