分页查询工单

说明

调用本接口分页查询工单。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	客服行业的工单读接口权限	API Explorer
第三方企业应用	支持	客服行业的工单读接口权限	API Explorer
第三方个人应用	暂不支持	客服行业的工单读接口权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	system.error	系统错误	系统错误
400	illegal.parameter	参数错误	参数错误

请求参数

Query 参数

openInstanceId

string

实例ID。

可选

productionType

string

智能客服产品类型：

可选

templateId

string

工单模板ID。

必需

ticketId

string

工单ID。

可选

sourceId

string

可选

会员来源，取diamond配置的值。
需要和foreignId参数配合，需要两个都为空或两个都不为空。

foreignId

string

可选

第三方用户userid。
需要和sourceId参数配合，需要两个都为空或者两个都不为空。

ticketStatus

string

可选

工单状态。
在钉钉工单类型配置里的工单状态机里自主配置。

startTime

string

可选

开始时间，时间戳，单位毫秒。

endTime

string

可选

结束时间，时间戳，单位毫秒。

nextToken

string

必需

查询数据的起始位置，0表示从头开始。

maxResults

string

必需

查询单页查询的最大条目数，最大值为100。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

nextCursor

integer

可选

是否还有下一页数据。

total

integer

总记录数。

可选

list

array [object {12}]

查询结果。

可选

foreignId

string

可选

第三方会员。
如果系统中不存在需要在CRM中新建。

sourceId

string

第三方来源。

可选

foreignName

string

第三方会员名。

可选

templateId

string

工单模板ID。

可选

title

string

工单标题。

可选

ticketId

string

工单ID。

可选

ticketStatus

string

可选

工单状态。
在钉钉工单类型配置里的工单状态机里自主配置。

openInstanceId

string

实例ID。

可选

productionType

integer

智能客服产品类型：

可选

gmtCreate

string

创建时间。

可选

gmtModified

string

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码