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

dingtalk.oapi.chat.updatebanwords (设置部分成员群禁言)

API实现群主对成员单个人的禁言

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid_list	String []	必须	123,321	最大列表长度：20	被禁言人id列表
chatid	String	必须	adhfaqf		chatid
type	Number	必须	1		0表示剔除禁言名单，1表示加入禁言名单
ban_words_time	Number	必须	1000		禁言时间，单位ms

响应参数

名称	类型	示例值	描述
success	Boolean	true	成功
errcode	Number	null	成功
errmsg	String	null	成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chat/updatebanwords");
OapiChatUpdatebanwordsRequest req = new OapiChatUpdatebanwordsRequest();
req.setUseridList("123,321");
req.setChatid("adhfaqf");
req.setType(1L);
req.setBanWordsTime(1000L);
OapiChatUpdatebanwordsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chat/updatebanwords");
OapiChatUpdatebanwordsRequest req = new OapiChatUpdatebanwordsRequest();
req.UseridList = "123,321";
req.Chatid = "adhfaqf";
req.Type = 1L;
req.BanWordsTime = 1000L;
OapiChatUpdatebanwordsResponse 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 OapiChatUpdatebanwordsRequest;
$req->setUseridList("123,321");
$req->setChatid("adhfaqf");
$req->setType("1");
$req->setBanWordsTime("1000");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/chat/updatebanwords");

curl -X POST "https://oapi.dingtalk.com/topapi/chat/updatebanwords" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a41ee1f8-eaa1-447b-b7b8-1c4df09b434c' \
-d 'ban_words_time=1000' \
-d 'chatid=adhfaqf' \
-d 'type=1' \
-d 'userid_list=123%2C321'

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

req=dingtalk.api.OapiChatUpdatebanwordsRequest("https://oapi.dingtalk.com/topapi/chat/updatebanwords")

req.userid_list="123,321"
req.chatid="adhfaqf"
req.type=1
req.ban_words_time=1000
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.updatebanwords");
add_param(pRequest,"userid_list","123,321");
add_param(pRequest,"chatid","adhfaqf");
add_param(pRequest,"type","1");
add_param(pRequest,"ban_words_time","1000");
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.updatebanwords', {
	'userid_list':'123,321',
	'chatid':'adhfaqf',
	'type':'1',
	'ban_words_time':'1000'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":true,
    "errcode":null,
    "errmsg":"null"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.chat.updatebanwords (设置部分成员群禁言)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ