Querying Call Members

When you create or join a call you get a list of call members, however this can return at most 100 members:

// The maximum limit is 100
// The default limit is 25
await call.getOrCreate({ members_limit: 100 });

// or
await call.join({ members_limit: 100 });

To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.

Examples

Below are a few examples of how to use this API:

const result = await call.queryMembers();

// sorting and pagination
const queryMembersReq = {
  sort: [{ field: 'user_id', direction: 1 }],
  limit: 2,
};
const result = await call.queryMembers(queryMembersReq);

// loading the next page
const result = await call.queryMembers({
  ...queryMembersReq,
  next: result.next,
});

// filtering
const result = await call.queryMembers({
  filter_conditions: { role: { $eq: 'admin' } },
});

Sort options

Sorting is supported on these fields:

• user_id
• created_at

Filter options

The Stream API allows you to specify filters and ordering for several endpoints. The query syntax is similar to that of Mongoose, however we do not run MongoDB on the backend. Only a subset of the MongoDB operations are supported.

It’s also possible to combine filter expressions with the following operators: