type=[string] | The type of session for which you would like to generate a session key. Currently, the only supported value is support. |
queue_id=[string] | The queue in which the session should be placed. Can be one of general, rep:[id], or team:[id], where [id] is the numeric ID for the representative, or team queue in which you wish to place this session. Can also be rep_username:[username]. https://turbogalaxy.weebly.com/syntax-a-generative-introduction-andrew-carnie-answer-key.html. This call will work only if a single user with the given username exists; otherwise, an error message will be returned. Online microsoft office professional 2016 product key generator. Can also be issue:[issue_code_name]. 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. https://doctoryellow455.weebly.com/blog/bootcamp-download-mac-os-x. |
session.custom.external_key=[string] | An arbitrary string that can link this session to an identifier on an external system, such as a help desk ticket ID. This has a maximum length of 1024 characters. |
session.custom.[custom field]=[string] | The code name and value of any custom fields. These fields must first be configured in /login > Management > API Configuration. Each attribute must be specified as a different parameter. Each custom field has a maximum length of 1024 characters. The maximum total size of all combined custom fields, including the external key, must be limited to 10KB. |
session.priority=[integer] | The priority of the session, from 1 to 3. 1 = high, 2 = medium, and 3 = low. |
session.skills=[string] | A comma-separated list of the code names of skills to assign to a session. |
ttl=[integer] | Time in seconds for which this key should be valid. If omitted, the maximum session key timeout set in the administrative interface will be used. |
url_hostname=[string] | Hostname to use in the URL generated for the session key. Defaults to the primary hostname for your Secure Remote Access Appliance. |
<type> | The type of session for which this key was generated. Currently, the only supported value is support. |
<ttl> | Time in seconds for which this key is valid. |
<expires> | The timestamp at which this session key expires. |
<queue> | The queue in which this session will be placed. This value will be rep or team. Also contains an available attribute. For a session key targeting a representative, the value is 1 if that representative is logged in. |
<queue_id> | The numeric ID of the queue. |
<external_key> | A string that links this session to an identifier on an external system, such as a help desk ticket ID. |
<short_key> | The seven-character string that the customer can enter on your public site to start a session. |
<key_url> | The session key url to which the customer can go to start a session. |
<mail_subject> | The subject line of the session key email invitation. This is static text defined by BeyondTrust and is not configurable. |
<mail_body> | The body of the session key email invitation. This is static text defined by BeyondTrust and is not configurable. |
Specific representative by ID |
|
Specific team |
|
Specific representative by username |
|
Specific issue |
|
Specific team, 1 hour time to live |
|
Specific team, external key and custom field |
|
Specific team, specific hostname |
|
Specific team, skills and priority set |
|