Alarmintegraties

Kernplatform
alarm_integrations_connections_writeExterne integraties

Koppelt een faciliteit aan de template van een meldkamerpartner en beheert die koppeling: opslaan (template, abonneenummer, zonetabel, events, faciliteitvelden), verwijderen, goedkeuring aanvragen, een testsignaal sturen, activeren na een geslaagde test en een voorbereide wijziging verwerpen.

Een live koppeling (active of failing) verandert alleen met applyMode: staged houdt alarmen op de live instellingen tot een test van de voorbereide wijziging slaagt en je die activeert; immediate past de wijziging direct toe. Geheime velden worden geaccepteerd maar nooit teruggegeven. Vereist External Integrations bij de faciliteit. Lees eerst met alarm_integrations_read connections.

Acties:

  • save: Een koppeling opslaan. templateId is nodig voor een nieuwe koppeling. fields stelt faciliteitvelden in op sleutel (null wist er een; geheimen worden versleuteld). Geef bij een live koppeling applyMode mee, anders mislukt de aanroep met apply-mode-required. Vereist partnerId. Vraagt om bevestiging.
  • remove: Een koppeling verwijderen. Verwijdert de koppeling van de faciliteit met de partner, inclusief een eventuele voorbereide wijziging; vanaf hier gaan geen alarmen meer naar die meldkamer. Vereist partnerId. Vraagt om bevestiging.
  • request_approval: Goedkeuring aanvragen. Vraagt de meldkamer de koppeling goed te keuren of een abonneenummer toe te wijzen (templates met partnergoedkeuring). Vereist partnerId.
  • send_test_signal: Een testsignaal sturen. Zet een echt testsignaal naar de meldkamer in de wachtrij; vraag test_signal_status op. staged: true test de voorbereide wijziging in plaats van de live instellingen. Vereist partnerId. Vraagt om bevestiging.
  • activate: Een koppeling of wijziging activeren. Zet een openstaande koppeling live, promoveert een voorbereide wijziging of bevestigt een niet-geteste wijziging. Activeren vereist de requestId van een test die na de laatste wijziging is geslaagd: een test van de voorbereide wijziging (staged: true) promoveert een voorbereide wijziging, een live test bevestigt een niet-geteste wijziging. Vereist partnerId, requestId. Vraagt om bevestiging.
  • discard_pending_change: Een voorbereide wijziging verwerpen. Verwijdert de voorbereide wijziging; de live instellingen blijven ongewijzigd. discarded is false als er niets was voorbereid. Vereist partnerId. Vraagt om bevestiging.

Parameters

NaamTypeBeschrijving
action*"save" | "remove" | "request_approval" | "send_test_signal" | "activate" | "discard_pending_change"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
partnerIdstringDe meldkamerpartner, uit alarm_integrations_read connections (org#<id> voor de eigen templates van de organisatie)
templateIdstringEen gepubliceerde template die aan deze faciliteit wordt aangeboden (save)
linkingIdentifierstringnullHet abonneenummer waaronder de meldkamer de faciliteit kent (save)
zoneMapobjectnullKnopserienummer naar zone, bijv. { "DS-0001": "001" } (save)
eventsarraynullEventtypen die naar de partner worden gestuurd (null: die van de template) (save)
fieldsobjectWaarden van faciliteitvelden op sleutel; null wist er een. Worden nooit teruggegeven. (save)
applyMode"staged" | "immediate"Live koppelingen: staged (testen, dan activeren) of immediate (save)
stagedbooleanDe voorbereide wijziging testen (nodig voordat je die activeert) (send_test_signal)
requestIdstringEen request-id van een testsignaal (tsr_...), uit send_test_signal (activate)
confirmbooleanAlleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd
alarm_integrations_destinations_writeExterne integratiesDuress Configuration

Voegt eigen alarmbestemmingen toe, wijzigt en verwijdert ze en stuurt er testsignalen naar: je eigen meldontvanger, een relaisbord, sms, spraak, e-mail, webhooks, teamchat of een on-call-oproepdienst (de kanaallijst), bij een faciliteit (standaard), merk of organisatie.

Niet-geheime instellingen horen in config; geheimen (wachtwoorden, webhook-URL's, sleutels) horen in fields op instellingspad en worden versleuteld, nooit teruggegeven. Ingeschakelde bestemmingen hebben een volledige config nodig. Bestemmingen van een faciliteit vereisen daar External Integrations of Duress Configuration; bestemmingen van een merk of organisatie vereisen organisatiebrede toegang. Lees eerst met alarm_integrations_read destinations.

Acties:

  • save: Een bestemming opslaan. Zonder connectionId wordt er een toegevoegd (channel en name nodig); met connectionId wordt er een gewijzigd (het kanaal blijft). config vervangt, indien meegestuurd, de niet-geheime instellingen; geheimen die niet in fields staan, blijven behouden. Vraagt om bevestiging.
  • remove: Een bestemming verwijderen. Verwijdert de bestemming; een relais van een faciliteit stuurt dan ook het alarmrelais niet meer aan. Vereist connectionId. Vraagt om bevestiging.
  • send_test_signal: Een test naar een bestemming sturen. Zet een echt testbericht naar de bestemming in de wachtrij; vraag alarm_integrations_read test_signal_status op met de faciliteit. Bestemmingen van een merk of organisatie worden getest vanuit facilityId. Vereist connectionId. Vraagt om bevestiging.

Parameters

NaamTypeBeschrijving
action*"save" | "remove" | "send_test_signal"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
ownerScopestringfacility#<id>, brand#<id> of org#<id> (standaard: de faciliteit)
connectionIdstringDe bestemming die je wijzigt; weglaten om er een toe te voegen
channel"cid-csvip" | "sentinel-http" | "relay" | "sms" | "voice" | "email" | "webhook" | "slack" | "teams" | "google-chat" | "pagerduty" | "opsgenie"Het type bestemming; kan na het aanmaken niet meer veranderen (save)
namestringGetoond in de instellingen en het afleverlogboek (save)
enabledbooleanStandaard true voor nieuwe bestemmingen (save)
eventsarraynullEventtypen die de bestemming ontvangt (null: de standaardwaarden van het kanaal) (save)
guestLink"shared" | "none" | "null"Alleen sms-, e-mail- en teamchatkanalen: shared (één alarmpagina om alleen te bekijken, de standaard) of none (save)
configobjectNiet-geheime instellingen voor het kanaal (save)
fieldsobjectGeheime instellingen op pad, bijv. { "webhookUrl": "https://..." }; null wist er een (save)
confirmbooleanAlleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd
alarm_integrations_readExterne integratiesDuress Configuration

Leest waar de duress-alarmen van een faciliteit buiten Performance Hub naartoe gaan: de meldkamerkoppelingen (partner, template, abonneenummer, zonetabel, status, wat nog ontbreekt, voorbereide wijzigingen), eigen bestemmingen (meldontvangers, relais, sms, spraak, e-mail, webhooks, chat, oproepdiensten) bij de faciliteit, het merk en de organisatie, een routeringsvoorbeeld, het afleverlogboek en de uitkomsten van testsignalen.

Vereist External Integrations of Duress Configuration bij de faciliteit. Geheimen en versleutelde waarden worden nooit getoond, alleen { key, secret, hasValue }; telefoonnummers en adressen van personen worden uit routering en afleveringen weggelaten. Tijden zijn in ISO. Wijzig ze met alarm_integrations_connections_write en alarm_integrations_destinations_write.

Acties:

  • connections: Meldkamerkoppelingen. De partnerkoppelingen van de faciliteit: template, abonneenummer (linkingIdentifier), zonetabel, events, connectionStatus, missing (wat het live gaan blokkeert), pendingChange (voorbereid, nog niet live) en untestedChange. canEdit: External Integrations hier.
  • destinations: Eigen bestemmingen. Bestemmingen die voor de faciliteit kunnen afgaan (die van de faciliteit zelf, van het merk en van de organisatie, elk met canEdit), of met ownerScope die van één scope. Instellingen in config; geheimen als fields { key, secret, hasValue }.
  • routing: Routeringsvoorbeeld. Waar een alarm op dit moment naartoe zou gaan (alleen live instellingen), zoals universal-api het bepaalt: bestemmingen met lane, events en config zonder geheimen, problems die uitleggen wat is weggelaten, en pendingChanges die nog niet worden gerouteerd. eventType houdt alleen over wat dat event ontvangt.
  • deliveries: Afleverlogboek. Alarmafleveringen, nieuwste eerst (status, kanaal, ontvanger, latentie, openbare foutmelding). Een gefilterde pagina kan kort zijn en toch een nextCursor hebben. Apparaatmeldingen verschijnen als kind alert.
  • test_signal_status: Uitkomst van het testsignaal. queued tot universal-api een poging registreert, daarna succeeded (een ontvanger heeft het bevestigd of het is verstuurd) of failed, met de afleverregels. Gebruik de faciliteit van waaruit de test is verstuurd. Vereist requestId.

Parameters

NaamTypeBeschrijving
action*"connections" | "destinations" | "routing" | "deliveries" | "test_signal_status"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
limitintegerItems per pagina (standaard 25, maximaal 100) (connections, destinations, deliveries)
cursorstringnextCursor van de vorige pagina (connections, destinations, deliveries)
ownerScopestringAlleen deze scope: brand#<id> of org#<id> (destinations)
eventTypestringbijv. ph.duress.incident.created (routing, deliveries)
fromstringISO-datum en -tijd, inclusief (deliveries)
tostringISO-datum en -tijd, exclusief (deliveries)
statusarrayEen of meer van sent, acknowledged, failed, shadow (deliveries)
channelstringExact kanaal, bijv. cid-csvip of sms (deliveries)
destinationIdstringExacte bestemmings-id (deliveries)
incidentIdstringAfleveringen voor één alarm (deliveries)
requestIdstringAfleveringen voor één testsignaal (deliveries, test_signal_status)
searchstringTekst in een id, kanaal of fout (deliveries)