Skip to content

Close Window Browser

Request method and path

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

Interface Function Description

Close the open window browser.

Request parameter

Tip

  1. Close the key keyword individually, with a value that uniquely identifies the window group.
  2. Batch close the pass keys keyword, with a value of an array that uniquely identifies the window group.
  3. Choose either keys or keys in the closed mode.

Header Request Data

namevaluerequiredtypeExplanation
Content-Typeapplication/jsonYStringapplication/json

Body Request parameter

Parameter NameRequiredExampletypeExplanation
keysY[1,2,9]arrayThe unique identifier array of the window.
keyY9numberThe unique identifier of the window can be obtained in Get Window List API.

Request parameter example

json
{
  "key":9
}
json
{
  "keys":[1,2,9]
}

Example of Interface Response Result

Successful Response Example

json
{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {}
  }

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.

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

This operation failed

json
{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E01",
    "errorMsg": "Parameter missing window unique identifier key or keys",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error codeReason for error
E00Parameter format error! | There is a parameter format error in the array!
E01Parameter missing window unique identifier key or keys
E02The unique identifier key value of the window is illegal!
E03The key must be a positive integer between 1 and 1000