post
https://api.coviu.com/v1/sessions
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
There are some further options you are able to pass through a "feature_flags" field when creating a session. These allow some customisation of the interface
Custom features for Sessions
Custom feature can be added while creating a Session and it can be done by passing values into the feature_flags array.
Example Feature Flags option
feature_flags: [
'-plugin;coviu-waiting-room-plugin',
'-plugin;coviu-stripe-payments-resource-plugin',
'customisation;disable-menu',
'customisation;exit-url;https://your-exit-url',
'customisation;return-url;https://your-return-url',
'customisation;return-label;Your return label',
'customisation;auto-return',
'session;enforce-participant-uniqueness',
'customisation;favicon-url;https://yourdomain.com/favicon.ico'
]
What do they do?
| Feature Flag | What it does ? |
|---|---|
| -plugin | Removes standard Coviu plugins from the session room |
| customisation;disable-menu | Removes the menu from the session room |
| customisation;exit-url | Add a specific URL to wherever you would like to redirect to if the user exits the call interface using the "Exit call interface" button prior to other participants joining |
| customisation;return-url | Add a specific URL to wherever you would like to redirect to after the call has completed from the exit screen |
| customisation;return-label | To label the button that does the return URL navigation. |
| customisation;auto-return | Automatically redirect to the return-url after hitting the "end call" button |
| session;enforce-participant-uniqueness | Allow for the unique use of the participant's URL - it can't be re-used after first entry |
| customisation;favicon-url;https://yourdomain.com/favicon.ico | Allow for the use of your favicon in the call |
| customisation;background-color;{value} | Allows for using a custom background colour in the Coviu call window |
| customisation;button-primary;{value} | Allows for using a custom button colour in the Coviu call window |
| customisation;button-secondary;{value} | Allows for using a custom colour for the content inside the button in the Coviu call window |