Skip to main content

BROKER MESSAGES

This API retrieves broker messages, notifications, and announcements sent to the user. Results are returned in a paginated format.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
pageNointegerNoPage number for pagination1
pageSizeintegerNoNumber of records per page10

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescription
statusbooleanStatus of API call
resultarrayList of broker messages

📦 Broker Message Fields

FieldTypeDescriptionExample
MsgSrNointegerMessage serial number1001
SendMsgTimestringDate and time when the message was sent"2026-06-25 10:30:00"
SubjectstringSubject of the message"Trading Holiday Notification"
MessagestringMessage content sent by the broker"NSE and BSE will remain closed on..."
MsgTypeintegerMessage type identifier1