API接口文档

更新入群欢迎语

POST

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

功能说明：

本接口可以实现更新入群

请求参数

Query 参数

token

string

必需

Body 参数application/json

string

必需

welcomeMaterialIds

array[string]

必需

triggerCondition

object

必需

delayTime

integer

必需

userCount

integer

必需

status

boolean

必需

rooms

array [object {2}]

必需

botId

string

可选

imRoomId

string

可选

isAtContact

boolean

必需

示例

{
  "id": "111111",
  "welcomeMaterialIds": [
    "1111",
    "22222"
  ],
  "triggerCondition": {
    "delayTime": 7,
    "userCount": 12
  },
  "status": true,
  "rooms": [
    {
      "botId": "1111",
      "imRoomId": "2222"
    }
  ],
  "isAtContact": false
}

示例代码

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/update?token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "111111",
    "welcomeMaterialIds": [
        "1111",
        "22222"
    ],
    "triggerCondition": {
        "delayTime": 7,
        "userCount": 12
    },
    "status": true,
    "rooms": [
        {
            "botId": "1111",
            "imRoomId": "2222"
        }
    ],
    "isAtContact": false
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

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

errmsg

string

必需

string

欢迎语id

必需

welcomeMaterialIds

array[string]

欢迎语素材

必需

triggerCondition

object

触发条件

必需

delayTime

string

延迟xx秒

必需

userCount

string

满xx人

必需

status

boolean

状态

必需

rooms

array [object {2}]

生效群聊

必需

botId

string

托管账号id

必需

imRoomId

string

群聊id

必需

isAtContact

boolean

是否艾特用户

必需

示例

{
  "errcode": 0,
  "errmsg": "string",
  "id": "string",
  "welcomeMaterialIds": [
    "string"
  ],
  "triggerCondition": {
    "delayTime": "string",
    "userCount": "string"
  },
  "status": true,
  "rooms": [
    {
      "botId": "string",
      "imRoomId": "string"
    }
  ],
  "isAtContact": true
}

查询入群欢迎语

创建群聊