<h2>Under the Hood</h2>The ScreenMeet Apex API is a wrapper around a REST interface that makes callouts to the ScreenMeet REST API. The Apex wrapper takes care of things like authentication and message serialization for you automatically.If you use the ScreenMeet API with any kind of synchronous code, such as Triggers or Flow Processes, you will need to add the @future(Callout=true) annotation to any helper functions which call methods from the ScreenMeet API. <a target="_blank" rel="noopener noreferrer nofollow" href="https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation_future.htm">Read more about @future annotations here</a>.<h2>screenmeet.ScreenMeetAPI.ScreenMeetSessionParams</h2>This object is used to define properties for a session which you are trying to either create or&nbsp;schedule.<h3>Properties</h3><table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Property</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">parentObject</td><td colspan="1" rowspan="1">Map&lt;String, Object&gt;</td><td colspan="1" rowspan="1">This map will contain properties describing the parent object. The constructor generates this object automatically. </td></tr><tr><td colspan="1" rowspan="1">metaData</td><td colspan="1" rowspan="1">Map&lt;String, Object&gt;</td><td colspan="1" rowspan="1">This object contains extra metadata about the session request and stores data such as the version of the interface being used. This property is also auto-populated by the constructor. </td></tr><tr><td colspan="1" rowspan="1">agentPrefs</td><td colspan="1" rowspan="1">ScreenMeetSessionAgentPrefs</td><td colspan="1" rowspan="1">This object contains the settings which the agent can toggle for this session. </td></tr><tr><td colspan="1" rowspan="1">label</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The label/description for this session.</td></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">String (enum)</td><td colspan="1" rowspan="1">An enum that supports four values: support, cobrowse, live, and replay. </td></tr><tr><td colspan="1" rowspan="1">externalMapping</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">This field is created automatically during construction. It acts as a globally unique identifier in the ScreenMeet system to determine which sessions are associated with the parent object. It will generally be a concatenation of the Organization Id and parentObjectId. </td></tr><tr><td colspan="1" rowspan="1">startTime</td><td colspan="1" rowspan="1">String (ISO Date format)</td><td colspan="1" rowspan="1">This field contains the desired start time of this call and is only used for scheduled sessions. </td></tr><tr><td colspan="1" rowspan="1">userDescription</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The description of the user. Usually this will be the name of the agent who created the session. It will be shown to the end-user in support and co-browse sessions during the permission-consent process. </td></tr></tbody></table><h3>Constructor</h3><table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Property</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">sessionType </td><td colspan="1" rowspan="1">String (enum)</td><td colspan="1" rowspan="1">An enum that supports four values describing the type of session to create: support, cobrowse, live, and&nbsp;replay. </td></tr><tr><td colspan="1" rowspan="1">parentObjectId</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The Salesforce ID of the Object with which this session is to be associated. </td></tr><tr><td colspan="1" rowspan="1">parentObjectType </td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The type of object with which this session is associated, e.g., case, opportunity, serviceappointment, and user. </td></tr><tr><td colspan="1" rowspan="1">label</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The label/description for this session.</td></tr><tr><td colspan="1" rowspan="1">userDesc</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The description of the user. Usually, this will be the name of the agent who created the session and will be shown to the end-user in support and co-browse sessions during the permission-consent process. </td></tr></tbody></table><h3>Example Usage</h3><pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetAPI.ScreenMeetSessionParams newSessionParams = new screenmeet.ScreenMeetAPI.ScreenMeetSessionParams( 'live', //session type '5001R00000xgLmIQAU', //parentObjectId 'case', //owner object type UserInfo.getUserId(), //Logged in user ID 'My Support Session', //session description UserInfo.getName() //name of currently logged in USER );</code><h2>screenmeet.ScreenMeetAPI.ScreenMeetSessionAgentPrefs</h2>This object contains the settings which the agent can toggle for this session.<table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Property</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">record</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Whether or not the session should be recorded. </td></tr><tr><td colspan="1" rowspan="1">knock</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Supported only by Live sessions. Indicates the Host must approve the attendee before joining. </td></tr><tr><td colspan="1" rowspan="1">startwithrc</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Supported only by Remote Support sessions. Requests remote-control entitlement on start. </td></tr><tr><td colspan="1" rowspan="1">startwithadmin</td><td colspan="1" rowspan="1">Boolean</td><td colspan="1" rowspan="1">Supported only by Remote Support sessions. Requests admin permissions to the device on start.</td></tr></tbody></table><h3>Example Usage</h3><pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetAPI.ScreenMeetSessionAgentPrefs prefs = new screenmeet.ScreenMeetAPI.ScreenMeetSessionAgentPrefs(); prefs.record = true; prefs.startwithadmin = true; prefs.startwithrc = true; //set the agentPrefs of our session params object newSessionParams.agentPrefs = prefs;</code><h2>Methods</h2><h3>createSession</h3>This method is used to create a new session.SignatureMap&lt;String, Object&gt; screenmeet.ScreenMeetApi.createSession(ScreenMeetSessionParams newSession)Example<pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetApi.createSession(newSessionParams);</code><hr><h3>scheduleSession</h3>This method is used to schedule a session that starts in the future.SignatureMap&lt;String, Object&gt; screenmeet.ScreenMeetApi.scheduleSession(ScreenMeetSessionParams newSession, string ISODateTime)Example<pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetApi.scheduleSession(myNewSessionParams, '2021-05-20T23:30:00.000Z');</code><hr><h3 style="text-align: left;">rescheduleRemoteSession</h3>This method is used to change the starting time of a previously scheduled session.&nbsp;SignatureMap&lt;String, Object&gt; screenmeet.ScreenMeetApi.rescheduleRemoteSession(String SmSessionId, string ISODateTime)Example<pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetApi.rescheduleRemoteSession('gJ3Sjv6sXkrS', '2021-05-20T23:30:00.000Z'); </code><hr><h3 style="text-align: left;">closeRemoteSession</h3>This method is used to close a session which is either scheduled, new, or active. If the session is active, all connected users will be dropped and the session will be closed.&nbsp;SignatureMap&lt;String, Object&gt; screenmeet.ScreenMeetApi.closeRemoteSession(String SmSessionId);Example<pre><code class="language-plaintext">JavaJava</code></pre><code>screenmeet.ScreenMeetApi.closeRemoteSession('gJ3Sjv6sXkrS'); </code><h2>Putting it Together</h2>The example below will create a ScreenMeet Live session with recording and knock to join enabled from a Case object record. You can call this in a Flow for any event:<pre><code class="language-java">//create the newSessionParams
screenmeet.ScreenMeetAPI.ScreenMeetSessionParams newSessionParams = new screenmeet.ScreenMeetAPI.ScreenMeetSessionParams( 
	'live', //session type 
	'5001R00000xgLmIQAU', //parentObjectId 
	'case', //owner object type 
	UserInfo.getUserId(), //Logged in user ID 
	'My Support Session', //session description
	UserInfo.getName() //name of currently logged in USER 
); 

//configure agent user preferences (optional) 
screenmeet.ScreenMeetAPI.ScreenMeetSessionAgentPrefs prefs = new screenmeet.ScreenMeetAPI.ScreenMeetSessionAgentPrefs();
prefs.record = true;
prefs.knock = true; 
//set the agentPrefs of our session params object
newSessionParams.agentPrefs = prefs;
//make the REST API call to create the session
screenmeet.ScreenMeetApi.createSession(newSessionParams);</code></pre>

Apex API reference guide

Apex API Reference

ScreenMeet 2025 Release Notes

403 Forbidden while making API request

404 NO_ACCESS

Installing ScreenMeet for Salesforce

Advanced CSS customization

AI Assist

AI Assist Overview

Overview

AI Release Notes Q4 24

Requirements

AI Summarization

AI Summary History

AI Summary Privacy

AI Summary Studio

Android SDK Quickstart

How-to: Setup the app for Laser Pointer

How-to: Display a video stream to the end-user

Egress IP Addresses

AWS S3 File Storage

Configuring ScreenMeet / Microsoft Entra ID integration

Signing into ScreenMeet console with Microsoft Entra ID (Azure AD)

Beam Client: Installation, Deployment, and Configuration Guide

Beam Groups: Setup, Settings, and Access Management

Beam Release Notes Q1 22

Beam Release Notes Q1 23

Beam Release Notes Q1 24

Beam Release Notes Q2 22

Beam Release Notes Q2 23

Beam Release Notes Q2 24

Beam Release Notes Q3 23

Beam Release Notes Q3 22

Beam Release Notes Q4 22

Beam Release Notes Q4 24

New Remote Support Client for Mac

Canvas

Certificate-Based Device Validation

Clone - Remote Support Release Notes Q4 23

Clone - Test ScreenMeet 2025 Release Notes

File Storage on AWS

Configuring Information Security & PII

Creating a Custom UI

Custom Copy

Cobrowse Demo

CoBrowse Deployments

Events

Hotkeys

Localization

CoBrowse Release Notes Q1 23

CoBrowse Release Notes Q1 22

CoBrowse Release Notes Q1 24

CoBrowse Release Notes Q2 22

CoBrowse Release Notes Q2 23

CoBrowse Release Notes Q2 24

CoBrowse Release Notes Q3 22

CoBrowse Release Notes Q3 23

CoBrowse Release Notes Q3 24

CoBrowse Release Notes Q4 22

CoBrowse Release Notes Q4 23

CoBrowse Release Notes Q4 24

Remote Control

Remove End Cobrowse Button

Cobrowse Script

Cobrowse Settings

Starting a Session with a URL

Configuration and validation troubleshooting

Configure API service

Configure ScreenMeet for a New Salesforce Sandbox

Configure ScreenMeet to only show on specified tables

Configuring Environment Variables

Configuring Webhooks for Data Sync

Connecting to ChromeOS devices

Connecting to Mac devices

Connection Information

Create Multiple Sessions

Creating a Replay Recording

Creating a session

Custom Consent Message

Custom permission configuration for ServiceNow

Custom URL

Custom Windows Tools

Deploying a Pre-installed Client

Developer Notes

Developer Notes (3.0.11)

Device Requirements

Enable ScreenMeet for Omnichannel Chat Widget

Enabling features within the Salesforce + ScreenMeet component