Integrationsguide¶
Kom i gang¶
Før integration skal følgende være på plads:
Forudsætninger¶
- Aftale med MedCom om Keycloak-klient og adgang til VDX SMS Gateway. Se adgangsvejledning og kontakt
vdx@medcom.dk. - Gyldigt booket møde — SMS API'et kræver et eksisterende møde-UUID (typisk fra MedCom Video API). Uden gyldigt UUID afvises kaldet.
- JWT access token med rolle
meeting-adminellermeeting-user(se Autentificering). - Backend-integration anbefales — gem tokens server-side.
Miljøer¶
| Miljø | Base URL |
|---|---|
| Stage | https://videoapi.vconf-stage.dk |
| Produktion | https://videoapi.vconf.dk |
SMS-endpoints er under prefix /sms/v2/... (fx POST https://videoapi.vconf-stage.dk/sms/v2/meeting/{uuid}).
Autentificering¶
Flow¶
- Log brugeren ind via Authorization Code Flow (anbefalet med PKCE) mod VDX Keycloak.
- Modtag et access token fra Keycloak.
- Send access token i alle kald til SMS Gateway:
Roller¶
| Rolle | Adgang |
|---|---|
meeting-user |
Send SMS og hent status for møder brugeren har adgang til |
meeting-admin |
Samme — inden for organisationens scope |
Token skal indeholde gyldig brugerkontekst (organisation og email), som for MedCom Video API v2.
Møde-UUID-krav¶
SMS Gateway kan kun bruges med et gyldigt booket møde-UUID:
- UUID angives som path-parameter:
/sms/v2/meeting/{uuid} - Mødet skal eksistere i VDX og tilhøre brugerens organisation
- Formålet er at forhindre misbrug (masse-SMS uden mødekontekst)
Typisk flow: opret møde via Video API → brug returneret uuid → send SMS.
Send SMS-flow¶
sequenceDiagram
participant App as Din app
participant Keycloak
participant VideoAPI as Video API v2
participant SmsAPI as SMS Gateway v2
App->>Keycloak: Login
Keycloak->>App: access_token
App->>VideoAPI: POST /v2/meetings
VideoAPI->>App: meeting uuid
App->>SmsAPI: POST /sms/v2/meeting/{uuid}
Note over App,SmsAPI: message med %meeting_url%, to: telefon
SmsAPI->>App: reference + status Registered
App->>SmsAPI: GET /sms/v2/meeting/{uuid}
SmsAPI->>App: smsStatus array
Trin-for-trin¶
- Autentificér brugeren og hent access token.
- Opret eller hent møde via MedCom Video API — gem
uuid. - Send SMS med
POST /sms/v2/meeting/{uuid}: messageskal indeholde placeholder%meeting_url%(erstattes med mødelink)toer modtagerens telefonnummer (fx+4512345678)- Gem
referencefra responsen til sporning. - Poll leveringsstatus med
GET /sms/v2/meeting/{uuid}indtil status erDeliveredellerFailed.
Beskedformat¶
SMS-beskeden skal indeholde %meeting_url%:
Gateway'en indsætter det faktiske mødelink hvor %meeting_url% står. Max længde for message: 480 tegn.
Best practices¶
- Opret altid mødet før SMS sendes — UUID er obligatorisk.
- Brug E.164 telefonnummerformat (
+45...). - Poll status med fornuftigt interval (fx hvert 5.–10. sekund) — undgå aggressiv polling.
- Håndter
FailedogUnknownstatus i UI med tydelig fejlbesked til brugeren. - Gem
referencefra POST-responsen sammen med møde-UUID til support/fejlfinding.
Se også Endpoints, Modeller og Support.
Ændringshistorik¶
| Dato | Ændring |
|---|---|
| 2026-06-27 | Første integrationsguide for VDX SMS Gateway v2 |