Remove Members
POST api/v1/channel/members/remove
Note: This is to remove certain members from a group chat. Only the Admin of the group has access.
Header
Field | Type | Remarks |
---|---|---|
ApiKey | String | ApiKey acquired from the admin |
Authorization | String | Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is returned by /api/v1/auth |
Request Parameters
Field | Type | Remarks |
---|---|---|
channelUuid | String | the uuid of the group chat |
members | Array[String] | The relationId of members being removed |
Request Example
Response Parameters
Field | Type | Remarks |
---|---|---|
code | String | the Return Code |
desc | String | the Return Message |
data | Object | the Return Data |
Response Body
Return Code
code | desc | Remarks |
---|---|---|
0 | success | the flag for a successful request |
13107 | Not the admin of this channel | Not the admin of this group chat. |
Last updated