请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/chat/qrcode/get |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 |
| 权限要求 | permission-qyapi_chat_base_read-钉钉群管理基础信息读权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | 30c36943eaxxxx | 调用该接口的应用凭证,通过获取企业内部应用的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| chatid | String | 是 | chat3234dfs423a | 群会话的chatid,可调用创建群接口获取chatid参数值。 |
| userid | String | 是 | manager4220 | 分享二维码用户的userId。 |
请求示例
curl -X POST "https://api.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'
DingTalkClient client = new DefaultDingTalkClient("https://api.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());
import dingtalk.api
req=dingtalk.api.OapiChatQrcodeGetRequest("https://api.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)
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://api.dingtalk.io/topapi/chat/qrcode/get");
IDingTalkClient client = new DefaultDingTalkClient("https://api.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);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| result | String | https://test/action/join?1233 | 返回入群的链接。 |
| success | Boolean | true | 是否调用成功。 - true:成功 - false:失败 |
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| request_id | String | 2tgtcjyjhptd | 请求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 | 系统错误 | 请稍后再试 |