Gå til indholdet

Endpoints

Alle endpoints er v2, kræver gyldigt møde-UUID i path og autentificeres med Keycloak JWT.

Base URLs

Miljø Base URL
Stage https://videoapi.vconf-stage.dk
Produktion https://videoapi.vconf.dk

Eksempel: POST https://videoapi.vconf-stage.dk/sms/v2/meeting/46b46a1e-a4d3-4387-87ee-a67dcaa222cb

Fælles headers

Header Påkrævet Beskrivelse
Authorization Ja Bearer <access_token> fra Keycloak
Content-Type Ved POST application/json

Endpoint-oversigt

Metode Route Formål
POST /sms/v2/meeting/{uuid} Send SMS med mødelink
GET /sms/v2/meeting/{uuid} Hent leveringsstatus for SMS'er til mødet

POST /sms/v2/meeting/{uuid}

Sender SMS til angivet telefonnummer med mødelink indsat i %meeting_url%.

Request

Method POST
Path /sms/v2/meeting/{uuid}
Authorization Påkrævet — Bearer <access_token>
Parameter Type Beskrivelse
uuid uuid (path) VDX møde-UUID — skal være gyldigt booket møde

Request body: smsRequest

Eksempel (curl)

curl -s -X POST "https://videoapi.vconf-stage.dk/sms/v2/meeting/46b46a1e-a4d3-4387-87ee-a67dcaa222cb" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Du er inviteret til videomøde. Deltag her: %meeting_url%",
    "to": "+4512345678"
  }'

Response (200 OK)

smsResponse:

{
  "reference": "5d950cbf-5a59-40f4-80dd-f7a25f3ac8bb",
  "status": "Registered"
}

Fejl

HTTP Årsag
400 Manglende/ugyldigt input, besked uden %meeting_url%, for lang besked
401 Manglende/ugyldig token, manglende email/organisation
403 Møde tilhører ikke brugerens organisation, eller utilstrækkelig rolle
404 Møde findes ikke

GET /sms/v2/meeting/{uuid}

Henter leveringsstatus for alle SMS'er sendt i forbindelse med mødet.

Request

Method GET
Path /sms/v2/meeting/{uuid}
Authorization Påkrævet — Bearer <access_token>
Parameter Type Beskrivelse
uuid uuid (path) VDX møde-UUID

Eksempel (curl)

curl -s -X GET "https://videoapi.vconf-stage.dk/sms/v2/meeting/46b46a1e-a4d3-4387-87ee-a67dcaa222cb" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN"

Response (200 OK)

Array af smsStatus:

[
  {
    "reference": "5d950cbf-5a59-40f4-80dd-f7a25f3ac8bb",
    "status": "Delivered",
    "to": "+4512345678",
    "sendDateTime": "2017-07-21T17:32:28Z"
  }
]

Fejl

HTTP Årsag
400 Ugyldigt UUID-format
401 Manglende/ugyldig token
403 Adgang nægtet
404 Møde findes ikke, eller ingen SMS-status for mødet

Fejlkoder

HTTP Betydning
400 Manglende/ugyldigt input, valideringsfejl
401 Ugyldig eller udløbet token, manglende brugerkontekst
403 Møde/SMS tilhører ikke brugerens organisation
404 Møde eller SMS-status ikke fundet

Fejlrespons kan indeholde detailedError med detailed_error og detailed_error_code (10 = validering, 20 = generel fejl).

Anbefalet klient-adfærd

Status Handling
400 Vis valideringsfejl (tjek %meeting_url% og telefonnummer)
401 Forny token via Keycloak
403 Vis adgangsfejl
404 Tjek at møde-UUID er korrekt og mødet stadig findes

Se også

Ændringshistorik

Dato Ændring
2026-06-27 Første endpoint-reference for VDX SMS Gateway v2