Register
API Explorer 935 endpoints
https://obp-api-sandbox.nmbbank.co.tz

Search Chat Rooms

POST /obp/v7.0.0/chat-rooms/search

OBPv6.0.0-searchChatRooms No role required Chat

Search chat rooms the current user is a participant of, filtered by the supplied criteria.

Currently supports filtering by participant set:

  • with_user_ids (array of user_id strings, required): only return rooms where the current user AND every listed user_id are participants. Pass an empty list to match all of the current user's rooms.
  • exact_participants (boolean, optional, default false): if true, the room's participant set must equal exactly {current user} ∪ with_user_ids with no extras. Open rooms are excluded from exact-participant searches because their participant set is implicitly "everyone".

Primary use case: a client looking up an existing 1-on-1 direct-message room before creating one, by calling with with_user_ids: [<other user_id>] and exact_participants: true.

The response shape is the same as Get My Chat Rooms.

Authentication is Required

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

JSON request body fields (2)
with_user_ids
with_user_ids
exact_participants
exact_participants
JSON response body fields (18)
bank_id
gh.29.uk
chat_room_id
chat_room_id
chat_rooms
chat_rooms
created_at
created_at
created_by_provider
created_by_provider
created_by_user_id
created_by_username
created_by_username
description
Description of the object. Maximum length is 2000. It can be any characters here.
is_archived
is_archived
is_open_room
is_open_room
joining_key
joining_key
name
ACCOUNT_MANAGEMENT_FEE
participant_count
participant_count
updated_at
updated_at
last_message_at
last_message_at
last_message_preview
last_message_preview
last_message_sender_username
last_message_sender_username
unread_count
unread_count
Example request body 
{
  "with_user_ids": [
    "user-id-123"
  ],
  "exact_participants": true
}
Example success response 
{
  "chat_rooms": [
    {
      "chat_room_id": "chat-room-id-123",
      "bank_id": "",
      "name": "DM with robert.x.0.gh",
      "description": "",
      "joining_key": "abc123key",
      "created_by_user_id": "user-id-456",
      "created_by_username": "alice",
      "created_by_provider": "https://github.com",
      "is_open_room": false,
      "is_archived": false,
      "last_message_at": "2026-10-21T01:45:41Z",
      "last_message_preview": "Hello!",
      "last_message_sender_username": "alice",
      "unread_count": 0,
      "created_at": "2026-10-21T01:45:41Z",
      "updated_at": "2026-10-21T01:45:41Z",
      "participant_count": 0
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv6.0.0 searchChatRooms Originally /obp/v6.0.0/chat-rooms/search