Skip to main content

Get a Chat Room

https://api.deadsimplechat.com/consumer/api/v1/chatroom/:roomId

Get A Chat Room​

This endpoint allows you to get the details about a single chat room

info

The auth query parameter is your private key. You can find it in your Dashboard under Developer -> Private Key.

Parameters
Path
roomIdstringroomId of the chat room you want to fetch
Query
authstringGo to Dashboard -> Developer -> Private Key is your auth.

Responses​

200

JSON

{
    "passwordProtected": false,
    "enableOneToOneChat": false,
    "moderatorOnlyOneToOneChat": false,
    "enableChannels": false,
    "showNotificationForAllChannels": false,
    "enableLikeMessage": false,
    "defaultNotificationEnabled": false,
    "roomId": "x8z343Tlt",
    "name": "Demo Chat Room",
    "preModeratedChatRoom": false,
    "roomPassword": null,
    "description": "cool room",
    "metadata": "{ 'a': 'b' }"
}

404

JSON

{}