This page will help you get started with Coviu Session REST API.

Coviu provides a session based API for creating sessions and restricting access to Coviu calls. The core concepts exposed are

  • Session: A Coviu call that occurs between two or more parties at a specified time, and has a finite duration.
  • Participants: Users who may participate in a Coviu call.

Participants join a call by following a session link in their browser, or mobile application. The session link identifies the participant, including their name, optional avatar, and importantly their role. It is important that each person joining the call be issued with a different session link. A participant's role identifies whether that user may access the call directly (as a host) or they should be let into the call by another participant (as a guest). A participant assigned as a host should have their email address provided, and be an authorised user of the clinic.