API Script Command: push_and_start_local

The push_and_start_local command attempts to push the customer client to a computer on the local network to start a support session. This can also be described as a local Jump.

Required Parameter for push_and_start_local

hostname=[string] The hostname of the computer that is the target of the push and start operation. This field has a maximum length of 255 characters.

Optional Parameter for push_and_start_local

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.

Query Examples: push_and_start_local

Jump to the local network computer "ABCDEF02" https://support.example.com/api/client_script?type=rep&operation=generate&action=push_and_start_local&hostname=ABCDEF02
Jump to the local network computer "ABCDEF02" and associate custom attributes with the session https://support.example.com/api/client_script?type=rep&operation=generate&action=push_and_start_local&hostname=ABCDEF02&session.custom.custom_field1=Custom%20Value&session.custom.custom_field2=123