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

dingtalk.oapi.im.chat.scenegroup.get (查询场景群基本信息)

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
open_conversation_id	String	必须	123123		群id

响应参数

名称	类型	示例值	描述
result	DecorationGroupQueryResponse		返回结果
└ icon String @asdas213 群头像 management_options ManagementOptions 群配置 └ chat_banned_type String 0 群禁言，0-默认，不禁言，1-全员禁言 └ searchable String 0 群可搜索，0-默认，不可搜索，1-可搜索 └ validation_type String 0 入群验证，0：不入群验证（默认） 1：入群验证 └ mention_all_authority String 0 @all 权限，0-默认，所有人，1-仅群主可@all └ management_type String 0 管理类型，0-默认，所有人可管理，1-仅群主可管理 └ show_history_type String 0 新成员是否可查看聊天历史消息，0-默认，否，1-是 └ title String 测试群群标题 └ template_id String template231 模板id └ open_conversation_id String 123 群id └ sub_admin_staff_ids String [] 123,321 群管理id └ owner_staff_id String 123 群主id └ member_amount Number 10 群成员数量 └ scene_data String 场景化数据，在特定场景群有数据
success	Boolean	true	是否成功
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/get");
OapiImChatScenegroupGetRequest req = new OapiImChatScenegroupGetRequest();
req.setOpenConversationId("123123");
OapiImChatScenegroupGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/scenegroup/get");
OapiImChatScenegroupGetRequest req = new OapiImChatScenegroupGetRequest();
req.OpenConversationId = "123123";
OapiImChatScenegroupGetResponse 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 OapiImChatScenegroupGetRequest;
$req->setOpenConversationId("123123");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/im/chat/scenegroup/get");

curl -X POST "https://oapi.dingtalk.com/topapi/im/chat/scenegroup/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=10029dc8-fdc8-43c5-9387-a96c1c416814' \
-d 'open_conversation_id=123123'

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

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

req.open_conversation_id="123123"
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.get");
add_param(pRequest,"open_conversation_id","123123");
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.get', {
	'open_conversation_id':'123123'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "icon":"@asdas213",
        "management_options":{
            "chat_banned_type":"0",
            "searchable":"0",
            "validation_type":"0",
            "mention_all_authority":"0",
            "management_type":"0",
            "show_history_type":"0"
        },
        "title":"测试群",
        "template_id":"template231",
        "open_conversation_id":"123",
        "sub_admin_staff_ids":{
            "string":[
                "123",
                "321"
            ]
        },
        "owner_staff_id":"123",
        "member_amount":10,
        "scene_data":""
    },
    "success":true,
    "errcode":1001,
    "errmsg":"systemerror"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.im.chat.scenegroup.get (查询场景群基本信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ