API Command: transfer_session

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

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 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], embassy:[id], or rep_username:[string] where [id] is the numeric ID for the representative, team, or embassy queue and [string] is the name of the representative to which you wish to transfer this session. To get a representative's ID or name, please 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?action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=general
Session c69a8e10bea9428f816cfababe9815fe to specific representative
  • https://support.example.com/api/command?action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=rep:1
Session c69a8e10bea9428f816cfababe9815fe to specific team
  • https://support.example.com/api/command?action=transfer_session&lsid=c69a8e10bea9428f816cfababe9815fe&queue_id=team:1