<h2>Creating a Session</h2>This method will create a new ScreenMeet session which is related to an object from your Service-Now instance.Method createSession (type, parent_object_table, parent_object_sys_id, parent_object_display_name, screenmeet_session_name, agent_prefs);Parameters<table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">String (enum)</td><td colspan="1" rowspan="1">This is an enum which supports 4 values: support, cobrowse, live, replay</td></tr><tr><td colspan="1" rowspan="1">parent_object_table</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The table name of the object to which this session is related, eg: incident, interaction, or any other table etc...</td></tr><tr><td colspan="1" rowspan="1">parent_object_sys_id</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The sys_id of the object row from the related parent_object_table.</td></tr><tr><td colspan="1" rowspan="1">parent_object_display_name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The human friendly display name of the object.</td></tr><tr><td colspan="1" rowspan="1">screenmeet_session_name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The label/description for this ScreenMeet session.</td></tr><tr><td colspan="1" rowspan="1">agent_prefs</td><td colspan="1" rowspan="1">Object</td><td colspan="1" rowspan="1">A <a target="_blank" rel="nofollow" href="#agent-preferences-object">ScreenMeetAgentPrefs</a> object for toggling behaviors for this session.</td></tr></tbody></table>Example Usage<pre><code class="language-javascript">var sm = new x_prois_sm.ScreenMeet();

var result = sm.createSession('support', 'incident', 'e8e875b0c0a80164009dc852b4d677d5', 'Incident INC0000005', 'Remote support session for INC0000005', {'record': true});</code></pre> Example ResponseThe response is a JSON object which contains information about the newly created Session.<pre><code class="language-json">{
 "unattended": false,
 "scheduled": false,
 "id": "HUiUti",
 "type": "support",
 "label": "Remote support session for INC0008111",
 "ExternalUserId": 32593,
 "OrganizationId": 1336,
 "createdByAgentSession": {
 "sid": 2371395,
 "roles": {
 "api": true,
 "agent": true,
 "supervisor": false,
 "group_admin": true
 },
 "features": null,
 "providerExternalId": "6816f79cc0a8016401c5a33be04be441",
 "provider": "snow-universal",
 "startedAt": "2021-08-09T15:45:57.000Z",
 "expiresAt": "2021-08-09T16:45:57.000Z",
 "clientApp": "service-now-backend",
 "userAgent": "Jakarta Commons-HttpClient/3.1",
 "remoteIp": "149.96.6.12"
 },
 "userDescription": "System A",
 "updatedAt": "2021-08-09T15:46:15.084Z",
 "createdAt": "2021-08-09T15:46:15.084Z",
 "pin": 137143,
 "status": "new",
 "hostAuthToken": "lBVSLqUoIWGhnhRsMwnGInNRaXGXRGIu",
 "expiresAt": "2021-08-09T16:46:15.105Z",
 "settings": {
 "recording": true,
 "startwithadmin": false,
 "startwithrc": false,
 "knock": false,
 "audio": true
 },
 "externalSessionObjectId": "320eacfe2f713010cc3590bcf699b6ac",
 "urls": {
 "user": "https://myhelpscreen.com/137143",
 "host": "https://integration.screenmeet.com/viewer/index.html?HUiUti"
 }
}</code></pre><h2>Schedule a Session</h2>This method will create a schedule a ScreenMeet session which is related to an object from your Service-Now instance. The session's state will switch from scheduled&nbsp;to new when the time is approximately 10 minutes before the session scheduled start time.Method scheduleSession (startTime, type, parent_object_table, parent_object_sys_id, parent_object_display_name, screenmeet_session_name, agent_prefs);Parameters<table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">startTime</td><td colspan="1" rowspan="1">String (ISO Date)</td><td colspan="1" rowspan="1">This is an ISO Formatted date string for when the session is scheduled to start. eg: 2021-08-10T15:30:00.000Z</td></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">String (enum)</td><td colspan="1" rowspan="1">This is an enum which supports 4 values: support, cobrowse, live, replay</td></tr><tr><td colspan="1" rowspan="1">parent_object_table</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The table name of the object to which this session is related, eg: incident, interaction, or any other table etc...</td></tr><tr><td colspan="1" rowspan="1">parent_object_sys_id</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The sys_id of the object row from the related parent_object_table.</td></tr><tr><td colspan="1" rowspan="1">parent_object_display_name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The human friendly display name of the object.</td></tr><tr><td colspan="1" rowspan="1">screenmeet_session_name</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The label/description for this ScreenMeet session.</td></tr><tr><td colspan="1" rowspan="1">agent_prefs</td><td colspan="1" rowspan="1">Object</td><td colspan="1" rowspan="1">A <a target="_blank" rel="nofollow" href="#agent-preferences-object">ScreenMeetAgentPrefs</a> object for toggling behaviors for this session.</td></tr></tbody></table>Example Usage<pre><code class="language-javascript">var startTime = '2022-08-10T15:30:00.000Z';

var sm = new x_prois_sm.ScreenMeet();

var result = sm.scheduleSession(startTime, 'live', 'sn_customerservice_case', '9e05ffd01b08a450409921be6e4bcbec', 'Case CS0010001', 'Scheduled snow call for CS0010001', {'record': true});
</code></pre>Example Response<pre><code class="language-javascript">{
 "unattended": false,
 "id": "xoKwKRBrbwRF",
 "type": "live",
 "label": "Scheduled snow call for CS0010001",
 "startTime": "2022-10-01T17:26:04.210Z",
 "userDescription": "System A",
 "ExternalUserId": 1750,
 "OrganizationId": 151,
 "createdByAgentSession": {
 "sid": 13499,
 "roles": {
 "api": true,
 "agent": true,
 "supervisor": false,
 "group_admin": true
 },
 "features": null,
 "providerExternalId": "6816f79cc0a8016401c5a33be04be441",
 "provider": "snow-universal",
 "startedAt": "2021-08-06T17:27:32.000Z",
 "expiresAt": "2021-08-06T18:27:32.000Z",
 "clientApp": "service-now-backend",
 "userAgent": "Jakarta Commons-HttpClient/3.1",
 "remoteIp": "199.91.140.12"
 },
 "status": "scheduled",
 "scheduled": true,
 "updatedAt": "2021-08-06T17:55:14.562Z",
 "createdAt": "2021-08-06T17:55:14.562Z",
 "pin": 0,
 "hostAuthToken": "ncVGyYNADPfpOXPgVFnxRqMNofAdDWcs",
 "expiresAt": "2022-10-01T18:26:04.210Z",
 "settings": {
 "recording": true,
 "startwithadmin": false,
 "startwithrc": false,
 "knock": false,
 "audio": true
 },
 "externalSessionObjectId": "0bce2db1db753810d10fd1d3ca961938",
 "urls": {
 "user": "https://sm-live-qa.screenmeet.com/?xoKwKRBrbwRF",
 "host": "https://sm-live-qa.screenmeet.com/?xoKwKRBrbwRF#host=UmUQuPOQApnKmHVztyuDbxIARzTJTvbH"
 }
}</code></pre><h2>Reschedule a Session</h2>This method allows you to update the start time for a session that is in a scheduled state.MethodrescheduleSession (ScreenMeetSessionId, startTime)Parameters<table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">ScreenMeetSessionId</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The alpha-numeric ScreenMeet session ID for the session you wish to reschedule.</td></tr><tr><td colspan="1" rowspan="1">startTime</td><td colspan="1" rowspan="1">String (ISO Date)</td><td colspan="1" rowspan="1">The new desired start time for this session. This is an ISO Formatted date string for when the session is scheduled to start. eg: 2021-08-10T15:30:00.000Z</td></tr></tbody></table>Example Usage<pre><code class="language-javascript">var sm = new x_prois_sm.ScreenMeet();

var result = sm.rescheduleSession('xoKwKRBrbwRF', '2021-10-01T17:30:00.000Z');</code></pre>Example ResponseThe response will be a ScreenMeetSession object with the same structure as the response to scheduleSession.<h2>Close a Session</h2>This method will close a session. Its state will change to closed and users will no longer be able to connect to it. If the session's status is currently active (users are connected), then the session will be ended and all users will be disconnected.MethodcloseSession (ScreenMeetSessionId)Parameters<table style="min-width: 75px;"><tbody><tr><th colspan="1" rowspan="1">Parameter</th><th colspan="1" rowspan="1">Type</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">ScreenMeetSessionId</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">The alpha-numeric ScreenMeet session ID for the session you wish to reschedule.</td></tr></tbody></table>Example Usage<pre><code class="language-javascript">var sm = new x_prois_sm.ScreenMeet();

var result = sm.closeSession('xoKwKRBrbwRF');</code></pre>Example ResponseThe response will be a simple {"success" : true} JSON object if there are no errors.<h2>Agent Preferences Object</h2>The agent preferences object is a set of options that can be set for a session. They will modify some behaviors of the session, such as starting the session with recording on, or other behaviors. Different session types have different preferences that apply to them. Also, not all preferences may be available for agents to set depending on your organizations configuration. For example, if recording is set to always be on, then the users won't have the option to toggle it on or off before a session starts. The following table illustrates the support for the various option by session type. If an option is not supported by a given session type, it will be ignored. If options are omitted, they are treated as "false".<table style="min-width: 150px;"><tbody><tr><td colspan="1" rowspan="1">Option </td><td colspan="1" rowspan="1">Description </td><td colspan="1" rowspan="1">support </td><td colspan="1" rowspan="1">live </td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">replay</td></tr><tr><td colspan="1" rowspan="1">record</td><td colspan="1" rowspan="1">Whether this session should be recorded</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">no</td></tr><tr><td colspan="1" rowspan="1">prerequestrc </td><td colspan="1" rowspan="1">Will start the remote support client with remote control permission requested automatically on start</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td></tr><tr><td colspan="1" rowspan="1">prerequestadmin </td><td colspan="1" rowspan="1">Will start the remote support client with administrator level execution permission requested automatically on start</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td></tr><tr><td colspan="1" rowspan="1">knock</td><td colspan="1" rowspan="1">Will start the live session with knock-to-join mode on by default, requiring the host to explicitly allow entry into the room for each attendee (only applies if knock is configured as "agent decides")</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td></tr><tr><td colspan="1" rowspan="1">audio</td><td colspan="1" rowspan="1">Will start the live session with audio enabled (only applies if audio is configured as "agent decides")</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">yes</td><td colspan="1" rowspan="1">no</td><td colspan="1" rowspan="1">no</td></tr></tbody></table>Example Preference Objects<pre><code class="language-javascript">
//Support session preferences
var supportSessionPrefs = {
 "record" : true,
 "prerequestrc" : true,
 "prerequestadmin" : false 
}

//Live session preferences
var liveSessionPrefs = {
 "record" : true,
 "audio" : true,
 "knock" : true
}

//Cobrowse session preferences
var liveSessionPrefs = {
 "record" : false
}</code></pre>

ServiceNow API reference

API Details

Getting Application from ServiceNow Store

Using your Azure Blob for ScreenMeet File Storage

Minimal Cobrowse Script

Frequently Asked Questions

Timeout Settings

July

Remote Control

IP Access Control Feature

Live Release Notes Q2 2024

Video Chat Integration

Cobrowse Settings

CoBrowse Release Notes Q2 23

Connecting to Mac devices

Connecting to a Device Using Beam

Windows Tools

Starting a session

CoBrowse Release Notes Q1 22

Remote Support Release Notes Q4 24

Clipboard

Release Summer 21 (1.14)

Virtual Agent Integration w/ ScreenMeet

Android SDK Quickstart

Security

Remote Support Release Notes Q3 23

Replay Settings

Custom Copy

CoBrowse Deployments

AI Summary History

Integration Signing Key

Microsoft D365 Release Notes Q4 2022

Replay Release Notes Q2 24

October

Live Settings

ScreenMeet Console Customers

Hosting a Desktop Session

Remote Support Release Notes Q2 23

Creating a Replay Recording

AI Assist Overview

Included Reports and how to add them into Dashboards

Custom Domain

Networking Configuration

AI Summarization

Remote Support

Overview

Remote Support Settings

CoBrowse Release Notes Q2 24

Sign in to console.screenmeet.com

Multiple Domain and Subdomain support

February

File Transfer Settings

Exporting ScreenMeet + Salesforce data to third party visualization tools

Beam Release Notes Q1 24

Regional Geo-Fencing

Custom Branding

AI Assist

Configure API service

Beam Release Notes Q3 23

Joining & Completing a Live Plus session

Egress IP Addresses

Custom URL

Starting a Session from within Salesforce

Settings and Policies

Requirements

How To Install ScreenMeet in Your Genesys Instance

Localization

Configuring Environment Variables

Reviewing a Session

August

Remote Support Release Notes Q1 23

Live Release Notes Q2 22

Release Summer 2020 (1.9)

Device Requirements

System Information

Create Multiple Sessions

ServiceNow Release Notes Q4 24

403 Forbidden while making API request

Manage Beam Group Permission Set

ScreenMeet Platform Release Notes Q3 23

Remote Support Release Notes - Q1 22

Screen Annotation

Creating a Session

Custom Background

Remote Support Release Notes Q2 24

AI Summary Studio

Instructions to Person at End Point Device

Beam Client: Installation, Deployment, and Configuration Guide

Beam Groups: Setup, Settings, and Access Management

Component settings

Customer initiated sessions with a chatbot

ScreenMeet 2024 Release Notes

Package Installation Error - Case-Case Layout: feedLayout is not supported for this layout

Developer Notes (3.0.11)

Starting a Session from Dynamics

ScreenMeet Platform Release Notes Q1 23

Remote Support Release Notes Q2 22