文档中心 > API类目 > 钉钉API

dingtalk.oapi.customerservice.ticket.query (分页查询工单列表)

企业的会员查询其提交的工单列表

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
ticket_page_query_dto	TicketPageQueryDto	必须			查询对象
└ source_id String 必须 1030043 三方账号标识 └ foreign_id String 必须 song_0102 三方账号id └ ticket_template_id String 必须 12 工单类型id └ foreign_name String 必须 song_01 三方账号姓名 └ end_date Date 可选 2020-05-13 00:00:00 结束时间 └ ticket_status String 可选 1 待受理 └ start_date Date 可选 2020-01-01 00:00:00 开始时间 └ ticket_id String 可选 2000000000100517 工单id └ size Number 必须 20 分页大小 └ cursor Number 必须 20 游标 └ production_type String 可选 1 默认值：1 1智能客服 └ open_instance_id String 可选 shop001 默认值：default 实例id

响应参数

名称	类型	示例值	描述
result	DingOpenResult	json	返回结果
result PageQueryCursorResult json 分页结果对象 └ total Number 200 总数 ticket_list TicketBaseDto [] [{}] 工单列表 └ gmt_modified Date 2020-04-24 12:07:43 最新修改时间 └ ticket_id String 2000000000100517 工单id └ title String 我要反馈问题工单标题 └ template_id String 12 模板id └ gmt_create Date 2020-03-24 12:07:43 新建时间 └ ticket_status String 受理中工单状态 └ next_cursor Number 40 下一次分页的游标 └ has_more Boolean true 是否有更多数据 └ success Boolean false 是否成功 └ errcode Number 50010 错误吗 └ errmsg String 内部异常错误消息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/customerservice/ticket/query");
OapiCustomerserviceTicketQueryRequest req = new OapiCustomerserviceTicketQueryRequest();
TicketPageQueryDto obj1 = new TicketPageQueryDto();
obj1.setSourceId("1030043");
obj1.setForeignId("song_0102");
obj1.setTicketTemplateId("12");
obj1.setForeignName("song_01");
obj1.setEndDate(StringUtils.parseDateTime("2020-05-13 00:00:00"));
obj1.setTicketStatus("1");
obj1.setStartDate(StringUtils.parseDateTime("2020-01-01 00:00:00"));
obj1.setTicketId("2000000000100517");
obj1.setSize(20L);
obj1.setCursor(20L);
obj1.setProductionType("1");
obj1.setOpenInstanceId("shop001");
req.setTicketPageQueryDto(obj1);
OapiCustomerserviceTicketQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/customerservice/ticket/query");
OapiCustomerserviceTicketQueryRequest req = new OapiCustomerserviceTicketQueryRequest();
OapiCustomerserviceTicketQueryRequest.TicketPageQueryDtoDomain obj1 = new OapiCustomerserviceTicketQueryRequest.TicketPageQueryDtoDomain();
obj1.SourceId = "1030043";
obj1.ForeignId = "song_0102";
obj1.TicketTemplateId = "12";
obj1.ForeignName = "song_01";
obj1.EndDate = DateTime.Parse(2020-05-13 00:00:00");
obj1.TicketStatus = "1";
obj1.StartDate = DateTime.Parse(2020-01-01 00:00:00");
obj1.TicketId = "2000000000100517";
obj1.Size = 20L;
obj1.Cursor = 20L;
obj1.ProductionType = "1";
obj1.OpenInstanceId = "shop001";
req.TicketPageQueryDto_ = obj1;
OapiCustomerserviceTicketQueryResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiCustomerserviceTicketQueryRequest;
$ticket_page_query_dto = new TicketPageQueryDto;
$ticket_page_query_dto->source_id="1030043";
$ticket_page_query_dto->foreign_id="song_0102";
$ticket_page_query_dto->ticket_template_id="12";
$ticket_page_query_dto->foreign_name="song_01";
$ticket_page_query_dto->end_date="2020-05-13 00:00:00";
$ticket_page_query_dto->ticket_status="1";
$ticket_page_query_dto->start_date="2020-01-01 00:00:00";
$ticket_page_query_dto->ticket_id="2000000000100517";
$ticket_page_query_dto->size="20";
$ticket_page_query_dto->cursor="20";
$ticket_page_query_dto->production_type="1";
$ticket_page_query_dto->open_instance_id="shop001";
$req->setTicketPageQueryDto($ticket_page_query_dto);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/customerservice/ticket/query");

curl -X POST "https://oapi.dingtalk.com/topapi/customerservice/ticket/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=1cc87ead-f656-4688-9972-d41d9c20e80a' \
-d 'ticket_page_query_dto=null'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiCustomerserviceTicketQueryRequest("https://oapi.dingtalk.com/topapi/customerservice/ticket/query")

req.ticket_page_query_dto=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.customerservice.ticket.query");
add_param(pRequest,"ticket_page_query_dto","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.customerservice.ticket.query', {
	'ticket_page_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "result":{
            "total":200,
            "ticket_list":[
                {
                        "gmt_modified":"2020-04-24 12:07:43",
                        "ticket_id":"2000000000100517",
                        "title":"我要反馈问题",
                        "template_id":"12",
                        "gmt_create":"2020-03-24 12:07:43",
                        "ticket_status":"受理中"
                }
            ],
            "next_cursor":40,
            "has_more":true
        },
        "success":false,
        "errcode":50010,
        "errmsg":"内部异常"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.customerservice.ticket.query (分页查询工单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ