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

dingtalk.oapi.enterprise.familydr.list (所辖组织家医接口)

根据stat_date和corp_id查询家医数据

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
stat_date	String	必须	20190723		查询时间
corp_id	String	必须	dingabcd		企业ID
return_fields	String []	必须	stat_date,corp_id	最大列表长度：20	dept_name_lv3三级部门名称； live_launch_succ_user_cnt_1d 最近1天成功发起直播人数；live_launch_succ_user_cnt_1w 最近7天成功发起直播人数；live_play_user_cnt_1d 最近1天观看直播人数； live_play_user_cnt_1w 最近7天观看直播人数； dept_name_lv2 二级部门名称；
order_by	OrderBy	可选			排序
└ field String 可选 STAT_DATE 排查的key └ order String 可选 ACS或者DESC 升序或者降序
page_start	Number	必须	0		分页起始点
page_size	Number	必须	30		分页查询条数，最多30条

响应参数

名称	类型	示例值	描述
result	FamilyDoctorDataVo []		系统自动生成
└ live_play_user_cnt_1w String 0 最近7天观看直播人数 └ live_play_user_cnt_1d String 0 最近1天观看直播人数 └ live_launch_succ_user_cnt_1w String 0 最近7天成功发起直播人数 └ live_launch_succ_user_cnt_1d String 0 最近1天成功发起直播人数 └ dept_name_lv3 String 荷花疫苗三级部门名称 └ dept_name_lv2 String 荷花街道社区卫生服务中心二级部门名称 └ stat_date String 20190723 查询时间 └ corp_id String dingabcd 企业ID
success	Boolean	true	是否成功
errcode	Number	400002	错误码
errmsg	String	参数错误	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/enterprise/familydr/list");
OapiEnterpriseFamilydrListRequest req = new OapiEnterpriseFamilydrListRequest();
req.setStatDate("20190723");
req.setCorpId("dingabcd");
req.setReturnFields("stat_date,corp_id");
OrderBy obj1 = new OrderBy();
obj1.setField("STAT_DATE");
obj1.setOrder("ACS或者DESC");
req.setOrderBy(obj1);
req.setPageStart(0L);
req.setPageSize(30L);
OapiEnterpriseFamilydrListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/enterprise/familydr/list");
OapiEnterpriseFamilydrListRequest req = new OapiEnterpriseFamilydrListRequest();
req.StatDate = "20190723";
req.CorpId = "dingabcd";
req.ReturnFields = "stat_date,corp_id";
OapiEnterpriseFamilydrListRequest.OrderByDomain obj1 = new OapiEnterpriseFamilydrListRequest.OrderByDomain();
obj1.Field = "STAT_DATE";
obj1.Order = "ACS或者DESC";
req.OrderBy_ = obj1;
req.PageStart = 0L;
req.PageSize = 30L;
OapiEnterpriseFamilydrListResponse 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 OapiEnterpriseFamilydrListRequest;
$req->setStatDate("20190723");
$req->setCorpId("dingabcd");
$req->setReturnFields("stat_date,corp_id");
$order_by = new OrderBy;
$order_by->field="STAT_DATE";
$order_by->order="ACS或者DESC";
$req->setOrderBy($order_by);
$req->setPageStart("0");
$req->setPageSize("30");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/enterprise/familydr/list");

curl -X POST "https://oapi.dingtalk.com/topapi/enterprise/familydr/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=408044d8-0caa-4813-8e08-45fbc9cf5b99' \
-d 'corp_id=dingabcd' \
-d 'order_by=null' \
-d 'page_size=30' \
-d 'page_start=0' \
-d 'return_fields=stat_date%2Ccorp_id' \
-d 'stat_date=20190723'

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

req=dingtalk.api.OapiEnterpriseFamilydrListRequest("https://oapi.dingtalk.com/topapi/enterprise/familydr/list")

req.stat_date="20190723"
req.corp_id="dingabcd"
req.return_fields="stat_date,corp_id"
req.order_by=""
req.page_start=0
req.page_size=30
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.enterprise.familydr.list");
add_param(pRequest,"stat_date","20190723");
add_param(pRequest,"corp_id","dingabcd");
add_param(pRequest,"return_fields","stat_date,corp_id");
add_param(pRequest,"order_by","数据结构JSON示例");
add_param(pRequest,"page_start","0");
add_param(pRequest,"page_size","30");
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.enterprise.familydr.list', {
	'stat_date':'20190723',
	'corp_id':'dingabcd',
	'return_fields':'stat_date,corp_id',
	'order_by':'数据结构JSON示例',
	'page_start':'0',
	'page_size':'30'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "live_play_user_cnt_1w":"0",
                "live_play_user_cnt_1d":"0",
                "live_launch_succ_user_cnt_1w":"0",
                "live_launch_succ_user_cnt_1d":"0",
                "dept_name_lv3":"荷花疫苗",
                "dept_name_lv2":"荷花街道社区卫生服务中心",
                "stat_date":"20190723",
                "corp_id":"dingabcd"
        }
    ],
    "success":true,
    "errcode":400002,
    "errmsg":"参数错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.enterprise.familydr.list (所辖组织家医接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ