Prehľad servera proxy na overovanie NPS

Tento článok popisuje, ako nakonfigurovať zdieľaný server NPS na používanie servera proxy overovania NPS, aby ho bolo možné použiť aj na odosielanie upozornení na hovory do aplikácií Webex. Ak váš NPS nepodporuje iné aplikácie, môžete postupovať podľa zjednodušeného postupu v Sprievodcovi https://help.webex.com/z9gt5jriešením Webex for BroadWorks .

Prehľad servera proxy servera NPS

Z dôvodu kompatibility s Webexom pre BroadWorks musí byť váš NPS opravený tak, aby podporoval funkciu NPS Proxy, Push Server for VoIP v UCaaS.

Táto funkcia implementuje nový dizajn na serveri Notification Push Server na vyriešenie bezpečnostnej chyby zdieľania súkromných kľúčov certifikátu push notifikácií s poskytovateľmi služieb pre mobilných klientov. Namiesto zdieľania certifikátov a kľúčov push notifikácií s poskytovateľom služieb používa NPS nové rozhranie API na získanie krátkodobého tokenu push notifikácií z backendu UCaaS a používa tento token na overovanie so službami Apple APN a Google FCM.

Táto funkcia tiež vylepšuje schopnosť servera Notification Push Server odoslať upozornenia do zariadení s Androidom prostredníctvom nového rozhrania Google Firebase Cloud Messaging (FCM) HTTPv1 API.

Predpoklady servera proxy overovania NPS

XSP (alebo Application Delivery Platform ADP), ktorý je hostiteľom NPS, musí spĺňať nasledujúce požiadavky:

Minimálne verzie a obmedzenia spoločnej rezidencie

  • NPS musí byť aktivovaný na vyhradenom XSP/ADP a NPS musí byť jedinou hosťovanou aplikáciou na serveri. Tým sa eliminuje rušenie doručovania upozornení Push.

  • V nasadení by mala byť iba jedna aplikácia NPS. Ak používate mobilné UC-One Collaborate/Connect a/alebo UC-One SaaS a implementujete Webex pre BroadWorks, musíte zdieľať tento jeden NPS pre všetky aplikácie.

  • NPS musí byť vo verzii R22 alebo novšej XSP alebo ADP.

    R22/R23 XSP je kompatibilný so zásobníkom R21, ak XSP používa iba NPS a AS je R21. SP1. Ďalšie informácie nájdete v matici kompatibility BroadWorks.

  • Viac informácií o ADP serveri nájdete na . https://xchange.broadsoft.com/node/1051580

Zdieľaný NPS

Pred konfiguráciou zdieľaného NPS na používanie servera proxy NPS si prečítajte tieto poznámky:

  • Ak sa vaše NPS používa s inými aplikáciami (nielen s aplikáciou Webex): Najprv nakonfigurujte server proxy servera NPS a potom zmeňte server NPS z používania staršieho rozhrania API FCM na rozhranie API FCM HTTP v1.

  • Po overení, či oznámenia fungujú správne pre staršie aplikácie s serverom proxy NPS, odstráňte kľúč rozhrania API FCM pre aplikáciu pre Android a autentifikačný kľúč APNs pre aplikáciu pre iOS.

APN HTTP/2

  • Ak ste nasadili nejaké aplikácie pre iOS, ktoré nie sú od spoločnosti Cisco/BroadSoft, nakonfigurujte tieto aplikácie tak, aby používali protokol HTTP/2 APNS pred konfiguráciou servera NPS na používanie servera proxy NPS.

  • XSP/ADP, ktoré už podporujú aplikáciu Collaborate alebo SaaS BroadWorks, je potrebné migrovať do HTTP/2. Podrobné informácie o konfigurácii protokolu HTTP/2 nájdete v téme Podpora HTTP/2 pre server presunutia oznámení pre APNS (migrácia servera NPS na podporu týchto aplikácií pre iOS je zhrnutá v tomto článku).

Android FCMv1

  • Ak ste nasadili nejaké aplikácie pre Android, ktoré nie sú od spoločnosti Cisco/BroadSoft, nakonfigurujte tieto aplikácie tak, aby používali kľúče FCMv1 pred konfiguráciou servera NPS na používanie servera proxy NPS.

  • Ak XSP/ADP momentálne podporuje aplikáciu Connect alebo UC-One SaaS, po nakonfigurovaní servera proxy NPS povoľte kľúče FCMv1. Odporúčame migrovať všetky ďalšie aplikácie na kľúče FCMv1, povoliť a otestovať a potom zakázať, kým nebudete pripravení dokončiť pokyny na nastavenie (postup migrácie je popísaný v tomto článku).

Súhrn migrácie servera proxy servera NPS
Vizuálne zhrnutie migrácie na server proxy na overovanie NPS
Tabuľka č. 1 Súhrn úloh migrácie na server proxy servera NPS

Sled

Názov úlohy

Kiedy/prečo je úloha povinná?

1

Migrujte NPS na HTTP/2 pre aplikácie UC-One SaaS (alebo Connect) pre iOS.

Ak NPS podporuje tieto aplikácie a ešte nie sú nakonfigurované pre protokol HTTP/2.

2

Migrujte NPS na FCMv1 pre aplikácie UC-One SaaS (alebo Connect) pre Android.

Ak NPS podporuje tieto aplikácie a ešte nie sú nakonfigurované pre FCMv1.

3

Povoľte režim FCMv1 a otestujte upozornenia push.

Ak NPS podporuje UC-One Connect a/alebo iné aplikácie pre Android (iných ako Cisco).

4

Znova povoľte starší režim FCM.

Ak NPS podporuje UC-One SaaS. Ak necháte FCMv1 zapnutú, pred konfiguráciou servera proxy servera NPS začnú zlyhávať oznámenia bez vyžiadania do UC-One SaaS.

5

Nainštalujte opravy servera proxy na overovanie NPS.

Ak je NPS na XSP R22 alebo XSP R23.

6

Nakonfigurujte server NPS tak, aby používal server proxy overovania NPS:

  • Pripojte technickú podporu od NPS

  • Žiadosť o účet CI OAuth

  • Vytvorenie konta CI na NPS a konfigurácia časového limitu obnovovacieho tokenu

  • Pridanie ID aplikácií pre Android

  • Pridanie ID aplikácií pre iOS

  • Kontrola/nastavenie URL adries a časových limitov pripojenia

  • Pridanie aplikácií do zoznamu povolených aplikácií AS

  • (Re-)Povoliť FCMv1

  • Reštartujte XSP / ADP

  • Testovanie PN pre aplikácie pre iOS a Android

Vždy potrebné.

7

Odstráňte klávesy staršieho režimu FCM.

Pre aplikácie, ktoré sú úspešne podporované serverom NPS v systéme FCMv1.
Migrácia aplikácií BroadWorks Collaborate pre iOS do HTTP/2

Táto úloha je povinná pre upozornenia bez vyžiadania do aplikácií UC-One SaaS a Webex na platformách iOS.

Skôr než začnete

Ak je na vašom XSP spustený R22, musíte použiť ap354313 predtým, ako budete môcť nakonfigurovať aplikáciu NPS tak, aby používala protokol HTTP/2 pre APNS.

1

Nastavte produkčnú URL adresu a parametre pripojenia na XSP_CLI/Applications/NotificationPushServer/APNS/Production>

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

set connectionPoolSize 2

set connectionTimeout 3000

set connectionIdleTimeoutInSeconds 600

Poznámka: Nenastavujte časový limit pripojenia pod 1000.

2

Pridajte ID aplikácií do kontextu aplikácií APNS a nezabudnite vynechať kľúč Auth – nastavte ho na prázdny.

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

Pre aplikáciu Webex: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

3

Skontrolujte autentizačné klávesy pomocou XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> get

4

Ak autentifikačný kľúč nie je prázdny pre com.broadsoft.uc-one, môžete ho vymazať pomocou XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> clear the-authkey

5

Povoliť HTTP/2:

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

6

Len pre aplikácie UC-One SaaS: Prihláste sa na portál predajcu a prejdite na Konfigurácia > BroadWorks > .

7

Posuňte sa nadol do sekcie Server presunutia oznámení a vyberte vydanie (napr. vydanie 22) a potom postupujte podľa pokynov uvedených na portáli.

Migrácia aplikácií BroadWorks UC-One Connect / SaaS pre Android do FCMv1

  • Táto úloha sa vzťahuje na NPS na XSP. Ignorujte to, ak je váš NPS na ADP.

  • Tento postup môžete použiť na migráciu na oznámenia FCMv1 pre aplikácie UC-One Connect alebo UC-One SaaS pre Android.

  • Ak chcete použiť server proxy NPS na overenie oznámení bez vyžiadania v aplikáciách UC-One alebo Webex pre Android, musíte použiť FCMv1.

  • Táto úloha pripraví server NPS pre systém FCMv1 tak, aby ste ho mohli povoliť ako súčasť konfigurácie servera proxy overovania servera NPS. Nepovoľujte FCMv1, kým nie ste pripravení nakonfigurovať server proxy overovania NPS, inak oznámenia pre klientov SaaS zlyhajú.

1

Získajte ID projektu z konzoly Firebase:

  1. Prihláste sa do console.firebase.google.com.

  2. Vyberte projekt aplikácie UC-One (Connect alebo SaaS) a otvorte jeho nastavenia projektu.

  3. Otvorte kartu Všeobecné a zaznamenajte ID projektu.

2

Získajte súkromný kľúč svojho účtu služby z platformy Firebase:

  1. V nastaveniach projektu prejdite na kartu Účty služieb.

  2. Buď si vytvorte nový účet služby a získajte jeho súkromný kľúč.

  3. Alebo si otvorte existujúci účet služby a vygenerujte preň nový súkromný kľúč.

    Poznámka: Konto služby musí mať povolenie firebaseadmin-sdk .

  4. Stiahnite si kľúč na bezpečné miesto.

3

Skopírujte kľúč do XSP, ktorý je hostiteľom vášho NPS.

4

Pridajte ID projektu a priradený súkromný kľúč do kontextu projektov FCM:

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

5

Pridajte aplikáciu UC-One (Connect alebo SaaS) a súvisiace ID projektu do kontextu aplikácií FCM:

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

6

Skontrolujte konfiguráciu FCM podľa tu uvedených atribútov a odporúčaných hodnôt. Použiť set verzia príkazu na zmenu hodnôt v prípade potreby:

Bežať XSP_CLI/Applications/NotificationPushServer/FCM> get

Parameter

Odporúčaná hodnota

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

Migrácia aplikácií BroadWorks UC-One Connect / SaaS pre Android do FCMv1 (na ADP)

  • Táto úloha sa vzťahuje na NPS na ADP. Ignorujte to, ak je váš NPS na XSP.

  • Tento postup môžete použiť na migráciu na oznámenia FCMv1 pre aplikácie UC-One Connect alebo UC-One SaaS pre Android.

  • Ak chcete použiť server proxy NPS na overenie oznámení bez vyžiadania v aplikáciách UC-One alebo Webex pre Android, musíte použiť FCMv1.

  • Táto úloha pripraví server NPS pre systém FCMv1 tak, aby ste ho mohli povoliť ako súčasť konfigurácie servera proxy overovania servera NPS. Nepovoľujte FCMv1, kým nie ste pripravení nakonfigurovať server proxy overovania NPS, inak oznámenia pre klientov SaaS zlyhajú.

1

Získajte ID projektu z konzoly Firebase:

  1. Prihláste sa do console.firebase.google.com.

  2. Vyberte projekt aplikácie UC-One (Connect alebo SaaS) a otvorte jeho nastavenia projektu.

  3. Otvorte kartu Všeobecné a zaznamenajte ID projektu.

2

Získajte súkromný kľúč svojho účtu služby z platformy Firebase:

  1. V nastaveniach projektu prejdite na kartu Účty služieb.

  2. Buď si vytvorte nový účet služby a získajte jeho súkromný kľúč.

  3. Alebo si otvorte existujúci účet služby a vygenerujte preň nový súkromný kľúč.

    Poznámka: Konto služby musí mať povolenie firebaseadmin-sdk .

  4. Stiahnite si kľúč (.json súbor) na bezpečné miesto.

3

Importujte .json súbor na server ADP /bw/install.

4

Prihláste sa do ADP CLI a pridajte kľúč projektu a API do kontextu projektov FCM:

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

5

Pridajte ID aplikácie a projektu do kontextu aplikácií FCM:

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

6

Overte konfiguráciu:

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
Znova zapnite starší režim FCM

Musíte to urobiť (v rámci migrácie) iba v týchto prípadoch:

  • Váš NPS sa používa pre aplikácie UC-One SaaS alebo BroadWorks Connect pre Android.

  • Už ste otestovali, že oznámenia o vyžiadaných hovoroch do iných aplikácií fungujú s rozhraním FCMv1 API.

Dočasne zakážete FCMv1, pretože kľúče FCMv1 pre tieto aplikácie musia byť povolené iba počas procesu konfigurácie servera proxy overovania NPS.

1

Prihláste sa do XSP, ktorý je hostiteľom zdieľaného NPS.

2

Prejdite do kontextu FCM a vypnite FCM v1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1enabled false a vráťte sa k používaniu staršieho kľúča rozhrania API FCM.

Inštalácia opráv servera proxy overovania NPS
Konfigurácia servera NPS na používanie overovacieho servera proxy
1

Vytvorte žiadosť o službu so svojím kontaktom pre registráciu alebo pomocou TAC, aby ste zriadili svoje klientske konto OAuth (Webex Common Identity). Názov žiadosti o službu Konfigurácia servera NPS pre nastavenieservera proxy overenia.

Spoločnosť Cisco vám poskytne ID klienta OAuth, tajný kľúč klienta a obnovovací token, ktorý je platný 60 dní. Ak platnosť tokenu vyprší skôr, ako ho použijete s NPS, môžete podať ďalšiu žiadosť.
2

Vytvorte si klientsky účet na 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

Ak chcete overiť, či sa zadané hodnoty zhodujú s tým, čo ste dostali, spustite XSP_CLI/Applications/NotificationPushServer/CiscoCI/Client> get

3

Zadajte URL adresu servera proxy servera NPS a nastavte interval obnovenia tokenu (odporúča sa 30 minút):

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

XSP_CLI/Applications/NotificationPushServer/CloudNPSService> set VOIPTokenRefreshInterval 1800

4

(Pre upozornenia Androidu) Pridajte ID aplikácií pre Android do kontextu aplikácií FCM na NPS.

Pre aplikáciu Webex v systéme Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.cisco.wx2.android

Pre aplikáciu UC-One v systéme Android: XSP_CLI/Applications/NotificationPushServer/FCM/Applications> add com.broadsoft.connect

5

(Pre hlásenia Apple iOS) Pridajte ID aplikácie do kontextu aplikácií APNS a nezabudnite vynechať kľúč Auth – nastavte ho na prázdny.

Pre aplikáciu Webex v systéme iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

Pre aplikáciu UC-One v systéme iOS: XSP_CLI/Applications/NotificationPushServer/APNS/Production/Tokens> add com.cisco.squared

6

Nakonfigurujte nasledujúce URL adresy NPS:

Kontext XSP CLI

Parameter

Hodnota

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

Nakonfigurujte nasledujúce parametre pripojenia NPS na zobrazené odporúčané hodnoty:

Kontext XSP CLI

Parameter

Hodnota

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

Skontrolujte, či aplikačný server kontroluje ID aplikácií, pretože možno budete musieť pridať aplikácie Webex do zoznamu povolených:

  1. Bežať AS_CLI/System/PushNotification> get a skontrolujte hodnotu enforceAllowedApplicationList. Ak je true, musíte dokončiť túto čiastkovú úlohu. V opačnom prípade preskočte zvyšok čiastkovej úlohy.

  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”

Reštartujte NPS a otestujte oznámenia push
1

Reštartujte XSP:

bwrestart
2

Otestujte upozornenia na hovory do Androidu uskutočňovaním hovorov od predplatiteľa BroadWorks do volajúceho klienta v systéme Android. Overte, či sa v zariadení s Androidom zobrazuje upozornenie na hovor.

Poznámka: Ak push notifikácie začnú zlyhávať pre aplikáciu UC-One pre Android, je možné, že došlo k nesprávnej konfigurácii. Ak je to vaša situácia, môžete sa vrátiť k staršej verzii FCM takto:

  1. Zakázať FCMv1: XSP_CLI/Applications/NotificationPushServer/FCM> set V1Enabled false

  2. Reštartujte XSP: bwrestart

  3. Skontrolujte konfiguráciu.

  4. Znova povoľte FCMv1 a reštartujte XSP.

  5. Opakujte test.

3

Otestujte upozornenia na hovory do systému iOS uskutočnením hovorov od predplatiteľa BroadWorks do volajúceho klienta v systéme iOS. Overte, či sa na zariadení so systémom iOS zobrazuje hlásenie o hovore.

Poznámka: Ak push notifikácie začnú zlyhávať pre aplikáciu UC-One pre iOS, je možné, že došlo k nesprávnej konfigurácii. Ak je to vaša situácia, môžete sa vrátiť k staršiemu binárnemu rozhraniu pomocou set HTTP2Enabled false