API Command: transfer_session

The transfer_session command transfers an active session from one queue to another.

In order to issue the transfer_session command, you will need to supply the username and password for a Bomgar user account. That account must have the permission Allowed to Use Command API along with the permission Is Administrator.

Required Parameters for transfer_session

lsid=[string] The ID of the session you wish to transfer.
queue_id=[string] The queue to which this session should be transferred. Can be one of general, rep:[id], team:[id], or embassy:[id], where [id] is the numeric ID for the representative, team, or Embassy queue to which you wish to transfer this session. To get a representative's ID, see API Command: get_logged_in_reps. To get a team's ID, see API Command: get_support_teams.

XML Response for transfer_session Query

<success> Returns a message of Successfully transferred if the transfer was successful.
<error> Returns an error message if the transfer was not successful.

Query Examples: transfer_session

Session c69a8e10bea9428f816cfababe9815fe to general queue

https://support.example.com/api/command?username=test&password=test&action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=general

Session c69a8e10bea9428f816cfababe9815fe to specific representative https://support.example.com/api/command?username=test&password=test&action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=rep:1
Session c69a8e10bea9428f816cfababe9815fe to specific team https://support.example.com/api/command?username=test&password=test&action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=team:1