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

dingtalk.oapi.im.chat.scenegroup.update (场景群更新)

根据传入的群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。

请求参数

名称	类型	是否必须	示例值	描述
owner_user_id	String	可选	123	群主userid
icon	String	可选	@asdf12zcv	群头像mediaId
mention_all_authority	Number	可选	0	@all 权限，0-默认，所有人，1-仅群主可@all
show_history_type	Number	可选	0	新成员是否可查看聊天历史消息，0-默认，否，1-是
validation_type	Number	可选	0	入群验证，0：不入群验证（默认） 1：入群验证
searchable	Number	可选	0	群可搜索，0-默认，不可搜索，1-可搜索
chat_banned_type	Number	可选	0	群禁言，0-默认，不禁言，1-全员禁言
management_type	Number	可选	0	管理类型，0-默认，所有人可管理，1-仅群主可管理
title	String	可选	测试群	群名称
open_conversation_id	String	必须	131231	群id
only_admin_can_ding	Number	可选	0	仅群主和管理员可在群内发DING 0-不开启，1-开启
all_members_can_create_mcs_conf	Number	可选	0	群会议若开启，群内任意成员可发起视频和语音会议 0-不开启，1-开启
all_members_can_create_calendar	Number	可选	0	群日历若开启，群内容非好友/同事的成员可相互发起钉钉日程 0-不开启，1-开启
group_email_disabled	Number	可选	0	禁止发送群邮件若开启，群内成员不可再对本群发送群邮件 0-不开启，1-开启
only_admin_can_set_msg_top	Number	可选	0	仅群主和管理员可置顶群消息 0-不开启，1-开启
add_friend_forbidden	Number	可选	0	禁止群成员私聊若开启，普通群成员之间不能够加好友、单聊，且部分功能使用受限（管理员与非管理员之间不受影响）0-不开启，1-开启
group_live_switch	Number	可选	0	群直播若开启，群内任意成员可发起群直播 0-不开启，1-开启
members_to_admin_chat	Number	可选	0	禁止非管理员向管理员发起单聊若开启，非管理员不能向管理员发起单聊 0-不开启，1-开启
plugin_customize_verify	Number	可选	0	自定义群插件是否需要群主和管理员审批0-不需要审批，1-需要审批

响应参数

名称	类型	示例值	描述
success	Boolean		返回结果
errcode	Number	1001	错误码
errmsg	String	systemerror	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/scenegroup/update");
OapiImChatScenegroupUpdateRequest req = new OapiImChatScenegroupUpdateRequest();
req.setOwnerUserId("123");
req.setIcon("@asdf12zcv");
req.setMentionAllAuthority(0L);
req.setShowHistoryType(0L);
req.setValidationType(0L);
req.setSearchable(0L);
req.setChatBannedType(0L);
req.setManagementType(0L);
req.setTitle("测试群");
req.setOpenConversationId("131231");
req.setOnlyAdminCanDing(0L);
req.setAllMembersCanCreateMcsConf(0L);
req.setAllMembersCanCreateCalendar(0L);
req.setGroupEmailDisabled(0L);
req.setOnlyAdminCanSetMsgTop(0L);
req.setAddFriendForbidden(0L);
req.setGroupLiveSwitch(0L);
req.setMembersToAdminChat(0L);
req.setPluginCustomizeVerify(0L);
OapiImChatScenegroupUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/scenegroup/update");
OapiImChatScenegroupUpdateRequest req = new OapiImChatScenegroupUpdateRequest();
req.OwnerUserId = "123";
req.Icon = "@asdf12zcv";
req.MentionAllAuthority = 0L;
req.ShowHistoryType = 0L;
req.ValidationType = 0L;
req.Searchable = 0L;
req.ChatBannedType = 0L;
req.ManagementType = 0L;
req.Title = "测试群";
req.OpenConversationId = "131231";
req.OnlyAdminCanDing = 0L;
req.AllMembersCanCreateMcsConf = 0L;
req.AllMembersCanCreateCalendar = 0L;
req.GroupEmailDisabled = 0L;
req.OnlyAdminCanSetMsgTop = 0L;
req.AddFriendForbidden = 0L;
req.GroupLiveSwitch = 0L;
req.MembersToAdminChat = 0L;
req.PluginCustomizeVerify = 0L;
OapiImChatScenegroupUpdateResponse 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 OapiImChatScenegroupUpdateRequest;
$req->setOwnerUserId("123");
$req->setIcon("@asdf12zcv");
$req->setMentionAllAuthority("0");
$req->setShowHistoryType("0");
$req->setValidationType("0");
$req->setSearchable("0");
$req->setChatBannedType("0");
$req->setManagementType("0");
$req->setTitle("测试群");
$req->setOpenConversationId("131231");
$req->setOnlyAdminCanDing("0");
$req->setAllMembersCanCreateMcsConf("0");
$req->setAllMembersCanCreateCalendar("0");
$req->setGroupEmailDisabled("0");
$req->setOnlyAdminCanSetMsgTop("0");
$req->setAddFriendForbidden("0");
$req->setGroupLiveSwitch("0");
$req->setMembersToAdminChat("0");
$req->setPluginCustomizeVerify("0");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/im/chat/scenegroup/update");

curl -X POST "https://oapi.dingtalk.com/topapi/im/chat/scenegroup/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=7131c3b2-c913-471a-a337-e65ad089d6f9' \
-d 'add_friend_forbidden=0' \
-d 'all_members_can_create_calendar=0' \
-d 'all_members_can_create_mcs_conf=0' \
-d 'chat_banned_type=0' \
-d 'group_email_disabled=0' \
-d 'group_live_switch=0' \
-d 'icon=%40asdf12zcv' \
-d 'management_type=0' \
-d 'members_to_admin_chat=0' \
-d 'mention_all_authority=0' \
-d 'only_admin_can_ding=0' \
-d 'only_admin_can_set_msg_top=0' \
-d 'open_conversation_id=131231' \
-d 'owner_user_id=123' \
-d 'plugin_customize_verify=0' \
-d 'searchable=0' \
-d 'show_history_type=0' \
-d 'title=%E6%B5%8B%E8%AF%95%E7%BE%A4' \
-d 'validation_type=0'

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

req=dingtalk.api.OapiImChatScenegroupUpdateRequest("https://oapi.dingtalk.com/topapi/im/chat/scenegroup/update")

req.owner_user_id="123"
req.icon="@asdf12zcv"
req.mention_all_authority=0
req.show_history_type=0
req.validation_type=0
req.searchable=0
req.chat_banned_type=0
req.management_type=0
req.title="测试群"
req.open_conversation_id="131231"
req.only_admin_can_ding=0
req.all_members_can_create_mcs_conf=0
req.all_members_can_create_calendar=0
req.group_email_disabled=0
req.only_admin_can_set_msg_top=0
req.add_friend_forbidden=0
req.group_live_switch=0
req.members_to_admin_chat=0
req.plugin_customize_verify=0
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.im.chat.scenegroup.update");
add_param(pRequest,"owner_user_id","123");
add_param(pRequest,"icon","@asdf12zcv");
add_param(pRequest,"mention_all_authority","0");
add_param(pRequest,"show_history_type","0");
add_param(pRequest,"validation_type","0");
add_param(pRequest,"searchable","0");
add_param(pRequest,"chat_banned_type","0");
add_param(pRequest,"management_type","0");
add_param(pRequest,"title","测试群");
add_param(pRequest,"open_conversation_id","131231");
add_param(pRequest,"only_admin_can_ding","0");
add_param(pRequest,"all_members_can_create_mcs_conf","0");
add_param(pRequest,"all_members_can_create_calendar","0");
add_param(pRequest,"group_email_disabled","0");
add_param(pRequest,"only_admin_can_set_msg_top","0");
add_param(pRequest,"add_friend_forbidden","0");
add_param(pRequest,"group_live_switch","0");
add_param(pRequest,"members_to_admin_chat","0");
add_param(pRequest,"plugin_customize_verify","0");
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.im.chat.scenegroup.update', {
	'owner_user_id':'123',
	'icon':'@asdf12zcv',
	'mention_all_authority':'0',
	'show_history_type':'0',
	'validation_type':'0',
	'searchable':'0',
	'chat_banned_type':'0',
	'management_type':'0',
	'title':'测试群',
	'open_conversation_id':'131231',
	'only_admin_can_ding':'0',
	'all_members_can_create_mcs_conf':'0',
	'all_members_can_create_calendar':'0',
	'group_email_disabled':'0',
	'only_admin_can_set_msg_top':'0',
	'add_friend_forbidden':'0',
	'group_live_switch':'0',
	'members_to_admin_chat':'0',
	'plugin_customize_verify':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":,
    "errcode":1001,
    "errmsg":"systemerror"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.im.chat.scenegroup.update (场景群更新)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ