BROKER MESSAGES
This API retrieves broker messages, notifications, and announcements sent to the user. Results are returned in a paginated format.
🔗 Path Parameters
| Parameter | Type | Required | Description | Example |
|---|
| tenantid | string | Yes | Unique id provided for the tenant by SIPL | "tenant001" |
🔍 Query Parameters
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| pageNo | integer | No | Page number for pagination | 1 |
| pageSize | integer | No | Number of records per page | 10 |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description |
|---|
| status | boolean | Status of API call |
| result | array | List of broker messages |
📦 Broker Message Fields
| Field | Type | Description | Example |
|---|
| MsgSrNo | integer | Message serial number | 1001 |
| SendMsgTime | string | Date and time when the message was sent | "2026-06-25 10:30:00" |
| Subject | string | Subject of the message | "Trading Holiday Notification" |
| Message | string | Message content sent by the broker | "NSE and BSE will remain closed on..." |
| MsgType | integer | Message type identifier | 1 |