The Coviu Session REST API developer documentation

This article provides information on creating and linking to sessions using the Coviu REST API.

Last Updated: May 2024

On this page:

  1. What is the Coviu Session REST API?
  2. Where can I access the Technical Developer documentation?
  3. More Support Options

What is the 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.

Where can I access the Technical Developer documentation?

Documentation is available here.

More Support Options

You have completed another Coviu help article. You now know more about our Session REST API.

If this is not what you were looking for, visit our developer partner page here.

If you still require any assistance, please do not hesitate to get in touch with our friendly Customer Success team using any of the contact methods available here.