Oversigt over NPS-bekræftelsesproxy

Denne artikel beskriver, hvordan du konfigurerer en delt NPS til at bruge NPS-godkendelsesproxy, så den også kan bruges til at sende opkaldsmeddelelser til Webex-apps. Hvis din NPS ikke understøtter andre apps, kan du følge den forenklede procedure i Webex for BroadWorks-løsningsvejledningen https://help.webex.com/z9gt5j.

OVERSIGT OVER NPS-proxy

For kompatibilitet med Webex for BroadWorks skal dine NPS programrettelser for at understøtte funktionen NPS-proxy, Push-server til VoIP i UCaaS.

Funktionen implementerer et nyt design i Meddelelses-pushserveren for at løse sikkerhedsrisikoen ved deling af push-meddelelsescertifikat private nøgler med tjenesteudbydere til mobilklienter. I stedet for at dele push-meddelelsescertifikater og -nøgler med serviceudbyderen bruger NPS en ny API til at opnå et push-meddelelsestoken med kort varsel fra UCaaS-backend og bruger denne token til godkendelse med Apple APN'er og Google FCM-tjenester.

Funktionen forbedrer også muligheden for push-beskeder til push-beskeder til Android-enheder via den nye Google Firebase Cloud Messaging (FCM) HTTPv1 API.

Forudsætninger for NPS-bekræftelsesproxy

Den XSP (eller applikationsleveringsplatform ADP), som værter NPS skal opfylde følgende krav:

Minimumsversioner og begrænsninger for fællesopbevaring

  • NPS skal aktiveres på en dedikeret XSP/ADP og NPS skal være den eneste hostede applikation på serveren. Dette er for at fjerne interferens med levering af Push-meddelelser.

  • Der bør kun være én NPS-app i en implementering. Hvis du bruger mobil UC-One Samarbejd/Connect og eller UC-One SaaS og implementerer Webex til BroadWorks, skal du dele denne enkelte NPS for alle apps.

  • NPS skal være på version R22 eller nyere XSP eller ADP.

    R22/R23 XSP er kompatibel med en R21-stak, hvis XSP kun kører NPS og AS er R21. SP1. Se BroadWorks-kompatibilitetsmatrix for yderligere oplysninger.

  • Yderligere oplysninger om ADP-serveren kan findes på https://xchange.broadsoft.com/node/1051580.

Delte NPS

Læs disse noter, før du konfigurerer din delte NPS til at bruge NPS-proxy:

  • Hvis din NPS bruges med andre apps (ikke kun Webex-appen): Konfigurer først NPS-proxyen, og skift så NPS fra at bruge den FCM ældre API til at bruge FCM HTTP v1 API.

  • Når du har bekræftet, at underretninger fungerer korrekt for ældre apps med NPS proxy, skal du fjerne FCM API-nøglen til Android-appen og APN'er-godkendelsesnøglen til iOS-appen.

API'er HTTP/2

  • Hvis du har installeret iOS-apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere disse apps til at bruge HTTP/2 APNS-protokollen, før du konfigurerer NPS til at bruge NPS-proxy.

  • XSP/ADPs, der allerede understøtter Samarbejd eller SaaS BroadWorks-appen, skal overføres til HTTP/2. For detaljerede oplysninger om konfiguration af HTTP/2, se HTTP/2 Support til Meddelelse Push-server til APNS (migrering af NPS til at understøtte disse iOS-apps opsummeres i denne artikel).

Android FCMv1

  • Hvis du har installeret android-apps, der ikke er fra Cisco/BroadSoft, skal du konfigurere disse apps til at bruge FCMv1-tasterne, før du konfigurerer NPS til at bruge NPS-proxyen.

  • Hvis XSP/ADP i øjeblikket understøtter Connect eller UC-One SaaS-appen, skal du aktivere FCMv1-tasterne , efter du har konfigureret NPS-proxy. Vi anbefaler, at du migrerer alle yderligere apps til FCMv1-taster, aktiverer og tester og derefter deaktiverer, indtil du er klar til at fuldføre opsætningsvejledningen (migreringsstrømmen er dokumenteret i denne artikel).

NPS-proxymigrationsoversigt

Figur 1. Visuel oversigt over migrering til NPS-bekræftelsesproxy
Tabel 1. Oversigt over opgaver, der skal overføres til NPS-proxy

Sekvens

Opgavetitel

Hvornår/hvorfor er opgave påkrævet?

1

Migrer NPS til HTTP/2 for UC-One SaaS (eller Connect) iOS-apps.

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til HTTP/2.

2

Migrer NPS til FCMv1 for UC-One SaaS (eller Connect) Android-apps.

Hvis NPS understøtter disse apps, og de endnu ikke er konfigureret til FCMv1.

3

Aktivér FCMv1-tilstand, og test push-beskeder.

Hvis NPS understøtter UC-One Connect og/eller andre (ikke-Cisco) Android-apps.

4

Genaktiver FCM-ældre tilstand.

Hvis NPS understøtter UC-One SaaS. Hvis du forlader FCMv1 aktiveret, før du konfigurerer NPS proxy, push-underretninger til UC-One SaaS starter ikke.

5

Installer NPS-bekræftelsesproxyrettelser.

Hvis NPS er på XSP R22 eller XSP R23.

6

Konfigurer NPS til at bruge NPS-bekræftelsesproxy:

  • Vedhæft teknisk support fra NPS

  • Anmod om CI OAuth-konto

  • Opret CI-konto på NPS, og konfigurer timeout for genindlæsningstoken

  • Tilføj Android app-id'er

  • Tilføj iOS app-id'er

  • Kontrollér/indstil URL-adresser og forbindelses-timeouts

  • Tilføj apps til listen over AS-tilladte brugere

  • (Gen)) Aktiver FCMv1

  • Genstart XSP/ADP

  • Test PN'er til iOS- og Android-apps

Altid påkrævet.

7

Fjern FCM ældre tilstandsnøgler.

For apps, der understøttes af NPS på FCMv1.

Overfør BroadWorks samarbejd iOS-apps til HTTP/2

Denne opgave er obligatorisk for pushmeddelelser til UC-One SaaS og Webex-apps på iOS-platforme.

Før du begynder

Hvis din XSP kører med R22, skal du anvende ap354313, før du kan konfigurere NPS-applikationen til at bruge HTTP/2 til APNS.

1

Indstil produktions-URL-adressen og forbindelsesparametrene til XSP_CLI/Applications/NotificationPushServer/APNS/Production>

set url https://api.push.apple.com/3/device

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Bemærk: Indstil ikke forbindelsens timeout under 1000.
2

Tilføj applikations-it-erne i APNS-applikationerne, og sørg for at udelade auth-tasten – sæt den til tom.

For UC-One SaaS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.broadsoft.uc-one

For Webex-app: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared
3

Kontroller bese-tasterne med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get
4

Hvis be godd-tasten ikke er tom for com.broadsoft.uc-one, du kan rydde den med XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey
5

Aktiver HTTP/2:

XSP_CLI/Applications/NotificationPushServer/APNS/GeneralSettings> set HTTP2Enabled true
6

Kun for UC-One SaaS-apps: Log ind på forhandlerportalen, og gå til Konfiguration > BroadWorks > .

7

Rul ned til afsnittet Push-server med meddelelser, og vælg din udgivelse (f.eks. udgivelse 22), og følg vejledningerne i portalen.

Overfør BroadWorks UC-One Connect/SaaS Android-apps til FCMv1

  • Denne opgave gælder for NPS på XSP. Ignorer den, hvis din NPS er på ADP.

  • Du kan bruge denne procedure til overflytning til FCMv1-meddelelser for UC-One Connect eller UC-One SaaS Android-apps.

  • Du skal bruge FCMv1, hvis du vil bruge NPS-proxyen til at godkende push-meddelelser til UC-One eller Webex Android-apps.

  • Denne opgave forbereder NPS for FCMv1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMv1, før du er klar til at konfigurere NPS-godkendelsesproxy, eller underretninger til SaaS-klienter vil mislykkes.

1

Få projekt-id fra Firebase-konsol:

  1. Log ind på console.firebase.google.com.

  2. Vælg UC-One (Connect eller SaaS)-app projektet, åbn dets projektindstillinger.

  3. Åbn fanen Generelt , og optag projekt-id.
2

Få din servicekontos private nøgle fra Firebase:

  1. Naviger til fanen Tjenestekonti i projektindstillingerne.

  2. Opret enten en ny servicekonto, og få dens private nøgle.

  3. Eller åbn en eksisterende servicekonto, og generer en ny privat nøgle til den.

    Bemærk: Servicekontoen skal have firebaseadmin-sdk-tilladelsen .

  4. Download nøglen til en sikker placering.
3

Kopier nøglen til XSP som vært for dine NPS.
4

Tilføj projekt-id og den tilknyttede private nøgle til FCM-projektkontekst:

XSP_CLI/Applications/NotificationPushServer/FCM/Projects> add project-id path/to/keyfile
5

Tilføj UC-One (Connect eller SaaS)-applikationen og tilknyttet projekt-id til FCM-applikationskonteksten:

XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.broadsoft.connect projectId project-id
6

Kontroller konfigurationen for FCM mod attributterne og anbefalede værdier vist her. Brug set version af kommandoen for at ændre værdier, hvis nødvendigt:

Kør XSP_CLI/Applications/NotificationPushServer/FCM> get

Parameter

Anbefalet værdi

authURL

https://www.googleapis.com/oauth2/v4/token

pushURL

https://fcm.googleapis.com/v1/projects/PROJECT-ID/messages:send

scope

https://www.googleapis.com/auth/firebase.messaging

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

600

Migrer BroadWorks UC-One Connect/SaaS Android-apps til FCMv1 (på ADP)

  • Denne opgave gælder for NPS på ADP. Ignorer den, hvis din NPS er på XSP.

  • Du kan bruge denne procedure til overflytning til FCMv1-meddelelser for UC-One Connect eller UC-One SaaS Android-apps.

  • Du skal bruge FCMv1, hvis du vil bruge NPS-proxyen til at godkende push-meddelelser til UC-One eller Webex Android-apps.

  • Denne opgave forbereder NPS for FCMv1, så du kan aktivere den som en del af konfigurationen af NPS-godkendelsesproxy. Aktivér ikke FCMv1, før du er klar til at konfigurere NPS-godkendelsesproxy, eller underretninger til SaaS-klienter vil mislykkes.

1

Få projekt-id fra Firebase-konsol:

  1. Log ind på console.firebase.google.com.

  2. Vælg UC-One (Connect eller SaaS)-app projektet, åbn dets projektindstillinger.

  3. Åbn fanen Generelt , og optag projekt-id.
2

Få din servicekontos private nøgle fra Firebase:

  1. Naviger til fanen Tjenestekonti i projektindstillingerne.

  2. Opret enten en ny servicekonto, og få dens private nøgle.

  3. Eller åbn en eksisterende servicekonto, og generer en ny privat nøgle til den.

    Bemærk: Servicekontoen skal have firebaseadmin-sdk-tilladelsen .

  4. Download nøglen (.json-fil) til en sikker placering.
3

Importer .json-filen til ADP-serveren /bw/install.

4

Log ind på ADP CLI, og tilføj projekt- og API-nøglen til FCM-projekters kontekst:

ADP_CLI/Applications/NotificationPushServer/FCM/Projects> add connect-ucaas /bw/install/filename.json
5

Tilføj applikations- og projekt-id til FCM-applikationer konteksten:

ADP_CLI/Applications/NotificationPushServer/FCM/Applications> add applicationId com.broadsoft.ucaas.connect projectId project-id
6

Bekræft din konfiguration:

ADP_CLI/Applications/NotificationPushServer/FCM/Projects> get
Project ID Accountkey
========================
connect-ucaas ********
ADP_CLI/Applications/NotificationPushServer/FCM/Applications> get
Application ID Project ID
===================================
com.broadsoft.ucaas.connect connect-ucaas

Genaktiver FCM ældre tilstand

Du skal kun gøre dette (som en del af migreringen), hvis:

  • Din NPS bruges til UC-One SaaS eller BroadWorks Connect Android-apps.

  • Du har allerede testet, at push-beskeder til opkald til andre apps fungerer med FCMv1 API.

Du deaktiverer midlertidigt FCMv1, fordi FCMv1-nøgler til disse apps kun skal aktiveres under NPS-bekræftelsesproxykonfigurationsprocessen.

1

Log ind på XSP som vært for dine delte NPS.
2

Naviger til FCM-konteksten, og deaktiver FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false for at vende tilbage til at bruge den ældre FCM API-nøgle.

Installer NPS-bekræftelsesproxyrettelser

Konfigurer NPS til at bruge godkendelsesproxy

1

Opret en serviceanmodning med din kontaktperson for onboarding eller med TAC for at klargøre din OAuth-klientkonto (Webex Common Identity-konto). Titel din serviceanmodning NPS-konfiguration for auth-proxyopsætning.

Cisco giver dig et OAuth-klient-id, en klient hemmelighed og en opdateringstoken, der er gyldig i 60 dage. Hvis tokenet udløber, før du bruger det med dine NPS, kan du rindhæv en anden anmodning.
2

Opret klientkontoen på NPS:

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set clientId client-Id-From-Step1

XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set clientSecret
New Password: client-Secret-From-Step1
XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> set RefreshToken
New Password: Refresh-Token-From-Step1

For at bekræfte de værdier, du indtastede, svarer til de værdier, du har fået, skal du køre XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get
3

Indtast URL-adressen for NPS-proxy, og indstil token-opdateringsintervallet (30 minutter anbefales):

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set url https://nps.uc-one.broadsoft.com/nps/

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800
4

(Til Android-underretninger) Tilføj Android applikations-ID'er til FCM-applikationer kontekst på NPS.

For Webex-app på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

For UC-One app på Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect
5

(For Apple iOS-underretninger) Føj applikations-id'et til APNS-applikationerne, og sørg for at udelade auth-tasten – sæt den til tom.

For Webex-app på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

For UC-One app på iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared
6

Konfigurer følgende NPS-URL-adresser:

Tabel 2.

XSP CLI-kontekst

Parameter

Værdi

XSP_CLI/Applications/NotificationPushServer/FCM>

authURL

 https://www.googleapis.com/oauth2/v4/token

pushURL

https://fcm.googleapis.com/v1/projects//messages:send

scope

https://www.googleapis.com/auth/firebase.messaging

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

url

https://api.push.apple.com/3/device
7

Konfigurer følgende NPS-forbindelsesparametre til de anbefalede værdier vist:

Tabel 3.

XSP CLI-kontekst

Parameter

Værdi

XSP_CLI/Applications/NotificationPushServer/FCM>

tokenTimeToLiveInSeconds

3600

connectionPoolSize

10

connectionTimeoutInMilliseconds

3000

connectionIdleTimeoutInSeconds

600

XSP_CLI/Applications/NotificationPushServer/APNS/Production>

connectionTimeout

3000

connectionPoolSize

2

connectionIdleTimeoutInSeconds

600
8

Kontroller, om applikationsserveren er program-jeg-websteder, da du muligvis skal tilføje Webex-apps til listen over tilladte programmer:

  1. Kør AS_CLI/System/PushNotification> get og tjekke værdien af enforceAllowedApplicationList. Hvis det er true, du skal fuldføre denne underopgave. Ellers kan du springe resten af underopgaven over.

  2. AS_CLI/System/PushNotification/AllowedApplications> add com.cisco.wx2.android “Webex Android”

  3. AS_CLI/System/PushNotification/AllowedApplications> add com.cisco.squared “Webex iOS”

Genstart NPS og test push-meddelelser

1

Genstart XSP:

bwrestart
2

Test opkaldsunderretninger til Android ved at foretage opkald fra en BroadWorks-abonnent til opkaldsklienten på Android. Bekræft, at opkaldsmeddelelse vises på Android-enheden.

Bemærk: Hvis push-meddelelser ikke starter for UC-One Android-applikationen, er det muligt, at der er en forkert konfiguration. Hvis dette er din situation, kan du vende tilbage til den ældre FCM som følger:

  1. Deaktiver FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Genstart XSP: bwrestart

  3. Kontrollér din konfiguration.

  4. Genaktiver FCMv1, og genstart XSP.

  5. Gentag testen.
3

Test underretninger om opkald til iOS ved at foretage opkald fra en BroadWorks-abonnent til opkaldsklienten på iOS. Bekræft, at opkaldsmeddelelsen vises på iOS-enheden.

Bemærk: Hvis push-meddelelser ikke starter for UC-One iOS-applikationen, er det muligt, at der er en forkert konfiguration. Hvis dette er din situation, kan du vende tilbage til den ældre binære grænseflade med set HTTP2Enabled false