搜索工单

请求地址

GET /api/v1/tickets/search.json

请求参数

名称	类型	必需	注释
query	string	是	搜索内容
sort_by	string	否	按时间排序，目前支持：createDT-创建时间，updateDT-更新时间
sort_order	string	否	按升序还是降序返回，取值为：asc-升序，desc-降序，默认为降序

query参数说明

搜索内容	返回结果
query=2444	模糊搜索，返回工单编号、工单标题或者联系人姓名包含该内容的工单
query=ticketStatus:2,4	搜索工单状态为已开启或已解决的工单
query=field_1:454	返回自定义字段唯一标识为"field_1"的内容里面包含"454"的工单，454是该字段的值
query=uId:9516936	返回公司uId为"9516936"的所有工单
query=2444 createDT>2026-01-01	返回工单编号、工单标题或者联系人姓名包含该内容的工单，并且创建时间是2026年1月1日以后的
query=ticketStatus:2,4 createDT<=2026-01-01	返回工单状态为已开启或已解决的工单，并且创建时间是2026年1月1日以前的，包含2026年1月1日当天
query=ticketStatus:2,4 updateDT>=2026-01-01	返回工单状态为已开启或已解决的工单，并且更新时间是2026年1月1日以后的，包含2026年1月1日当天

时间相关字段

字段	字段含义
createDT	创建时间
updateDT	修改时间
waitDT	等待时间
solveDT	解决时间
openDT	开启时间
closeDT	关闭时间

说明

暂不支持搜索内容本身带有空格
当query参数增加了时间的过滤条件时，两个条件之间要以空格分开，比如"ticketStatus:2,4 updateDT>=2026-01-01"
时间过滤条件目前支持以下几种方式：（以createDT为例）
- createDT<2026-09-01 //过滤2026-09-01之前的工单，不包含2026-09-01当天
- createDT>2026-09-01 //过滤2026-09-01之后的工单，不包含2026-09-01当天
- createDT:2026-09-01 //过滤2026-09-01当天的工单
- createDT<=2026-09-01 //过滤2026-09-01之前的工单，包含2026-09-01当天
- createDT>=2026-09-01 //过滤2026-09-01之后的工单，包含2026-09-01当天
- solveDT>=2021-07-01 solveDT<=2021-11-01 //过滤2021-07-01之后到2021-11-01的工单，包含2021-07-01当天和2021-11-01当天

调用示例

curl "https://www.bangwo8.com/api/v1/tickets/search.json" -G --data-urlencode "query=ticketStatus:4 createDT>2026-01-01" --header 'Authorization:Bearer eG1wcC1zaG93OmExMjM0NTY='

返回值示例

{
  "results": [
    {
      "subject":   "这里是工单标题",
      "createDT":  "2009-05-13 10:07:08",
      "updateDT":  "2011-07-22 11:11:12",
      "ticketId":  211,
      "url":       "https://www.bangwo8.com/api/v1/tickets/211.json"
    },
    {
      "subject":   "这里是工单标题",
      "createDT":  "2010-07-13 10:07:08",
      "updateDT":  "2011-07-13 11:11:12",
      "ticketId":  122,
      "url":       "https://www.bangwo8.com/api/v1/tickets/122.json"
    },
    ...
  ],
  "next_page": "https://www.bangwo8.com/api/v1/tickets/search.json?query=\"status:已开启\"&sort_by=createDT&sort_order=desc&page=2",
  "prev_page":2,
  "count": 200
}

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "tickets": {
        "results": [
            {
                "subject": "1234567899876434351884",
                "createDT": "2017-10-23 11:00:41",
                "updateDT": "2020-12-16 18:48:36",
                "ticketId": "474455",
                "url": "https://preview.bangwo8.com/api/v1/tickets/474455.json"
            },
            {
                "subject": "1234567899987654321",
                "createDT": "2017-10-23 11:01:19",
                "updateDT": "",
                "ticketId": "474457",
                "url": "https://preview.bangwo8.com/api/v1/tickets/474457.json"
            },
            {
                "subject": "123456964785",
                "createDT": "2017-10-23 11:50:33",
                "updateDT": "",
                "ticketId": "474633",
                "url": "https://preview.bangwo8.com/api/v1/tickets/474633.json"
            },
            {
                "subject": "12345467897664",
                "createDT": "2017-10-24 11:17:09",
                "updateDT": "",
                "ticketId": "476473",
                "url": "https://preview.bangwo8.com/api/v1/tickets/476473.json"
            },
            {
                "subject": "1234567890-",
                "createDT": "2017-11-17 10:07:56",
                "updateDT": "",
                "ticketId": "510987",
                "url": "https://preview.bangwo8.com/api/v1/tickets/510987.json"
            },
            {
                "subject": "1234567890766767",
                "createDT": "2017-11-17 10:10:00",
                "updateDT": "",
                "ticketId": "510993",
                "url": "https://preview.bangwo8.com/api/v1/tickets/510993.json"
            },
            {
                "subject": "1234567890789",
                "createDT": "2017-11-21 21:54:57",
                "updateDT": "",
                "ticketId": "524321",
                "url": "https://preview.bangwo8.com/api/v1/tickets/524321.json"
            }
        ],
        "count": "7",
        "previous_page": "",
        "next_page": ""
    }
}