Video Call

Send emails: video call cancellation

  • Sandbox: available
  • Staging: available
  • Production: unknown
POST
/video-call/livekit/mail/cancel

Sends cancellation emails for a video call Appointment to the recipients you list. The route does not change the Appointment.

Auth: bearer token. The caller must be a Practitioner, an admin or a super admin, or hold the "System Owner" access policy. Scope: the caller's project (from the token).

Behaviour

  • emailRecipients takes 1 to 20 entries. Each has an email and a profileRef (Practitioner/<id> or Patient/<id>). Duplicate emails are dropped.
  • The caller is never emailed, even when listed. If no recipient is left, the route returns an empty emailRecipientsResult.
  • Cancellation emails need no TAN.
  • The email includes the Appointment title, the practitioner's name, start and end in CET. The Origin header of your request sets the app domain used in the email, and the request language sets its language.
  • Emails are sent one by one. A failed send does not fail the request. Check isEmailSent for each recipient.

Example

curl -X POST 'https://api.sandbox.ovok.com/video-call/livekit/mail/cancel' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \  -H 'Content-Type: application/json' \  -d '{    "appointmentId": "c3499c27-2973-0a7f-807e-fb8676a92dcb",    "emailRecipients": [{      "email": "max.mustermann@example.com",      "profileRef": "Patient/c3499c27-2973-0a7f-807e-fb8676a92dcb"    }]  }'

Authorization

bearer
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
appointmentId*string

Video call Appointment ID.

Length1 <= length
emailRecipients*array<>

List of email recipients.

Items1 <= items <= 20

Response Body

Summary of sent video call cancellation emails.

application/json
  1. response
appointmentId*string

Video call Appointment ID.

Length1 <= length
emailRecipientsResult*array<>
Example Request
curl -X POST 'https://api.sandbox.ovok.com/video-call/livekit/mail/cancel' \  -H 'Content-Type: application/json' \  -d '{  "appointmentId": "string",  "emailRecipients": [    {      "email": "user@example.com",      "profileRef": "string"    }  ]}'
Example Response
{  "appointmentId": "string",  "emailRecipientsResult": [    {      "email": "user@example.com",      "profileRef": "string",      "isEmailSent": true    }  ]}

Send emails: video call update POST

Sends update emails for a video call Appointment to the recipients you list. The route does not change the Appointment. **Auth:** bearer token. The caller must be a Practitioner, an admin or a super admin, or hold the "System Owner" access policy. **Scope:** the caller's project (from the token). ## Behaviour - `emailRecipients` takes 1 to 20 entries. Each has an `email` and a `profileRef` (`Practitioner/<id>` or `Patient/<id>`). Duplicate emails are dropped. - The caller is never emailed, even when listed. If no recipient is left, the route returns an empty `emailRecipientsResult`. - The email contains the recipient's TAN (a one-time access code) and its expiry. A recipient with no TAN gets no email and `isEmailSent` is `false`. - The email includes the Appointment title, the practitioner's name, start and end in CET. The `Origin` header of your request sets the app domain used in the email, and the request language sets its language. - Emails are sent one by one. A failed send does not fail the request. Check `isEmailSent` for each recipient. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/video-call/livekit/mail/update' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "appointmentId": "c3499c27-2973-0a7f-807e-fb8676a92dcb", "emailRecipients": [{ "email": "max.mustermann@example.com", "profileRef": "Patient/c3499c27-2973-0a7f-807e-fb8676a92dcb" }] }' ```

Send notifications to video call participants POST

Tells the participants of a video call Appointment that the call is active, and lets them join on their own. A Practitioner calls it when they start the call. **Auth:** bearer token. The caller must be a Practitioner, an admin or a super admin, or hold the "System Owner" access policy. **Scope:** the caller's project (from the token). ## Behaviour - Creates the access permission for the Appointment: a `CommunicationRequest` with the caller as sender and every Appointment participant as recipient. If one already exists for the Appointment, it is replaced. - Patients need this permission to get a join link from `POST /video-call/livekit/user-access/{appointmentId}`. - Queues a real-time event, `/video-call/livekit/notification/active-call`, for each participant who is not already in the LiveKit room. The event carries the sender's name, the Appointment id, description, start and end. Connect to the Ovok events socket to receive it. - The route returns once the event is queued, not when it is delivered. The response is an `OperationOutcome` with severity `information`. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/video-call/livekit/notification/active-call/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```