API Explorer 936 endpoints

Get System Chat Messages

GET /obp/v7.0.0/chat-rooms/CHAT_ROOM_ID/messages

OBPv6.0.0-getSystemChatMessages No role required Chat

Get messages in a system-level chat room.

https://obp-api-sandbox.nmbbank.co.tz/obp/chat-rooms/CHAT_ROOM_ID/messages?limit=50&offset=0&from_date=1100-01-01T01:01:01.000Z&to_date=1100-01-01T01:01:01.000Z

The current user must be a participant.

Authentication is Required

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

CHAT_ROOM_ID: CHAT_ROOM_ID

JSON response body fields (20)
chat_message_id
chat_message_id
chat_room_id
chat_room_id
content
content
count
created_at
created_at
emoji
emoji
is_deleted
is_deleted
mentioned_user_ids
mentioned_user_ids
message_type
message_type
messages
reactions
reactions
reply_to_message_id
reply_to_message_id
sender_consumer_id
sender_consumer_id
sender_consumer_name
sender_consumer_name
sender_provider
sender_provider
sender_user_id
sender_user_id
sender_username
sender_username
thread_id
thread_id
updated_at
updated_at
user_ids
user_ids
Example success response
{
  "messages": [
    {
      "chat_message_id": "msg-id-123",
      "chat_room_id": "chat-room-id-123",
      "sender_user_id": "user-id-123",
      "sender_consumer_id": "",
      "sender_username": "robert.x.0.gh",
      "sender_provider": "https://github.com",
      "sender_consumer_name": "My Banking App",
      "content": "Hello everyone!",
      "message_type": "text",
      "mentioned_user_ids": [],
      "reply_to_message_id": "",
      "thread_id": "",
      "is_deleted": false,
      "created_at": "2026-10-21T01:45:41Z",
      "updated_at": "2026-10-21T01:45:41Z",
      "reactions": [
        {
          "emoji": "thumbsup",
          "count": 2,
          "user_ids": [
            "user-1",
            "user-2"
          ]
        }
      ]
    }
  ]
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-39001: Chat Room not found. Please specify a valid value for CHAT_ROOM_ID.
  • OBP-39004: Current user is not a participant of this Chat Room.
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 getSystemChatMessages Originally /obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages