获取工单列表
服务描述
本接口可获取工单列表。
开发须知
调用本接口前,请先获取appId
服务地址
GET https://{您的专属域名}/workorder/openapi/v1/order/getPageList
请求参数
| 参数 |
位置 |
类型 |
是否必填 |
说明 |
| appId |
header |
String |
Y |
应用ID |
| timestamp |
header |
String |
Y |
时间戳,毫秒 |
| sign |
header |
String |
Y |
签名 |
| Content-Type |
header |
String |
Y |
application/json |
| pageNum |
url地址栏 |
integer |
N |
整型 页码,默认值是1 |
| pageSize |
url地址栏 |
integer |
N |
整型 每页记录的数量,默认值为20,最大值100 |
请求数据示例:
GET https://{您的专属域名}/workorder/openapi/v1/order/getPageList?pageNum=1&pageSize=20
返回结果
| 参数 |
类型 |
说明 |
| code |
String |
结果码 |
| message |
String |
结果描述 |
| data |
PageInfo |
分页数据 |
PageInfo
| 参数 |
类型 |
说明 |
| endRow |
integer |
结束行 |
| firstPage |
integer |
首页 |
| hasNextPage |
boolean |
是否有下一页 |
| hasPreviousPage |
boolean |
是否有上一页 |
| isFirstPage |
boolean |
是否首页 |
| isLastPage |
boolean |
是否末页 |
| lastPage |
integer |
末页数 |
| list |
WoOrderBaseVo |
工单数据集合 |
| navigatePages |
integer |
导航页数 |
| navigatepageNums |
< integer> array |
导航页码数组 |
| nextPage |
integer |
下一页 |
| orderBy |
String |
排序 |
| pageNum |
integer |
当前页 |
| pageSize |
integer |
每页记录的数量 |
| pages |
integer |
总页数 |
| prePage |
integer |
上一页 |
| size |
integer |
每页记录的数量 |
| startRow |
integer |
起始行数 |
| total |
integer |
总行数 |
WoOrderBaseVo
| 参数 |
类型 |
说明 |
| ccOperName |
string |
抄送人名称 (抄送人) |
| channelName |
string |
来源渠道(H5-渠道) |
| closeTime |
string (date-time) |
关闭时间 (H5-关闭时间)(单位:毫秒) |
| createCustomerName |
string |
创建人名称(创建客户名称) |
| createOpName |
string |
创建人名称(H5-客服名称) |
| createTime |
string (date-time) |
创建时间 (H5-创建时间)(单位:毫秒) |
| curOpGroupName |
string |
当前操作组名称 (H5-受理客服组) |
| curOpNames |
string |
当前操作人名称(多人,隔开) (H5-受理客服) |
| customerName |
string |
客户名称(H5-客户姓名) |
| flagOrder |
integer |
是否星标关注:0-非星标,1-星标 |
| lastReplyTime |
string (date-time) |
最后回复时间 (H5-最后回复时间)(单位:毫秒) |
| orderId |
string |
工单ID(H5-编号) |
| orderName |
string |
工单标题(H5-主题) |
| orderStatus |
integer |
工单状态:1-草稿,2-待办,3-进行中,4-已解决,5-已关闭(H5-状态) |
| priority |
integer |
优先级:1-低,2-正常,3-高,4-紧急(H5-优先级) |
| processName |
string |
流程名称(H5-类型) |
| resolvedTime |
string (date-time) |
解决时间 (H5-解决时间)(单位:毫秒) |
| tags |
string |
标签(H5-标签) |
| updateTime |
string (date-time) |
更新时间(H5-更新时间)(单位:毫秒) |
返回结果示例:
{
"code" : "10000",
"data" : {
"endRow" : 0,
"firstPage" : 0,
"hasNextPage" : true,
"hasPreviousPage" : true,
"isFirstPage" : true,
"isLastPage" : true,
"lastPage" : 0,
"list" : [ {
"ccOperName" : "string",
"channelName" : "string",
"closeTime" : "string",
"createCustomerName" : "string",
"createOpName" : "string",
"createTime" : "string",
"curOpGroupName" : "string",
"curOpNames" : "string",
"customerName" : "string",
"flagOrder" : 0,
"lastReplyTime" : "string",
"orderId" : "string",
"orderName" : "string",
"orderStatus" : 0,
"priority" : 0,
"processName" : "string",
"resolvedTime" : "string",
"tags" : "string",
"updateTime" : "string"
} ],
"navigatePages" : 0,
"navigatepageNums" : [ 0 ],
"nextPage" : 0,
"orderBy" : "string",
"pageNum" : 0,
"pageSize" : 0,
"pages" : 0,
"prePage" : 0,
"size" : 0,
"startRow" : 0,
"total" : 0
},
"message" : "请求成功"
}
结果码说明
| 结果码 |
说明 |
| 10000 |
请求成功 |
| 20001 |
请求失败 |
| 21002 |
认证失败,请重新登录 |
FAQ: