DocumentationAPI ReferenceRelease Notes
API Reference

Create virtual customer session

post
https://sespog-rs.qabeyondtrustcloud.com/api/command/v2/virtual-customer

Creates a virtual customer in BeyondTrust Remote Support and places that customer in a new session. This operation is necessary so that BeyondTrust Remote Support can accurately display and log chat messages forwarded by the chat bot on behalf of the end user. Before calling this API, integrations must use the POST /generate-session-key API to obtain a short_key to start a session.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The short_key returned from POST /session-key.

string
required

The customer name.

string
required

The public IP address of the customer.

string
required

The operating system of the customer.

string
required

The computer name to be shown with the customer.

boolean
Defaults to false

If true, the returned response URL will start the session as Click-To-Chat instead of a full session download.

string

The locale code of the language to be used for this chat bot. The language must be installed on your appliance. To see which languages are installed, go to /login > Localization > Languages.

string
Defaults to sespog-rs.qabeyondtrustcloud.com

Hostname to use in the returned response URL. Defaults to the primary hostname for your appliance.

Responses

Updated 2 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.