将客户拉入群聊

POST

https://aa-hub.ddregion.com/api/v1/instantReply/addFromRoom

功能说明：

本接口可以指定托管账号将客户拉入已创建的指定群聊中

💡

1.使用userId进行添加群聊时，无法保证当前企业下该userId仅在一个微信组内托管了一次，如果以当前userId查到了不止一个托管账号，则会报错
2.群人数40人之前默认拉入群聊，40人以后发送入群卡片链接，需要客户点击确认
3.建议拉人进群时，每分钟不超过50次
4.拉内部员工的contactWxid格式为1688851234551057
5.拉外部客户的contactWxid格式为7881301234984100
6.内部员工contactWxid获取方式：请求【获取客户列表】接口并将coworker值传为true，对应内部员工的imContactId为内部员工contactWxid

请求参数

Query 参数

token

string

调用接口凭证

必需

Body 参数application/json

botUserId

string

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

必需

contactWxid

string

拉入客户的系统wxid

必需

来源于获取客户列表接口，contactWxid=imContactId，其中外部客户开头为788，内部用户开头为1688

roomWxid

string

拉入群聊的系统wxid

必需

示例

{
  "botUserId": "MaYunFei",
  "contactWxid": "168885***8551057",
  "roomWxid": "R:109023***1053644"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com/api/v1/instantReply/addFromRoom?token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "botUserId": "MaYunFei",
    "contactWxid": "168885***8551057",
    "roomWxid": "R:109023***1053644"
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

错误码说明 -1 企业控制台没有绑定企业控制台 -2 botUserId的bot不存在 -3 botUserId存在多个机器人 -4 不是企业微信 -5 bot不在线 -6 群聊加载失败 -7 拉入群聊失败 -8 和bot不是好友关系 -9 群聊中已经存在此好友 -10 群人数达到上限(500) -11 bot不在群内 -12 该群是内部群，不执行此操作

errmsg

string

对返回码的文本描述内容

必需

示例

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

修改于 2024-09-19 08:58:44

将客户移出群聊

群聊改名