API Script Command: generate_session_key

In the context of the client scripting API, the generate_session_key command causes the representative console to show the Generate Session Key dialog. Parameters can be passed to the command to customize the behavior.

Optional Parameters for the generate_session_key Command

session.custom.external_key=[string] The external key to associate with the support session started with the session key or URL shown on the Generate Session Key dialog. This field has a maximum length of 1024 characters.
public_portal_hostname=[string] The hostname of the public portal that should be selected by default when the Generate Session Key dialog is shown. The representative will still have the option to change the public portal on the dialog. This field has a maximum length of 255 characters.

Query Examples: generate_session_key

Show the Generate Session Key dialog

https://support.example.com/api/client_script?type=rep&operation=generate&action=generate_session_key

Show the Generate Session Key dialog with the public portal hostname "support.example.com" selected

https://support.example.com/api/client_script?type=rep&operation=generate&action=generate_session_key&public_portal_hostname=support.example.com

Show the Generate Session Key dialog and associate the external key "BMC0000001275" with any support sessions started using the session key or URL shown on the dialog

https://support.example.com/api/client_script?type=rep&operation=generate&action=generate_session_key&session.custom.external_key=BMC0000001275