API接口文档

新建入群欢迎语

POST

https://aa-hub.ddregion.com/api/v2/room/welcome/create

功能说明：

本接口可以创建指定群聊的入群欢迎语

欢迎语生效条件：延迟时间、群成员人员（满固定人数后）

请求参数

Query 参数

token

string

必需

Body 参数application/json

groupId

string

小组id

必需

welcomeMaterialIds

array[string]

欢迎语素材

必需

triggerCondition

object

触发条件

必需

delayTime

integer

延迟秒数

必需

userCount

integer

群成员条件

必需

当群满XXX人时触发

rooms

array [object {2}]

生效群聊

必需

botId

string

本系统托管账号id

可选

imRoomId

string

群聊id

可选

isAtContact

boolean

是否@ 用户

必需

示例

{
  "groupId": "string",
  "welcomeMaterialIds": [
    "string"
  ],
  "triggerCondition": {
    "delayTime": 0,
    "userCount": 0
  },
  "rooms": [
    {
      "botId": "string",
      "imRoomId": "string"
    }
  ],
  "isAtContact": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://aa-hub.ddregion.com/api/v2/room/welcome/create?token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupId": "string",
    "welcomeMaterialIds": [
        "string"
    ],
    "triggerCondition": {
        "delayTime": 0,
        "userCount": 0
    },
    "rooms": [
        {
            "botId": "string",
            "imRoomId": "string"
        }
    ],
    "isAtContact": true
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

1 无效token 2 无效参数 400800 未查到对应的id信息 500500 更新入群欢迎语异常

示例

{
  "errcode": 0
}

给托管账号打/删标签

查询入群欢迎语