IM即时通讯

拉人入群

URL

https://sdk.cloudroom.com/im/v1/group/invite

请求方式:POST

请求参数

公共参数

接口参数

名称 类型 是否必传 说明
GroupID String 是 群ID
InvitedUserIDs String[] 是 被邀请的用户ID列表
Reason String 否 邀请入群说明,长度上限 150 位字符。

返回参数

名称 类型 说明
RspCode Int 响应码
RspDesc String 响应描述

示例

请求示例

curl -X POST https://sdk.cloudroom.com/im/v1/group/invite \
  -H "Content-Type: application/json" \
  -d '{
    "RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
    "CompID": "1111111",
    "SecretKey": "b7febff6a21c36fb50150f88c95ef641",
    "GroupID": "2355472856",
    "InvitedUserIDs": ["user_design_001", "user_ops_002"],
    "Reason": "邀请加入xx讨论群"
  }'

返回示例

{
    "RspCode": 0,
    "RspDesc": "请求成功"
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见 状态码