List User Subscribed Rooms
Use this method to cursor through all the rooms the user is subscribed to.
This method requires authentication.
Use this method to cursor through all the rooms the user is subscribed to. This will include all rooms. If you want to build a private messaging experience, you can put custom tags on the rooms to separate out which are for private messenger and which are public group rooms.
To cursor through the results if there are many participants, invoke this function many times. Each result will return a cursor value and you can pass that value to the next invokation to get the next page of results. The result set will also include a next field with the full URL to get the next page, so you can just keep reading that and requesting that URL until you reach the end. When you reach the end, no more results will be returned or the result set will be less than maxresults and the next field will be empty.
Parameters
Values in the path and query string.
appid path The TalkLabs application ID assigned to your account.
Example:your-app-id userid path The customer defined user ID from your application or identity system.
Example:u-8842 Cursor query The cursor returned by the previous page.
Limit query The maximum number of records to return.
Example:50 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": "Success",
"errors": {},
"data": {
"kind": "list.userroomsubscriptions",
"cursor": "6391e369b524fb507cc278e7|63968e70664b8d01949058ba|userid_abe",
"more": false,
"itemcount": 1,
"subscriptions": [
{
"kind": "chat.subscription",
"id": "6391e369b524fb507cc278e7|63968e70664b8d01949058ba|userid_abe",
"roomid": "63968e70664b8d01949058ba",
"roomcustomid": "new-york-city-club",
"userid": "userid_abe",
"updated": "2022-12-12T02:14:17.975Z",
"added": "2022-12-12T02:14:17.975Z",
"roomname": "New York City Chat (Post-Moderated)",
"roomcustomtags": [],
"persist": false
}
]
}
}