Skip to content

Delete Window Browser

Request method and path

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

Interface Function Description

Used to delete the created window browser.

Request parameter

Tip

  1. Delete a single pass key keyword, with a value that uniquely identifies the window.
  2. Batch delete the passed keys keyword, with the value being an array uniquely identified by the window.
  3. Choose either keys or keys according to the deletion method.

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]
}

Return data

Successful Response Example

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

Example of failed response


Failed to call interface

When the interface response status code is not 00000, the interface call fails. The specific reasons for interface call errors can be found in the Interface Response Status Code Information Comparison Table for querying.

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

The deletion operation failed this time

json
{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E03",
    "errorMsg": "The key must be a positive integer between 1 and 1000.",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error codeReason for error
E00The format of parameter (xxx) is incorrect!
E01The parameter is missing a 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.