1. 工单管理
帮我吧API接口文档v1
  • 接口地图
  • 一、快速入门
    • 帮我吧数据接口 - 开发向导
    • 1.1 获取 Token
      POST
  • 二、核心业务实体
    • 2.1 客户与联系人
      • 联系人管理
        • 获取联系人列表
        • 获取多个联系人详情
        • 批量联系人详情
        • 搜索联系人
        • 创建联系人
        • 修改联系人
        • 删除联系人
        • 批量删除联系人
      • 客户分组
        • 获取分组列表
        • 获取分组详情
        • 批量分组详情
        • 创建分组
        • 修改分组
        • 获取分组用户
      • 联系人字段
        • 获取联系人字段列表
      • 公司管理
        • 获取公司列表
        • 获取公司详情
        • 批量公司详情
        • 创建公司
        • 修改公司
        • 删除公司
        • 批量删除公司
        • 搜索公司
      • 公司字段
        • 获取公司字段列表
        • 获取公司联系人
      • 远程 ID 管理
        • 获取远程ID信息
        • 修改远程ID备注
        • 远程ID绑定联系人
        • 解绑远程 ID
    • 2.2 工单
      • 工单管理
        • 获取工单列表
          GET
        • 获取工单详情
          GET
        • 批量工单详情
          GET
        • 搜索工单
          GET
        • 创建工单
          POST
        • 修改工单
          PUT
        • 批量修改工单
          PUT
        • 工单拆单
          POST
      • 工单回复
        • 获取工单回复列表
      • 工单附件
        • 上传工单附件
      • 工单字段
        • 获取工单自定义字段
        • 获取工单所有字段
        • 覆盖字段选项
        • 更新字段选项
        • 删除字段选项
      • 工单模板
        • 获取模板列表
        • 批量工单模板
        • 获取模板详情
        • 获取模板字段
      • 工单查询器
        • 获取查询器列表
        • 获取查询器详情
        • 获取查询器的工单列表
        • 获取查询器的工单总数
        • 批量获取查询器工单数量
    • 2.3 服务记录
      • IM 服务记录
        • 获取 IM 聊天记录
        • 获取 IM 会话列表
        • 获取 IM 会话详情
        • 获取服务总结(IM)
      • CC 服务记录
        • 获取呼叫中心记录列表
        • 获取呼叫中心记录详情
        • 获取指定客服的通话记录列表
        • 获取服务总结(CC)
        • 录音解冻
      • 远程协助记录
        • 获取远程记录列表
        • 获取坐席远程记录
        • 获取远程记录的聊天记录
        • 获取服务总结(远程协助)
      • 服务总结
        • 获取业务模板列表
        • 获取业务模板详情
        • 获取业务记录列表
        • 获取业务记录详情
        • 修改业务记录
    • 2.4 知识库
      • 知识库条目
        • 获取知识库列表
        • 获取知识库详情
        • 获取多条知识库
        • 创建知识库
        • 修改知识库
        • 上传知识库附件
      • 知识库分类
        • 获取知识库分类列表
        • 新增知识库分类
        • 修改知识库分类
        • 删除知识库分类
      • 附件上传
        • 上传附件
  • 三、人员与组织
    • 3.1 客服管理
      • 获取客服列表
      • 获取客服详情
      • 搜索客服
      • 获取多个客服信息
      • 创建客服
      • 修改客服信息
      • 删除客服信息
      • 恢复删除的客服
      • 客服授权
      • 查看客服状态
      • 修改客服状态
      • 获取客服签到列表
      • 创建客服签到
      • 获取客服排班列表
      • 新增客服排班
      • 更新客服排班
      • 删除客服排班
    • 3.2 客服组管理
      • 获取客服组列表
      • 获取客服组详情
      • 获取客服组下的客服
      • 创建客服组
      • 修改客服组
      • 删除客服组
  • 四、系统配置
    • 4.1 表单管理
      • 获取表单列表
      • 获取表单详情
      • 创建表单
      • 修改表单
      • 删除表单
    • 4.2 表单字段
      • 查询指定表单的字段列表
      • 表单字段选项增加、更新
    • 4.3 资产表
      • 获取指定资产表的所有数据
      • 给指定资产表添加一行数据
      • 给指定资产表添加多行数据
      • 根据唯一值更新指定资产表一行数据
      • 更新指定资产表一行数据
      • 删除一行数据
      • 搜索资产表中的资产数据
    • 4.4 自定义字段配置
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 4.5 客服分组管理
      • 获取客服分组列表
      • 获取客服分组详情
      • 创建客服分组
      • 修改客服分组
      • 删除客服分组
    • 4.6 工单查询器管理
      • 获取查询器列表
      • 获取查询器详情
      • 获取查询器的工单列表
      • 获取查询器的工单总数
      • 批量获取查询器工单数量
    • 4.7 工单模板管理
      • 获取模板列表
      • 批量工单模板
      • 获取模板详情
      • 获取模板字段
    • 4.8 客户分组管理
      • 获取分组列表
      • 获取分组详情
      • 批量分组详情
      • 创建分组
      • 修改分组
      • 获取分组用户
    • 4.9 短信接口
      • 获取模板列表
      • 发送短信
    • 4.10 服务商设置
      • 获取服务商账号到期时间
    • 4.11 外部扩展集成
      • 扩展系统配置文档
      • 扩展页接口文档
      • 适用客户
  • 五、呼叫中心
    • 5.1 获取客服话机状态
      • 获取客服话机状态
    • 5.2 接听模式切换
      • 切换接听模式
    • 5.3 SDK网页集成(CC)
      • 适用场景
      • 快速集成
      • 高级对接
  • 六、在线客服
    • 6.1 SDK网页集成(IM)
      • 适用场景
      • 快速集成
      • 高级对接
  • 七、公共接口
    • 7.1 获取 Token
      • 获取 OAuth2 Token
    • 7.2 标签接口
      • 获取标签列表
  1. 工单管理

获取工单列表

GET
https://www.bangwo8.com/api/v1/tickets.json
最后修改时间:2026-04-06 05:16:25
责任人:未设置
获取工单列表,支持分页和筛选

请求参数说明#

名称必要的类型注释
created_start否string按创建时间查询:开始时间,包含当天
created_end否string按创建时间查询:结束时间,包含当天
updated_start否string按更新时间查询:开始时间,包含当天
updated_end否string按更新时间查询:结束时间,包含当天
created_order否string按创建时间排序:asc(升序),desc(降序)
updated_order否string按更新时间排序:asc(升序),desc(降序)
status_order否string按工单状态排序:asc(升序),desc(降序)
page否number页码,默认为 1
per_page否number每页大小,默认为 10
说明:
默认按编码升序返回。
时间参数(created_start、created_end、updated_start、updated_end)格式为“2026-01-01 00:00:00”。
分页说明:
数据返回条数太多时,会自动分页,默认每页100条。
可以在请求url里更改 per_page 参数的值来自定义每页返回的条数,建议不要超过100条,因为会影响接口返回速度。
当请求的数据个数超过 per_page 参数值时,可设置自增的 page 参数继续请求下一页数据。
其他请求方式:
查看服务商下某个客户的工单
GET http://www.bangwo8.com/api/v1/companies/{company_id}/tickets.json
查看服务商下某个客户的某个联系人的工单
GET http://www.bangwo8.com/api/v1/users/{user_id}/tickets.json

返回参数说明#

名称类型必填描述
ticketIdint是工单id,系统自动生成
custUserIdint否联系人id,说明该工单是为该客户解决问题
subjectString是工单标题
descriptString是工单描述
servicerUserIdint否受理客服id(如果想置空需要传0)
ccUserIdListstring否抄送客服id列表
ticketTypeint否工单类型:1–问题,2–事务,3–故障,4–任务
priorityLevelint否工单优先级:1–低,2–正常,3–高,4–紧急
tagListint否工单标签列表,以逗号分隔
ticketStatusint否工单状态:1–新建,2–已开启,3–待回应,4–已解决,5–自动关闭,6–手动关闭
createDTdatetime是工单创建时间
updateDTdatetime是工单更新时间
solveDTdatetime否解决时间
waitDTdatetime否等待时间
openDTdatetime否开启时间
closeDTdatetime否关闭时间
servicerGroupIdint否受理客服组id
createrIdint是工单创建人id
createrTypeint否工单创建人类型,0-客服 1-客户
agentIdint是关联agents表aId
ticketSourceint否工单来源:1–远程,2–聊天,3–呼叫中心,4–留言,5–系统创建,6-其他,7–API,8–工单模板发布,9–邮件接入,10-其他服务商,11-工单工作台,12-手动导入,13-客户管理自动化任务,14-帮我吧APP
ticketTemplateIdint是工单模板id,创建工单需指明当前工单使用哪个工单模板
ccGroupIdListstring否抄送客服组id列表
customTemplateIdint否客户模板id
rootTicketint否该工单关联哪单,填写想关联工单的工单号即可(显示在后台会显示拆自此单,工单来源为API)
createrTypeString否创建类型
currentNodeFieldString否节点字段
currentNodeFieldValueString否节点
nodeFieldIntoTimeString否节点时间
queryIDsString否
custom_fieldsarray否工单自定义字段
tablesarray否工单中的普通表单、评价表单
countint是所有工单数量
next_pageString否下一页地址
previous_pageString否上一页地址

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://www.bangwo8.com/api/v1/tickets.json?page=1&per_page=10&state=&groupId=&servicerId=&userId=&companyId=&created_start=&created_end=' \
--header 'Authorization: Basic <encoded-value>'

返回响应

🟢200成功
application/json
Body

示例
{
    "tickets": [
        {
            "servicerGroupId": "5399",
            "servicerUserId": "176853",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_342334903843",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "176853",
            "agentId": "128789",
            "ticketTemplateId": "4",
            "ccGroupIdList": "",
            "custUserId": "0",
            "createrType": "0",
            "updateDT": "2020-07-01 16:35:53",
            "createDT": "2020-07-01 16:35:53",
            "ticketId": "10338961",
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": []
        },
        {
            "servicerGroupId": "5399",
            "servicerUserId": "176853",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_179028813514",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "176853",
            "agentId": "128789",
            "ticketTemplateId": "4",
            "ccGroupIdList": "",
            "custUserId": "0",
            "createrType": "0",
            "updateDT": "2020-07-01 16:49:22",
            "createDT": "2020-07-01 16:49:22",
            "ticketId": "10339432",
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": []
        },
        {
            "ticketId": "1045325",
            "custUserId": "8471227",
            "subject": "邮件接入",
            "descript": "邮件接入",
            "servicerUserId": "0",
            "ccUserIdList": "",
            "ticketType": "0",
            "priorityLevel": "0",
            "tagList": "0",
            "ticketStatus": "1",
            "createDT": "2018-02-03 18:10:57",
            "updateDT": "2020-09-04 10:18:43",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": "",
            "servicerGroupId": "0",
            "createrId": "0",
            "agentId": "128789",
            "ticketSource": "9",
            "ticketTemplateId": "0",
            "ccGroupIdList": "",
            "customTemplateId": "0",
            "createrType": "0",
            "currentNodeField": "",
            "currentNodeFieldValue": "",
            "nodeFieldIntoTime": "0",
            "queryIDs": "",
            "descriptattachments": [],
            "custom_fields": []
        },
        {
            "ticketId": "1045327",
            "custUserId": "8471229",
            "subject": "欢迎使用腾讯企业邮箱",
            "descript": "欢迎使用腾讯企业邮箱",
            "servicerUserId": "0",
            "ccUserIdList": "",
            "ticketType": "0",
            "priorityLevel": "0",
            "tagList": "",
            "ticketStatus": "1",
            "createDT": "2018-02-03 18:10:58",
            "updateDT": "",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": "",
            "servicerGroupId": "",
            "createrId": "0",
            "agentId": "128789",
            "ticketSource": "9",
            "ticketTemplateId": "0",
            "ccGroupIdList": "",
            "customTemplateId": "0",
            "createrType": "0",
            "currentNodeField": "",
            "currentNodeFieldValue": "",
            "nodeFieldIntoTime": "0",
            "queryIDs": "",
            "descriptattachments": [],
            "custom_fields": []
        },
        {
            "ticketId": "1045329",
            "custUserId": "8471229",
            "subject": "欢迎使用腾讯企业邮箱",
            "descript": "欢迎使用腾讯企业邮箱",
            "servicerUserId": "0",
            "ccUserIdList": "",
            "ticketType": "0",
            "priorityLevel": "0",
            "tagList": "",
            "ticketStatus": "1",
            "createDT": "2018-02-03 18:10:59",
            "updateDT": "",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": "",
            "servicerGroupId": "",
            "createrId": "0",
            "agentId": "128789",
            "ticketSource": "9",
            "ticketTemplateId": "0",
            "ccGroupIdList": "",
            "customTemplateId": "0",
            "createrType": "0",
            "currentNodeField": "",
            "currentNodeFieldValue": "",
            "nodeFieldIntoTime": "0",
            "queryIDs": "",
            "descriptattachments": [],
            "custom_fields": []
        },
        {
            "ticketId": "1045331",
            "custUserId": "8471227",
            "subject": "哎哟喂",
            "descript": "哎哟喂",
            "servicerUserId": "176853",
            "ccUserIdList": "",
            "ticketType": "0",
            "priorityLevel": "0",
            "tagList": "",
            "ticketStatus": "1",
            "createDT": "2018-02-03 18:13:21",
            "updateDT": "2018-02-03 18:27:36",
            "solveDT": "",
            "waitDT": "",
            "openDT": "",
            "closeDT": "",
            "servicerGroupId": "5399",
            "createrId": "0",
            "agentId": "128789",
            "ticketSource": "9",
            "ticketTemplateId": "0",
            "ccGroupIdList": "",
            "customTemplateId": "0",
            "createrType": "0",
            "currentNodeField": "",
            "currentNodeFieldValue": "",
            "nodeFieldIntoTime": "0",
            "queryIDs": "",
            "descriptattachments": [],
            "custom_fields": []
        },
        {
            "servicerGroupId": "279766",
            "servicerUserId": "194589",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_668367159521",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "194589",
            "agentId": "128789",
            "ticketTemplateId": "3",
            "ccGroupIdList": "",
            "custUserId": "24608353",
            "createrType": "0",
            "updateDT": "2020-07-31 15:03:44",
            "createDT": "2020-07-31 15:03:44",
            "ticketId": "10786366",
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": [
                {
                    "key": "field_1",
                    "value": ""
                },
                {
                    "key": "servicesummary_default_field",
                    "value": ""
                },
                {
                    "key": "field_7",
                    "value": ""
                },
                {
                    "key": "field_17",
                    "value": ""
                }
            ]
        },
        {
            "servicerGroupId": "5399",
            "servicerUserId": "194589",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_482048757029",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "194589",
            "agentId": "128789",
            "ticketTemplateId": "3",
            "ccGroupIdList": "",
            "custUserId": "0",
            "createrType": "0",
            "updateDT": "2020-08-05 10:22:27",
            "createDT": "2020-08-05 10:22:27",
            "ticketId": "10846027",
            "currentServiceUserId": "194589",
            "firstResponse": true,
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": [
                {
                    "key": "field_1",
                    "value": ""
                },
                {
                    "key": "servicesummary_default_field",
                    "value": ""
                },
                {
                    "key": "field_7",
                    "value": ""
                },
                {
                    "key": "field_17",
                    "value": ""
                }
            ]
        },
        {
            "servicerGroupId": "5399",
            "servicerUserId": "194589",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_300697562938",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "194589",
            "agentId": "128789",
            "ticketTemplateId": "3",
            "ccGroupIdList": "",
            "custUserId": "29406808",
            "createrType": "0",
            "updateDT": "2020-08-21 18:29:39",
            "createDT": "2020-08-21 18:29:39",
            "ticketId": "11074117",
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": [
                {
                    "key": "field_1",
                    "value": ""
                },
                {
                    "key": "servicesummary_default_field",
                    "value": ""
                },
                {
                    "key": "field_7",
                    "value": ""
                },
                {
                    "key": "field_17",
                    "value": ""
                }
            ]
        },
        {
            "servicerGroupId": "5399",
            "servicerUserId": "194589",
            "ticketType": "",
            "priorityLevel": "",
            "tagList": "",
            "subject": "聊天-u2_128789_300697562938",
            "descript": "",
            "ticketStatus": "1",
            "ticketSource": "2",
            "createrId": "194589",
            "agentId": "128789",
            "ticketTemplateId": "3",
            "ccGroupIdList": "",
            "custUserId": "29406808",
            "createrType": "0",
            "updateDT": "2020-08-21 18:30:56",
            "createDT": "2020-08-21 18:30:56",
            "ticketId": "11074132",
            "descriptattachments": [],
            "ccUserIdList": "",
            "custom_fields": [
                {
                    "key": "field_1",
                    "value": ""
                },
                {
                    "key": "servicesummary_default_field",
                    "value": ""
                },
                {
                    "key": "field_7",
                    "value": ""
                },
                {
                    "key": "field_17",
                    "value": ""
                }
            ]
        }
    ],
    "count": "307",
    "previous_page": "",
    "next_page": "https://www.bangwo8.com/api/v1/tickets.json?per_page=10&page=2&state=&groupId=&servicerId=&userId=&companyId=&created_start=&created_end="
}
修改于 2026-04-06 05:16:25
上一页
解绑远程 ID
下一页
获取工单详情
Built with