API Command: join_session

The join_session command adds a logged in representative to an existing support session.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have full access to the command API.

Required Parameters for join_session

lsid=[string] The ID of the session to which the representative will be added.

rep_id=[string]

or

rep_username=[string]

Unique ID or username assigned to the representative. To get a representative's ID, see API Command: get_logged_in_reps.

XML Response for join_session Query

<success> Returns a message of Representative successfully added if successful.
<error> Returns an error message if not successful.

Query Examples: join_session

Add representative to session c69a8e10bea9428f816cfababe9815fe
  • https://support.example.com/api/command?action=join_session&lsid=c69a8e10bea9428f816cfababe9815fe&rep_id=151