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

dingtalk.oapi.chat.banwords.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
chatid	String	必须	chat134fsdr34f		会话ID
userid	String	可选	115192158741122		被查询的用户ID

响应参数

名称	类型	示例值	描述
success	Boolean	true	是否成功
errcode	Number	-1	错误码
errmsg	String	系统错误	错误信息
result	OpenBanWordModel	OpenBanWordModel	结果集
user_ban_words UserBanWordModel UserBanWordModel 单个人禁言的状态 └ start_time Number 1569056520563 开始禁言的时间戳 └ ban_words_status Boolean true true为该用户禁言，false该用户没有被禁言 └ end_time Number 1569057520563 结束禁言的时间戳 └ all_ban_words Boolean true true为开启全员禁言，false为关闭全员禁言

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chat/banwords/query");
OapiChatBanwordsQueryRequest req = new OapiChatBanwordsQueryRequest();
req.setChatid("chat134fsdr34f");
req.setUserid("115192158741122");
OapiChatBanwordsQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chat/banwords/query");
OapiChatBanwordsQueryRequest req = new OapiChatBanwordsQueryRequest();
req.Chatid = "chat134fsdr34f";
req.Userid = "115192158741122";
OapiChatBanwordsQueryResponse 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 OapiChatBanwordsQueryRequest;
$req->setChatid("chat134fsdr34f");
$req->setUserid("115192158741122");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/chat/banwords/query");

curl -X POST "https://oapi.dingtalk.com/topapi/chat/banwords/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2e3e3ec3-40dd-4038-a67c-57de2e76cf25' \
-d 'chatid=chat134fsdr34f' \
-d 'userid=115192158741122'

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

req=dingtalk.api.OapiChatBanwordsQueryRequest("https://oapi.dingtalk.com/topapi/chat/banwords/query")

req.chatid="chat134fsdr34f"
req.userid="115192158741122"
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.chat.banwords.query");
add_param(pRequest,"chatid","chat134fsdr34f");
add_param(pRequest,"userid","115192158741122");
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.chat.banwords.query', {
	'chatid':'chat134fsdr34f',
	'userid':'115192158741122'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":true,
    "errcode":-1,
    "errmsg":"系统错误",
    "result":{
        "user_ban_words":{
            "start_time":1569056520563,
            "ban_words_status":true,
            "end_time":1569057520563
        },
        "all_ban_words":true
    }
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

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

联系方式

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

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

提交反馈

用户反馈

感谢您的反馈！

用户反馈

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

钉钉API

dingtalk.oapi.chat.banwords.query (查询群禁言状态和单个人禁言状态)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈