List Conversation Participants

1.   / 
2. API   / 
3. Convarsation   / 
4. Participants List

---

Description

wss get_participants_by_cids

The get_participants_by_cids request returns a list of users upon request. The conversations field indicates which user is from which chat, which is useful if the user is part of several different chats.

Request Parameters

Name	Type	Description
cids	array[string]	Array of Conversation IDs

Response Fields

Name	Type	Description
users	array[object]	Array of User objects
conversations	object	Object of Conversation IDS with users belonging to them

Example

Request

{
  "request": {
    "get_participants_by_cids": {
      "cids": [
        "635a3b4cb15254ebe43e76ff",
        "63563a2ad745dc1c6ad01b5f",
        "63563a0cd745dc1c6ad01b5c"
      ]
    },
    "id": "RequestId"
  }
}

Response

{
  "response": {
    "id": "RequestId",
    "users": [
      {
        "_id": "634ec51c0b65918393dca5bf",
        "login": "carol18"
      },
      {
        "_id": "63480e68f4794709f802a2fa",
        "login": "breadpit"
      },
      ...
    ],
    "conversations": {
      "635a3b4cb15254ebe43e76ff": [
        "634ec51c0b65918393dca5bf",
        "63480e68f4794709f802a2fa"
      ],
      "63563a2ad745dc1c6ad01b5f": [
        "63480e68f4794709f802a2fa",
        "507f191e810c19729de860ea",
        "507f191e810c19729de880ee"
      ],
      ...
    }
  }
}

See Also

SAMA chat server API: Conversations When we developed our API, we followed three rules: fast, confidential, and scalable. Each of these rules has a powerful force when we choose which messenger you will use.

DataBase Records Collection of complete objects stored in the database.