Skip to content
This repository has been archived by the owner on Jun 27, 2024. It is now read-only.

Commit

Permalink
GITBOOK-1285: Rooms endpoints update
Browse files Browse the repository at this point in the history
  • Loading branch information
rachana-visavadiya authored and gitbook-bot committed Apr 23, 2024
1 parent 37ef9be commit 6187067
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Permission required: `view-room-administration`

## Query Parameters

This endpoint supports the[#pagination](../../../#pagination "mention") parameters. Additional parameters are as follows:
This endpoint supports the [#pagination](../../../#pagination "mention") parameters. Additional parameters are as follows:

<table><thead><tr><th width="198.33333333333331">Key</th><th width="194">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>types</code></td><td><code>c</code></td><td><p>The room types. The possible room types are:</p><ul><li><code>d</code>: Direct chat</li><li><code>c</code>: Chat</li><li><code>p</code>: Private chat</li><li><code>l</code>: Livechat</li></ul></td></tr><tr><td><code>filter</code></td><td><code>general</code></td><td>The rooms's name.</td></tr></tbody></table>
<table><thead><tr><th width="179.33333333333331">Key</th><th width="194">Example Value</th><th>Description</th></tr></thead><tbody><tr><td><code>types</code></td><td><code>c</code></td><td><p>The room types. The possible room types are:</p><ul><li><code>d</code>: Direct messages</li><li><code>c</code>: Public channel</li><li><code>p</code>: Private channel</li><li><code>discussions</code>: Team or channel discussions</li><li><code>teams</code>: Workspace teams</li><li><code>l</code>: Livechat</li><li><code>v</code>: Omnichannel VoIP rooms</li></ul></td></tr><tr><td><code>filter</code></td><td><code>general</code></td><td>The rooms's name.</td></tr></tbody></table>

## Example Call

Expand Down
9 changes: 6 additions & 3 deletions reference/api/schema-definition/room.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,13 @@ The Room object has these fields

### Room Types

* `d`: Direct chat
* `c`: Chat
* `p`: Private chat
* `d`: Direct messages
* `c`: Public channel
* `p`: Private channel
* `discussions`: Team or channel discussions
* `teams`: Workspace teams
* `l`: Livechat
* `v`: Omnichannel VoIP rooms

The information that comes with the room object changes according to its type.

Expand Down

0 comments on commit 6187067

Please sign in to comment.