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

dingtalk.oapi.chat.create (创建群会话)

创建群会话

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
name	String	可选	群名称		群名称
owner	String	可选	onwerUserId		群主的userId
useridlist	String []	可选	["userid1","userid2"]	最大列表长度：20	群成员userId列表
ownerType	String	可选	emp		群主类型，emp：企业员工，ext：外部联系人
conversationTag	Number	可选	2		群类型，2：企业群，0：普通群
showHistoryType	Number	可选	1		新成员可查看100条聊天历史消息的类型，1：可查看，默认或0：不可查看
extidlist	String []	可选	["extuserid1","extuserid2"]	最大列表长度：20	外部联系人成员列表
searchable	Number	可选	0		群可搜索，0-默认，不可搜索，1-可搜索
validationType	Number	可选	0		入群验证，0：不入群验证（默认） 1：入群验证
mentionAllAuthority	Number	可选	0		@all 权限，0-默认，所有人，1-仅群主可@all
managementType	Number	可选	0		管理类型，0-默认，所有人可管理，1-仅群主可管理
chatBannedType	Number	可选	0		群禁言，0-默认，不禁言，1-全员禁言
icon	String	可选	@pic		群头像资源id

响应参数

名称	类型	示例值	描述
conversationTag	Number		conversationTag
openConversationId	String		openConversationId
chatid	String	chatid1	chatid
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/create");
OapiChatCreateRequest req = new OapiChatCreateRequest();
req.setName("群名称");
req.setOwner("onwerUserId");
req.setUseridlist(""userid1","userid2"");
req.setOwnerType("emp");
req.setConversationTag(2L);
req.setShowHistoryType(1L);
req.setExtidlist(""extuserid1","extuserid2"");
req.setSearchable(0L);
req.setValidationType(0L);
req.setMentionAllAuthority(0L);
req.setManagementType(0L);
req.setChatBannedType(0L);
req.setIcon("@pic");
OapiChatCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/create");
OapiChatCreateRequest req = new OapiChatCreateRequest();
req.Name = "群名称";
req.Owner = "onwerUserId";
req.Useridlist = ""userid1","userid2"";
req.OwnerType = "emp";
req.ConversationTag = 2L;
req.ShowHistoryType = 1L;
req.Extidlist = ""extuserid1","extuserid2"";
req.Searchable = 0L;
req.ValidationType = 0L;
req.MentionAllAuthority = 0L;
req.ManagementType = 0L;
req.ChatBannedType = 0L;
req.Icon = "@pic";
OapiChatCreateResponse 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 OapiChatCreateRequest;
$req->setName("群名称");
$req->setOwner("onwerUserId");
$req->setUseridlist("[\"userid1\",\"userid2\"]");
$req->setOwnerType("emp");
$req->setConversationTag("2");
$req->setShowHistoryType("1");
$req->setExtidlist("[\"extuserid1\",\"extuserid2\"]");
$req->setSearchable("0");
$req->setValidationType("0");
$req->setMentionAllAuthority("0");
$req->setManagementType("0");
$req->setChatBannedType("0");
$req->setIcon("@pic");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/chat/create");

curl -X POST "https://oapi.dingtalk.com/chat/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=4bdefd71-2097-4757-99bc-054a811023f0' \
-d 'chatBannedType=0' \
-d 'conversationTag=2' \
-d 'extidlist=%22extuserid1%22%2C%22extuserid2%22' \
-d 'icon=%40pic' \
-d 'managementType=0' \
-d 'mentionAllAuthority=0' \
-d 'name=%E7%BE%A4%E5%90%8D%E7%A7%B0' \
-d 'owner=onwerUserId' \
-d 'ownerType=emp' \
-d 'searchable=0' \
-d 'showHistoryType=1' \
-d 'useridlist=%22userid1%22%2C%22userid2%22' \
-d 'validationType=0'

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

req=dingtalk.api.OapiChatCreateRequest("https://oapi.dingtalk.com/chat/create")

req.name="群名称"
req.owner="onwerUserId"
req.useridlist="["userid1","userid2"]"
req.ownerType="emp"
req.conversationTag=2
req.showHistoryType=1
req.extidlist="["extuserid1","extuserid2"]"
req.searchable=0
req.validationType=0
req.mentionAllAuthority=0
req.managementType=0
req.chatBannedType=0
req.icon="@pic"
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.create");
add_param(pRequest,"name","群名称");
add_param(pRequest,"owner","onwerUserId");
add_param(pRequest,"useridlist",""userid1","userid2"");
add_param(pRequest,"ownerType","emp");
add_param(pRequest,"conversationTag","2");
add_param(pRequest,"showHistoryType","1");
add_param(pRequest,"extidlist",""extuserid1","extuserid2"");
add_param(pRequest,"searchable","0");
add_param(pRequest,"validationType","0");
add_param(pRequest,"mentionAllAuthority","0");
add_param(pRequest,"managementType","0");
add_param(pRequest,"chatBannedType","0");
add_param(pRequest,"icon","@pic");
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.create', {
	'name':'群名称',
	'owner':'onwerUserId',
	'useridlist':'"userid1","userid2"',
	'ownerType':'emp',
	'conversationTag':'2',
	'showHistoryType':'1',
	'extidlist':'"extuserid1","extuserid2"',
	'searchable':'0',
	'validationType':'0',
	'mentionAllAuthority':'0',
	'managementType':'0',
	'chatBannedType':'0',
	'icon':'@pic'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "conversationTag":,
    "openConversationId":"",
    "chatid":"chatid1",
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.chat.create (创建群会话)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ