调用ImportGroupChatMember导入群成员。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
AppId | String | 是 | apitest |
App ID。IMPaaS租户的ID。 |
RequestParams | Object | 是 |
导入群成员请求体。 |
|
AppCid | String | 是 | $2$123456 |
群聊会话ID。 |
GroupChatMembers | Array | 是 |
群成员列表。 |
|
AppUid | String | 是 | 123 |
用户ID。 |
Role | Long | 否 | 3 |
群成员角色。
|
Nick | String | 否 | bob |
群成员昵称。 |
Top | Boolean | 否 | false |
是否置顶。不填默认为false。 |
RedPoint | Long | 否 | 1 |
会话的未读消息数。不填默认为0。 |
Mute | Boolean | 否 | false |
是否免打扰。不填默认为false。 |
Visible | Boolean | 否 | true |
是否可见。不填默认为true。 |
JoinTime | Long | 否 | 1613700223555 |
入群时间。时间戳,单位:毫秒。不填默认为当前时间。 |
ModifyTime | Long | 否 | 1613700223555 |
最后修改时间。时间戳,单位:毫秒。 |
Extensions | Map | 否 |
扩展信息。 |
|
String | 否 | {"k1":"v1"} |
扩展信息内容。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | C02635EE-C867-4CC0-9DE0-E4497378F720 |
请求ID。 |
Code | String | General.SystemError |
错误码。 |
Message | String | System Error |
错误信息。 |
示例
请求示例
http(s)://live-interaction.aliyuncs.com/?AppId=apitest
&RequestParams={"AppCid":"$2$123456","GroupChatMembers":[{"AppUid":"123","Role":3,"Nick":"bob","Top":false,"RedPoint":1,"Mute":false,"Visible":true,"JoinTime":1613700223555,"ModifyTime":1613700223555,"Extensions":{"key":"{\"k1\":\"v1\"}"}}]}
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RequestId>C02635EE-C867-4CC0-9DE0-E4497378F720</RequestId>
<Code>General.SystemError</Code>
<Message>System Error</Message>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "C02635EE-C867-4CC0-9DE0-E4497378F720",
"Code" : "General.SystemError",
"Message" : "System Error"
}
错误码
访问错误中心查看更多错误码。