Send System Message

1.   / 
2. API   / 
3. Message   / 
4. System Message

---

Description

wss system_message

Provides the ability to send system messages to users or conversations.

Request Parameters

Name	Type	Description
id	string	Identifier of the message
uids	array[string]	IDs of users to whom messages were sent
cid	string	Conversation ID in which the message was sent
x	object	Optional extra parameters for the message

Important

Required: either uids or cid

Examples

Request (uids)

{
  "system_message": {
    "id": "5а34p21m0xj23",
    "uids": ["63480e68f4794709f802a2fc", "63480e68f4794709f802a2fb"],
    "x": {
      "param1": "value",
      "param2": "value"
    }
  }
}

Request (cid)

{
  "system_message": {
    "id": "5а34p21m0xj24",
    "cid": "63077ad836b78c3d82af0812",
    "x": {
      "param1": "value",
      "param2": "value"
    }
  }
}

All conversation’s participants or all recipients from uids who is online will receive the following message in real-time:

Event (uids)

{
  "system_message": {
    "_id": "5а34p21m0xj23",
    "t": 15673838833,
    "from": "634ec51c0b65918393dca5bf",
    "x": {
      "param1": "value",
      "param2": "value"
    }
  }
}

Event (cid)

{
  "system_message": {
    "_id": "5а34p21m0xj24",
    "t": 15673838833,
    "cid": "63077ad836b78c3d82af0812",
    "from": "634ec51c0b65918393dca5bf",
    "x": {
      "param1": "value",
      "param2": "value"
    },
  }
}