Skip to content
POST{BASE_URL}/wx-api/api/room/getQrCode
只读JSON · Bearer App Token · body appid

获取群二维码

获取群的入群二维码(返回二维码图片 base64 + 群头像 url)。

说明与注意

  • 响应字段为 data.roomQrcode(群二维码 PNG 的 base64,非 url)/ data.imgUrl(群头像 url)/ data.roomId;渲染二维码用 data:image/png;base64,<roomQrcode>。

请求参数

参数必填类型说明
appidstring实例 appid,标识操作哪个已登录账号。示例:we_xxxxxxxxxxxxxxx
roomIdint64群 id,来自获取我的客户群列表响应里的 data.roomData.list[].roomId。示例:1970325823022815

请求示例

http
POST {BASE_URL}/wx-api/api/room/getQrCode
Authorization: Bearer <你的 App Token>
Content-Type: application/json

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 1970325823022815
}
bash
curl -X POST '{BASE_URL}/wx-api/api/room/getQrCode' \
  -H 'Authorization: Bearer <你的 App Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 1970325823022815
}'
python
import requests

url = "{BASE_URL}/wx-api/api/room/getQrCode"
headers = {"Authorization": "Bearer <你的 App Token>", "Content-Type": "application/json"}
body = """{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 1970325823022815
}"""

resp = requests.post(url, headers=headers, data=body.encode("utf-8"))
print(resp.text)
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String url = "{BASE_URL}/wx-api/api/room/getQrCode";
String body = "{\n" +
    "  \"appid\": \"we_xxxxxxxxxxxxxxx\",\n" +
    "  \"roomId\": 1970325823022815\n" +
    "}";

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create(url))
    .header("Authorization", "Bearer <你的 App Token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
php
<?php

$url = '{BASE_URL}/wx-api/api/room/getQrCode';
$body = <<<'JSON'
{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 1970325823022815
}
JSON;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer <你的 App Token>',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

响应示例

解析响应前确认字段

返回字段见本页「说明与注意」和群模块总览。完整响应格式及未列出的字段,请通过开通与支持联系对接人确认后再解析。

响应里 data.roomQrcode 是群二维码 PNG 图片的 base64(不是 url),data.imgUrl 是群头像 url,另有 data.roomId;渲染二维码时加 data:image/png;base64, 前缀。

响应字段

字段类型说明
codeint64统一封套状态码:0=成功,负数=失败
dataobject群二维码数据,含 roomQrcode(PNG 图片 base64)、imgUrlroomId
detailstring附加明细,通常为空
messagestring文案:成功为 ok;失败形如 -码|描述
timestring服务端处理时间 YYYY-MM-DD HH:MM:SS

常见错误

下表为企微错误码。业务失败时顶层 code=-1,具体错误码在 message| 前,例如 -3004|参数错误;鉴权与网关错误见错误码

错误码含义怎么办
-18000059群二维码已停用(群开启了进群验证)提示用户,无法直接取码

下一步