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

dingtalk.oapi.chat.get (获取群会话)

获取群会话

公共参数

环境	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	可选	chatid		群会话的id

响应参数

名称	类型	示例值	描述
errcode	Number	0	errcode
errmsg	String	ok	errmsg
chat_info	ChatInfo		chat_info
└ name String name └ owner String owner └ useridlist String [] useridlist └ extidlist String [] extidlist └ agentidlist String [] agentidlist └ conversationTag Number conversationTag └ chatBannedType Number 0 是否全员禁用 0 不禁言 1 全员禁言 └ searchable Number 0 是否可以搜索群名 0 不可以 1可以搜索 └ validationType Number 0 入群需群主或群管理员同意 0不需要 1需要 └ mentionAllAuthority Number 0 尽群主和管理员可@所有人 0 否 1 是 └ managementType Number 0 仅群主和群管理员可管理 0否 1 是 └ showHistoryType Number 0 新成员可查看聊天历史 0否 1是 └ icon String @pic 群头像mediaId └ status Number 1 群状态 1-正常 2-已解散

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/get");
OapiChatGetRequest req = new OapiChatGetRequest();
req.setChatid("chatid");
req.setHttpMethod("GET");
OapiChatGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/chat/get");
OapiChatGetRequest req = new OapiChatGetRequest();
req.Chatid = "chatid";
req.SetHttpMethod("GET");
OapiChatGetResponse 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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiChatGetRequest;
$req->setChatid("chatid");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/chat/get");

curl -X GET "https://oapi.dingtalk.com/chat/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=32868fc2-73d7-4d8c-85b1-fe6b5eda4ce2' \
-d 'chatid=chatid'

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

req=dingtalk.api.OapiChatGetRequest("https://oapi.dingtalk.com/chat/get")

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

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"ok",
    "chat_info":{
        "name":"",
        "owner":"",
        "useridlist":{
            "string":[
                ""
            ]
        },
        "extidlist":{
            "string":[
                ""
            ]
        },
        "agentidlist":{
            "string":[
                ""
            ]
        },
        "conversationTag":,
        "chatBannedType":0,
        "searchable":0,
        "validationType":0,
        "mentionAllAuthority":0,
        "managementType":0,
        "showHistoryType":0,
        "icon":"@pic",
        "status":1
    }
}

异常示例

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.get (获取群会话)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈