Overview​

Queries the group member list for comparison with the data on your application server. Your application server is the source of truth. Synchronize changes to the IM Server promptly.

Request​

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

Method GET

Rate limit 100 requests/second

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

Content-Type application/json

Request Parameters​

Request Example​

GET /apigateway/groups/members/query?group_id=group1&limit=50&offset=aabb HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

Response Example​

{
  "code":0,
  "msg":"sucess",
  "data":{
    "items":[
      {
        "member_id":"member1",
        "is_mute":0,
        "is_allow":0,
        "grp_display_name":"group display name",
        "ext_fields":{
          "k1":"v1",
          "k2":"v2"
        }
      },
      {
        "member_id":"member2",
        "is_mute":0,
        "is_allow":0
      }
    ],
    "offset":"aabbcc"
  }
}