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

dingtalk.oapi.pbp.instance.position.list (打卡业务平台获取业务所有可用位置)

打卡业务平台，获取业务所有可用位置位置包括硬件设备、GPS、Wifi等位置描述类型

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
biz_inst_id	String	必须	xxxxxx		业务实例唯一标识，由创建示例接口返回
type	Number	必须	100		位置类型，如100代表硬件B1设备
cursor	Number	可选	0	默认值：0	游标，用于分页查询
size	Number	必须	20		查询数据量

响应参数

名称	类型	示例值	描述
result	PageResult		分页结果
list PositionVo [] 位置列表 └ position_id String 12341123 位置唯一标识，根据type不同类型不同，如硬件类型代表硬件设备唯一标识 └ position_name String 1-101会议室位置名称 └ type Number 100 位置类型，如100代表硬件B1设备 └ has_more Boolean false 是否还有数据 └ next_cursor Number 100000231 下次请求需要带的游标
errmsg	String	type Illegal	错误信息
errcode	Number		系统自动生成

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/pbp/instance/position/list");
OapiPbpInstancePositionListRequest req = new OapiPbpInstancePositionListRequest();
req.setBizId("m_checkin");
req.setBizInstId("xxxxxx");
req.setType(100L);
req.setCursor(0L);
req.setSize(20L);
OapiPbpInstancePositionListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/pbp/instance/position/list");
OapiPbpInstancePositionListRequest req = new OapiPbpInstancePositionListRequest();
req.BizId = "m_checkin";
req.BizInstId = "xxxxxx";
req.Type = 100L;
req.Cursor = 0L;
req.Size = 20L;
OapiPbpInstancePositionListResponse 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 OapiPbpInstancePositionListRequest;
$req->setBizId("m_checkin");
$req->setBizInstId("xxxxxx");
$req->setType("100");
$req->setCursor("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/pbp/instance/position/list");

curl -X POST "https://oapi.dingtalk.com/topapi/pbp/instance/position/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2c9d03e2-b465-4e24-959e-7dfda839a802' \
-d 'biz_id=m_checkin' \
-d 'biz_inst_id=xxxxxx' \
-d 'cursor=0' \
-d 'size=20' \
-d 'type=100'

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

req=dingtalk.api.OapiPbpInstancePositionListRequest("https://oapi.dingtalk.com/topapi/pbp/instance/position/list")

req.biz_id="m_checkin"
req.biz_inst_id="xxxxxx"
req.type=100
req.cursor=0
req.size=20
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.pbp.instance.position.list");
add_param(pRequest,"biz_id","m_checkin");
add_param(pRequest,"biz_inst_id","xxxxxx");
add_param(pRequest,"type","100");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","20");
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.pbp.instance.position.list', {
	'biz_id':'m_checkin',
	'biz_inst_id':'xxxxxx',
	'type':'100',
	'cursor':'0',
	'size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "list":[
            {
                    "position_id":"12341123",
                    "position_name":"1-101会议室",
                    "type":100
            }
        ],
        "has_more":false,
        "next_cursor":100000231
    },
    "errmsg":"type Illegal",
    "errcode":
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.pbp.instance.position.list (打卡业务平台获取业务所有可用位置)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈