API接口文档

拉入群聊黑名单

POST

https://aa-hub.ddregion.com/api/v2/groupChat/black/add

功能说明：

本接口支持将指定用户拉群聊黑名单中
通过remove参数控制是否在拉黑的同时将对象批量移除企业内所有托管账号是群主的群
true为移出
false为不移出

请求参数

Query 参数

token

string

必需

Body 参数application/json

imContactId

string

要拉入黑名单的客户id

必需

来源于获取客户列表接口

remove

boolean

是否要将客户批量移除所在所有群聊

必需

true或false

imBotId

string

本系统托管账号对应成员ID

必需

示例

{
  "imContactId": "string",
  "remove": true,
  "imBotId": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com/api/v2/groupChat/black/add?token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "imContactId": "string",
    "remove": true,
    "imBotId": "string"
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

1 无效token 2 无效参数 400100 未找到对应的bot 400200 未找到对应的联系人 400405 添加黑名单失败

errmsg

string

可选

示例

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

退出群聊接口

移出群聊黑名单