Skip to content
POST{BASE_URL}/wx-api/api/room/addMember
写操作JSON · Bearer App Token · body appid

添加群成员

邀请一个或多个用户进群(拉人入群)。

请求参数

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

请求示例

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

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

url = "{BASE_URL}/wx-api/api/room/addMember"
headers = {"Authorization": "Bearer <你的 App Token>", "Content-Type": "application/json"}
body = """{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 10786447466811918,
  "userIdList": [
    1688855319807969
  ]
}"""

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/addMember";
String body = "{\n" +
    "  \"appid\": \"we_xxxxxxxxxxxxxxx\",\n" +
    "  \"roomId\": 10786447466811918,\n" +
    "  \"userIdList\": [\n" +
    "    1688855319807969\n" +
    "  ]\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/addMember';
$body = <<<'JSON'
{
  "appid": "we_xxxxxxxxxxxxxxx",
  "roomId": 10786447466811918,
  "userIdList": [
    1688855319807969
  ]
}
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;

响应示例

成功只返回响应封套

判断成功只看 code0,没有 data 字段。

响应字段

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

下一步