删除窗口浏览器
请求方法以及路径
html
POST http://localhost:[端口号]/openapi/window/browser/delete?ticket=[OpenApi票据]
接口功能描述
用于删除创建的窗口浏览器 。
请求参数
Header 请求参数
参数名 | 参数值 | 必填 | 类型 | 描述 |
---|---|---|---|---|
Content-Type | application/json | 是 | String | application/json |
Body 请求参数
注意事项
- 单个删除传递 key 关键字,值为窗口唯一标识 。
- 批量删除传递 keys 关键字,值为窗口唯一标识的数组 。
- keys 和 key 按照删除的方式任选其一即可 。
参数名 | 是否必须 | 示例 | 类型 | 说明 |
---|---|---|---|---|
keys | 是 | [1,2,9] | array | 窗口的唯一标识数组 。 |
key | 是 | 9 | number | 窗口的唯一标识可以在获取窗口列表 API中获取 。 |
请求参数示例
json
{
"key": 9
}
json
{
"keys":[1,2,9]
}
返回数据
成功响应示例
json
{
"code": "00000",
"message": "Success",
"data": {
"status": "success",
"errorCode": "",
"errorMsg": "",
"result": {
"deletedKeys": [
1
]
}
}
}
失败响应示例
调用接口失败
接口响应状态码,不为00000
时,接口调用失败 。 具体接口调用错误原因可查看接口响应状态码信息对照表进行查询 。
json
{
"code": "00001",
"message": "产生未知错误,请反馈给官方客服!",
"data": {}
}
本次删除操作失败
json
{
"code": "00000",
"message": "Success",
"data": {
"status": "failed",
"errorCode": "E03",
"errorMsg": "key 必须是 1 ~ 1000 之间的一个正整数 。",
"result": {}
}
}
操作失败 errorCode 错误码信息对照表
错误码 | 错误原因 |
---|---|
E00 | 参数(xxx)格式有误! |
E01 | 参数缺少窗口唯一标识 key 或者 keys 。 |
E02 | 窗口唯一标识 key 值不合法! |
E03 | key 必须是 1 ~ 1000 之间的一个正整数 。 |