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

获取我的客户群列表

分页拉取本号名下的客户群列表(获取 roomId 的主入口)。

请求参数

参数必填类型说明
appidstring实例 appid,标识操作哪个已登录账号。示例:we_xxxxxxxxxxxxxxx
limitint64最多返回条数。示例:2000

请求示例

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

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

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

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/getMyCustomerGroupList";
String body = "{\n" +
    "  \"appid\": \"we_xxxxxxxxxxxxxxx\",\n" +
    "  \"limit\": 2000\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/getMyCustomerGroupList';
$body = <<<'JSON'
{
  "appid": "we_xxxxxxxxxxxxxxx",
  "limit": 2000
}
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;

响应示例

解析响应前确认字段

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

群 id 在 data.roomData.list[].roomId;列表项里更长的 id 是客户群记录 id,不是 roomId,做群操作一律用 roomId

响应字段

字段类型说明
codeint64统一封套状态码:0=成功,负数=失败
detailstring附加明细,通常为空
messagestring文案:成功为 ok;失败形如 -码|描述
timestring服务端处理时间 YYYY-MM-DD HH:MM:SS

下一步