API接口文档

将客户移出群聊

POST

/api/v1/instantReply/removeFromRoom

功能说明：

本接口可以指定托管账号移出指定群聊中的具体群成员。

💡

使用userId进行移出群聊时，无法保证当前企业下该userId仅在一个微信组内托管了一次，如果以当前userId查到了不止一个托管账号，则会报错

请求参数

Query 参数

token

string

调用接口凭证

必需

Body 参数application/json

botUserId

string

执行托管账号的企业微信userId

必需

contactWxid

string

被移出的群成员的系统ID

必需

存在好友关系：新-获取客户列表中的imContactId字段
非好友关系：从获取群聊列表接口中获取该成员对应的imContactid

roomWxid

string

移出的群的系统wxid

必需

来源于接口：企业微信群chatid转系统群roomwxid中的返回参数或在系统界面的可以找到

示例

{
  "botUserId": "string",
  "contactWxid": "string",
  "roomWxid": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/instantReply/removeFromRoom?token=' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

错误码说明 -2 botUserId的bot不存在 -3 botUserId存在多个机器人 -4 不是企业微信 -5 bot不在线 -6 群聊加载失败 -7 群聊中没有移除对象

errmsg

string

对返回码的文本描述内容

必需

示例

{
  "errcode": 0,
  "errmsg": "string"
}

修改于 2024-10-09 06:05:54

创建群聊

将客户拉入群聊