GET Chat
List Rooms
Rooms can be public or private.
This method requires authentication.
Rooms can be public or private. This method lists all public rooms that everyone can see.
cursor : (optional) The first time you call list rooms, omit this property to start from the beginning. Call the method again passing in the value returned in the cursor field of the response to get the next page of results. If there are more results available, more will be true.
limit : (optional) Specify the number of items to return. Default is 200.
Request
Parameters
Values in the path and query string.
appid path string TalkLabs ID required
The TalkLabs application ID assigned to your account.
Example:your-app-id limit query integer · int32
The maximum number of records to return.
Example:200 cursor query string
The cursor returned by the previous page.
filterByName query string
filterById query string
filterByCustomId query string customer-defined
Response
Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 403 Forbidden ApiResult 500 Internal Server Error ApiResult Example response · 200
{
"message": "Success",
"errors": {},
"data": {
"kind": "list.chatrooms",
"cursor": "5ec3c1945617e21bd8c5567b",
"more": false,
"itemcount": 1,
"rooms": [
{
"kind": "chat.room",
"id": "5ec3c1945617e21bd8c5567b",
"appid": "5ebbe03d5617e00de4b044c2",
"ownerid": "userid_abe",
"name": "ROOM HAS NEW NAME",
"description": "Live from the top of the Empire State Building",
"customtype": "",
"customid": "new-york-city-club",
"custompayload": "",
"customtags": [],
"customfield1": "",
"customfield2": "",
"enableactions": true,
"enableenterandexit": true,
"open": true,
"inroom": 0,
"added": "2020-05-19T11:23:00.3049587Z",
"whenmodified": "2020-05-20T03:54:04.4814629Z",
"moderation": "post",
"maxreports": 0,
"enableprofanityfilter": true,
"delaymessageseconds": 0
}
]
}
}