Gets a list of window browsers

Request method and path

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

Interface Function Description

Used to retrieve a list of window browsers in a paginated manner.

Request parameter

Header Request Data

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

Body Request parameter

Parameter Name	Required	Example	Default	type	Explanation
page	Y	2	1	number	1<=page<=200
per_page_count	Y	2	10	string	1<=per_page_count<=200
key_sort	Y	desc	asc	string	Sorting defaults to ascending asc [desc,asc]

Request parameter example

{
  "page": 2,
  "per_page_count": "2",
  "key_sort": "desc"
}

Return data

Successful Response Example

Success without data example

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {
      "current_page": 20,
      "per_page": 2,
      "total": 9,
      "total_pages": 5,
      "data": []
    }
  }
}

Success with data examples

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "success",
    "errorCode": "",
    "errorMsg": "",
    "result": {
      "current_page": 2,
      "per_page": 2,
      "total": 9,
      "total_pages": 5,
      "data": [
        {
          "key": 14,
          "windowName": "window-14",
          "manyCreate": {
            "haveProxy": {
              "settingsString": "",
              "createNumber": 0
            },
            "nullProxy": {
              "createNumber": 1
            }
          },
          "ipProxy": {
            "settings": {
              "type": "null",
              "host": "",
              "port": "",
              "account": "",
              "password": ""
            },
            "ipInfo": {
              "country": "IP detection in progress...",
              "countryCode": "",
              "city": "",
              "zip": "",
              "lat": "0.0",
              "lon": "0.0",
              "address": "0.0.0.0",
              "timezone": ""
            }
          },
          "openWindowBtnStyle": {
            "canOpenWindowFlage": true,
            "canCloseWindowFlage": false,
            "btnStyleClass": "open-windows-btn-canOpen",
            "text": "open",
            "loading": false,
            "textColor": "#fff"
          },
          "openUrlArray": "https://www.baidu.com\r\nhttps://www.51job.com",
          "notes": "1234321423",
          "createdAt": "2024/3/19 16:34:36",
          "updatedAt": "2024/3/19 16:34:36"
        },
        {
          "key": 13,
          "windowName": "window-13",
          "manyCreate": {
            "haveProxy": {
              "settingsString": "",
              "createNumber": 0
            },
            "nullProxy": {
              "createNumber": 1
            }
          },
          "ipProxy": {
            "settings": {
              "type": "null",
              "host": "",
              "port": "",
              "account": "",
              "password": ""
            },
            "ipInfo": {
              "country": "IP detection in progress...",
              "countryCode": "",
              "city": "",
              "zip": "",
              "lat": "0.0",
              "lon": "0.0",
              "address": "0.0.0.0",
              "timezone": ""
            }
          },
          "openWindowBtnStyle": {
            "canOpenWindowFlage": true,
            "canCloseWindowFlage": false,
            "btnStyleClass": "open-windows-btn-canOpen",
            "text": "open",
            "loading": false,
            "textColor": "#fff"
          },
          "openUrlArray": "https://www.baidu.com\r\nhttps://www.51job.com",
          "notes": "1234321423",
          "createdAt": "2024/3/19 16:34:35",
          "updatedAt": "2024/3/19 16:34:35"
        }
      ]
    }
  }
}

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.

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

The paging data retrieval operation failed this time

{
  "code": "00000",
  "message": "Success",
  "data": {
    "status": "failed",
    "errorCode": "E01",
    "errorMsg": "The page must be a positive integer between 1 and 200.",
    "result": {}
  }
}

Operation failure errorCode error code information comparison table

Error code	Reason for error
E00	The format of parameter (xxx) is incorrect!
E01	The page must be a positive integer between 1 and 200.
E02	per_page_count must be a positive integer between 1 and 200.
E03	key_sort must be either "desc" (in descending order) or "asc" (in ascending order).