Open Window Browser

Request method and path

POST http://localhost:[post]/openapi/window/browser/open?ticket=[OpenApiToken]

Interface Function Description

Used to open the window browser.

Request parameter

Header Request Data

name	value	required	type	Explanation
Content-Type	application/json	Y	String	application/json

Body Request parameter

Parameter Name	Required	type	Explanation
arrange_type	N	null || string	Window arrangement:null: Using user settings on the rendering end，default: System default ,stacking: Stacking 、nineSquareGrid: squared paper for practicing calligraphy
display_screen_id	N	number	Specify monitor ID, -1: indicates using rendering end user settings
interval_time	N	number	The time interval for batch opening windows is in milliseconds, -1: indicates using the rendering end user settings
open_keys	Y	object	Open window information object configuration item view

Detailed explanation of parameters

open_keys Parameter Description

Parameter Name	Required	type	Explanation
window_browser_key	Y	string	The unique identifier of the window browser, which can be queried in Get Window List API

Request parameter example

{
  "arrange_type": null,
  "display_screen_id": -1,
  "interval_time": -1,
  "open_keys": [
    {
      "window_browser_key": 1
    },
    {
      "window_browser_key": 2
    },
    {
      "window_browser_key": 3
    },
    {
      "window_browser_key": 113
    }
  ]
}

Example of Interface Response Result

Successful Response Example

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {
      "openStatus": [
        {
          "windowKey": 1,
          "type": "success",
          "reason": "success"
        },
        {
          "windowKey": 2,
          "type": "success",
          "reason": "success"
        },
        {
          "windowKey": 3,
          "type": "success",
          "reason": "success"
        },
        {
          "windowBrowserKey": 311,
          "type": "error",
          "reason": "xxxx(Please refer to the actual usage results for specific content)"
        }
      ],
      "arrangeType": "nineSquareGrid",
      "displayScreen": {
        "id": 1,
        "label": "Built in Retina Display",
        "size": {
          "width": 1512,
          "height": 982
        },
        "workAreaSize": {
          "width": 1512,
          "height": 860
        }
      },
      "intervalTime": 1000
    }
  }
}

Example of failed response

Failed to call interface

When the interface response status code is not '00000', the interface call fails.
The specific interface call Reason for error can be queried by viewing the Interface Response Status Code Information Comparison Table.

{
  "code": "00001",
  "message": "Unknown error occurred, please provide feedback to official customer service!",
  "data": {}
}

This modification operation failed

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E00",
    "errorMsg": "Parameter format error! ｜ There is a parameter format error in the array!   ",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error code	Reason for error
E00	Parameter format error! ｜ There is a parameter format error in the array!
E01	The parameter cannot be empty.
E02	There is a missing parameter xxx in the array
E03	There is an extra parameter in the array
E04	The window_browser_key of an item in the array must satisfy the following condition: the key must be a positive integer between 1 and 1000
E029	The total number of windows that can be opened in bulk at once cannot exceed 24. If you have special needs, please contact official customer service for customization.
E030	The total number of open windows cannot exceed 48. If you have special needs, please contact official customer service for customization
E031	An exception occurred when opening the window browser in bulk. Please provide feedback to the official customer service personnel!