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

dingtalk.oapi.kac.openlive.white_users.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。

请求参数

名称	类型	是否必须	示例值	描述
page_start	Number	必须	1	分页号，从1开始
page_size	Number	必须	100	分页大小
live_id	String	必须	xxx	直播id

响应参数

名称	类型	示例值	描述
result	ResultList	无	结果集合
values ListLiveUserWhitelistResponse [] 无直播对应的人员信息 └ user_id String xxx 员工id └ total_cnt Number 100 人员总数
success	Boolean	true	是否成功
errcode	Number	240010	错误码
errmsg	String	参数错误	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/openlive/white_users/list");
OapiKacOpenliveWhiteUsersListRequest req = new OapiKacOpenliveWhiteUsersListRequest();
req.setPageStart(1L);
req.setPageSize(100L);
req.setLiveId("xxx");
OapiKacOpenliveWhiteUsersListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/kac/openlive/white_users/list");
OapiKacOpenliveWhiteUsersListRequest req = new OapiKacOpenliveWhiteUsersListRequest();
req.PageStart = 1L;
req.PageSize = 100L;
req.LiveId = "xxx";
OapiKacOpenliveWhiteUsersListResponse 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 OapiKacOpenliveWhiteUsersListRequest;
$req->setPageStart("1");
$req->setPageSize("100");
$req->setLiveId("xxx");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/kac/openlive/white_users/list");

curl -X POST "https://oapi.dingtalk.com/topapi/kac/openlive/white_users/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=6b478fd5-a935-456c-b8ec-24dd1a7f9b53' \
-d 'live_id=xxx' \
-d 'page_size=100' \
-d 'page_start=1'

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

req=dingtalk.api.OapiKacOpenliveWhiteUsersListRequest("https://oapi.dingtalk.com/topapi/kac/openlive/white_users/list")

req.page_start=1
req.page_size=100
req.live_id="xxx"
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.kac.openlive.white_users.list");
add_param(pRequest,"page_start","1");
add_param(pRequest,"page_size","100");
add_param(pRequest,"live_id","xxx");
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.kac.openlive.white_users.list', {
	'page_start':'1',
	'page_size':'100',
	'live_id':'xxx'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "values":[
            {
                    "user_id":"xxx"
            }
        ],
        "total_cnt":100
    },
    "success":true,
    "errcode":240010,
    "errmsg":"参数错误"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.kac.openlive.white_users.list (查直播人员白名单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ