Send System Message

Description

POST /admin/message/system

Sends a system message to a specific list of user IDs. These are typically non-conversational messages (e.g., notifications, status updates). Only the specified online recipients will receive the message in real-time. For now, the admin/message/system message can only be caught in the console.

Authorization

Header

{ Admin-Api-Key: {{ HTTP_ADMIN_API_KEY }} }

Request

Content-Type: application/json

Request

{
  "organizationId": "680a2fae96cc69d78861f101",
  "senderId": "63480e68f4794709f802a2fa",
  "messageSystem": {
    "id": "5а34p21m0xj23",
    "uids": ["63480e68f4794709f802a2fc", "63480e68f4794709f802a2fb"],
    "x": {
      "param1": "value",
      "param2": "value"
    }
  }
}

Request Parameters

Field	Type	Description
`organizationId`	`string`	OrganizationId performing request
`senderId`	`string`	User ID of the sender
`messageSystem.id`	`string`	Unique message ID received from the server
`messageSystem.uids`	`array[string]`	List of recipient user IDs (only online users will receive it)
`messageSystem.x`	`object`	Custom metadata parameters (optional), e.g. `{ "event_type": "X" }`

Successful Response

Response

{
  "ack": {
    "mid": "5а34p21m0xj23",
    "t": 15673838833
  }
}

Real-time Message

Event

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