Skip to main content

Overview

After group membership changes on your application server, use this API to synchronize new members with the IM Server.

Request

Authentication: Add authentication headers to the request. See Authentication.

Method POST

Rate limit 100 requests/second

Endpoint https://API domain/apigateway/groups/members/add

Content-Type application/json

Request Parameters

ParameterData TypeRequiredDescription
group_idstringYesGroup ID. Maximum length: 64 characters.
group_namestringNoGroup name. Maximum length: 64 characters.
member_idsarrayYesIDs of the users joining the group. Each user ID can contain up to 32 characters.

Request Example

POST /apigateway/groups/members/add HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

{
"group_id":"groupid1",
"group_name":"group1",
"member_ids":["userid1","userid2"]
}

Response Example

{
"code":0,
"msg":"sucess"
}