跳转到主要内容
调用本接口,获取群入群二维码邀请链接,适用于企业需要快速邀请成员加入群聊的场景,如组织活动、项目协作等。

请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/topapi/chat/qrcode/get
HTTP MethodPOST
支持的应用类型appType-企业内部应用
权限要求permission-qyapi_chat_base_read-钉钉群管理基础信息读权限

查询参数

名称类型是否必填示例值描述
access_tokenString30c36943eaxxxx调用该接口的应用凭证,通过获取企业内部应用的access_token接口获取。

请求体

名称类型是否必填示例值描述
chatidStringchat3234dfs423a群会话的chatid,可调用创建群接口获取chatid参数值。
useridStringmanager4220分享二维码用户的userId。

请求示例

curl -X POST "https://oapi.dingtalk.io/topapi/chat/qrcode/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a1582fxxxx790254a' \
-d 'chatid=chat3234dfs423a' \
-d 'userid=314137418341347'
Java
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/chat/qrcode/get");
OapiChatQrcodeGetRequest req = new OapiChatQrcodeGetRequest();
req.setChatid("chat3234dfs423a");
req.setUserid("manager4220");
OapiChatQrcodeGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python
import dingtalk.api

req=dingtalk.api.OapiChatQrcodeGetRequest("https://oapi.dingtalk.io/topapi/chat/qrcode/get")

req.chatid="chat3234dfs423a"
req.userid="314137418341347"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
PHP
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiChatQrcodeGetRequest;
$req->setChatid("chat3234dfs423a");
$req->setUserid("314137418341347");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/topapi/chat/qrcode/get");
C#
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/topapi/chat/qrcode/get");
OapiChatQrcodeGetRequest req = new OapiChatQrcodeGetRequest();
req.Chatid = "chat3234dfs423a";
req.Userid = "314137418341347";
OapiChatQrcodeGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

响应

响应体

名称类型示例值描述
resultStringhttps://test/action/join?1233返回入群的链接。
successBooleantrue是否调用成功。 - true:成功 - false:失败
errcodeNumber0返回码。
errmsgStringok返回码描述。
request_idString2tgtcjyjhptd请求ID。

响应体示例

{
  "errcode": 0,
  "errmsg": "ok",
  "result": "https://qr.dingtalk.io/action/joingroup?code=v1=&_dt_no_comment=1&origin=11",
  "success": true,
  "request_id": "4jzlii1im1ui"
}

错误码

若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。
错误码(errorcode)错误码描述(errmsg)解决方案
34001无效的会话id请检查chatId是否正确
40003不合法的userid请确认userid是否正确
60124用户不在此群中请确认userid是否正确
400001系统错误请稍后再试