Create new session key.

post

https://sespog-rs.qabeyondtrustcloud.com/api/command/v2/session-key

Creates a new session key to be used in starting a support session. Note that if your appliance has multiple public sites, the session key created may be associated with any of these sites, depending on the method used to download the customer client.

For example, Site A has a hostname of support.example.com, and Site B has a hostname of remote.example.com. When a POST /session-key request is made to support.example.com with a url_hostname of support.example.com, both a session key code and a unique session key URL will be generated.

If the customer goes to the generated URL to download the customer client, then the session will be associated with Site B, because the session key URL points to the hostname designated by the url_hostname parameter.

However, the customer could also download the customer client by submitting the session key code on either site. Therefore, if the customer goes to Site A to submit the code, then the session will be associated with Site A, while if they go to Site B, the session will be associated with Site B.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

queue_type

string

enum

The type of queue in which this session will be placed. Cannot be used with issue_code_name or rep_username.

Allowed:

queue_id

integer

The numeric ID of the Representative or team queue in which you wish to place this session. To get a Representative ID, see /get-logged-in-reps. To get a team's ID, see /get-support-teams. Cannot be used with issue_code_name or rep_username.

issue_code_name

string

Code name of the customer's issue so that the system can route the session to the appropriate team. Cannot be used with queue_type, queue_id or rep_username.

rep_username

string

length ≤ 255

The username of the Representative in whose queue you wish to place this session. Cannot be used with queue_type, queue_id or issue_code_name.

external_key

string

length ≤ 1024

An arbitrary string that can link this session to an identifier in an external system, such as a help desk ticket ID.

priority

int32

1 to 3

The priority of the session, from 1 to 3. 1 = high, 2 = medium, and 3 = low.

skills

array of objects

An array of the code names of skills to assign to a session.

skills

ttl

int32

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 appliance.

custom_fields

object

The code name and value of any custom fields. These fields must first be configured in /login on the Configuration > Custom Fields page. Each custom field value has a maximum length of 1024 characters. A maximum of 30 fields may be set at one time.

customer

object

Optional customer information.

Responses

200OK

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.