调用AddGroupMembers将指定用户列表加入到群里。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
AppId String apitest

App ID。IMPaaS租户的ID。

RequestParams Object

添加群成员请求体。

OperatorAppUid String 112233

操作用户ID。

AppCid String $2$111000****

群聊会话ID。

InitMembers Array

加入群的用户列表。

AppUid String 888666

被加入群的用户ID。

Role Integer 3

成员角色。取值:

  • 1:群主。
  • 2:管理员。
  • 3:普通。
  • 100~127:自定义。

默认值为3

Nick String test

群成员昵称。

JoinTime Long 1608739200000

群成员加入时间。时间戳,单位:毫秒。可不填,默认为当前时间。

Extensions Map

群成员扩展字段。

String {"k1":"v1"}

扩展信息。

返回数据

名称 类型 示例值 描述
RequestId String C02635EE-C867-4CC0-9DE0-E4497378F720

请求ID。

Code String Group.xxx

错误码。

Message String Parameter Error

错误信息。

示例

请求示例

http(s)://live-interaction.aliyuncs.com/?AppId=apitest
&RequestParams={"OperatorAppUid":"112233","AppCid":"$2$111000****","InitMembers":[{"AppUid":"888666","Role":3,"Nick":"test","JoinTime":1608739200000,"Extensions":{"key":"{\"k1\":\"v1\"}"}}]}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>C02635EE-C867-4CC0-9DE0-E4497378F720</RequestId>
<Code>Group.xxx</Code>
<Message>Parameter Error</Message>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C02635EE-C867-4CC0-9DE0-E4497378F720",
  "Code" : "Group.xxx",
  "Message" : "Parameter Error"
}

错误码

访问错误中心查看更多错误码。