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

dingtalk.oapi.inspect.task.list (巡店任务查询接口)

钉钉巡店应用，巡店任务查询接口，按照部门分页查询一定时间范围的巡店任务详情。

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
param	TopInspectTaskDeptQueryPram	必须			请求入参
└ size Number 必须 20 分页请求数量，最大值50 └ cursor Number 可选 123122231 游标，从返回结果中获取，第一次请求可为空 └ status Number [] 必须 [1,2] 请求的状态列表，1已签到，2已正常签退，3已异常签退 └ end_date Number 必须 1577811600000 请求开始时间，时间戳，单位毫秒 └ start_date Number 必须 1577811600000 请求结束时间，时间戳，单位毫秒 └ dept_id String 必须 12312 部门id，从通讯录接口获取

响应参数

名称	类型	示例值	描述
result	PageResult	{..}	分页结果
└ next_cursor Number 123213 游标，下次分页请求使用 └ has_more Boolean true 是否还有数据 list TopInspectTaskVo [] [..] 巡店任务列表 └ duration String 240 巡店时间，单位秒 └ status String 1 任务状态，1已签到，2已正常签退，3已异常签退 └ check_out_time Number 1577811600000 签退时间戳，单位毫秒 └ check_in_time Number 1577811600000 签到时间戳，单位毫秒 └ userid String xxxxx 员工id └ work_date Number 1577808000000 工作日期时间戳，单位毫秒 └ task_id String xxxxxxx 任务id 唯一标识一个任务 └ position_id String 12345678 位置唯一标识，如果是B1等硬件设备则为设备唯一标识 └ position_name String XX门店位置名称
errcode	Number	10001	错误码
errmsg	String	xxxx	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/inspect/task/list");
OapiInspectTaskListRequest req = new OapiInspectTaskListRequest();
TopInspectTaskDeptQueryPram obj1 = new TopInspectTaskDeptQueryPram();
obj1.setSize(20L);
obj1.setCursor(123122231L);
obj1.setStatus(new Long[] { 1,2 };
);
obj1.setEndDate(1577811600000L);
obj1.setStartDate(1577811600000L);
obj1.setDeptId("12312");
req.setParam(obj1);
OapiInspectTaskListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/inspect/task/list");
OapiInspectTaskListRequest req = new OapiInspectTaskListRequest();
OapiInspectTaskListRequest.TopInspectTaskDeptQueryPramDomain obj1 = new OapiInspectTaskListRequest.TopInspectTaskDeptQueryPramDomain();
obj1.Size = 20L;
obj1.Cursor = 123122231L;
obj1.Status = new long[] { 1,2 };
;
obj1.EndDate = 1577811600000L;
obj1.StartDate = 1577811600000L;
obj1.DeptId = "12312";
req.Param_ = obj1;
OapiInspectTaskListResponse 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 OapiInspectTaskListRequest;
$param = new TopInspectTaskDeptQueryPram;
$param->size="20";
$param->cursor="123122231";
$param->status="[1,2]";
$param->end_date="1577811600000";
$param->start_date="1577811600000";
$param->dept_id="12312";
$req->setParam($param);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/inspect/task/list");

curl -X POST "https://oapi.dingtalk.com/topapi/inspect/task/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f7c2caf5-e5bb-4069-8fae-759653b6d7ee' \
-d 'param=null'

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

req=dingtalk.api.OapiInspectTaskListRequest("https://oapi.dingtalk.com/topapi/inspect/task/list")

req.param=""
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.inspect.task.list");
add_param(pRequest,"param","数据结构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.inspect.task.list', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "next_cursor":123213,
        "has_more":true,
        "list":[
            {
                    "duration":"240",
                    "status":"1",
                    "check_out_time":1577811600000,
                    "check_in_time":1577811600000,
                    "userid":"xxxxx",
                    "work_date":1577808000000,
                    "task_id":"xxxxxxx",
                    "position_id":"12345678",
                    "position_name":"XX门店"
            }
        ]
    },
    "errcode":10001,
    "errmsg":"xxxx"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.inspect.task.list (巡店任务查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ