Get Room Extended Details Batch
This method lets you specify a list of entity types to return.
This method lets you specify a list of entity types to return. You can use it to get room details as well as statistics and other data associated with a room that is not part of the room entity.
You must specify one or more roomid values or customid values. You may optionally provide both roomid and customid values. You may not request more than 20 rooms at once total. You must specify at least one entity type.
In the future, each entity requested will count towards your API usage quota, so don't request data you will not be using.
The response will be a list of RoomExtendedDetails objects. They contain properties such as room, mostrecentmessagetime, and inroom. These properties will be null if their entity type is not specified.
URL Parameters
- roomid : (optional) A list of room IDs.
- customid : (optional) A list of room customIDs.
- entity : (required) Specify one or more ENTITY TYPES to include in the response. Use one or more of the types below.
- room : This returns the room entity.
- numparticipants : This returns number of active participants / room subscribers.
- lastmessagetime : This returns the time stamp for the most recent event that is a visible displayable message (speech, quote, threaded reply or announcement).
Parameters
Values in the path and query string.
appid path The TalkLabs application ID assigned to your account.
Example:your-app-id roomid query The TalkLabs assigned room ID returned when the room was created.
Example:room-id customid query A customer defined ID chosen by your application. TalkLabs stores it so you can retrieve the resource without keeping its TalkLabs ID.
Example:live-event-chat entity query 1 Status codes
Every JSON response uses the API result envelope.
200 OK ApiResult 400 Bad Request ApiResult 403 Forbidden ApiResult 404 Not Found ApiResult 500 Internal Server Error ApiResult {
"message": "",
"errors": {},
"data": {
"kind": "chat.room.list.extendeddetails",
"details": [
{
"room": {
"kind": "chat.room",
"id": "601b44620dc9ec1af01775ff",
"appid": "600a193386c292217434a82c",
"ownerid": null,
"name": "New York City Chat (Post-Moderated)",
"description": "Live from the top of the Empire State Building",
"pictureurl": "",
"customtype": "",
"customid": "new-york-city-club",
"custompayload": "",
"customtags": [],
"customfield1": "",
"customfield2": "",
"enableactions": true,
"enableenterandexit": true,
"open": true,
"inroom": 2386,
"added": "2021-02-04T00:48:34.7165009Z",
"whenmodified": "2021-02-16T10:41:52.9094331Z",
"moderation": "post",
"maxreports": 0,
"enableprofanityfilter": true,
"delaymessageseconds": 0,
"bouncedusers": [],
"reportedusers": []
},
"mostrecentmessagetime": null,
"inroom": 0
}
]
}
}