View Channels
Get User Channels
GET https://api.talkplus.io/v1.4/api/users/:userId/channels
Get list of channels user has joined
Path Parameters
Name
Type
Description
userId*
string
Query Parameters
Name
Type
Description
category
string
category filter
subcategory
string
subcategory filter
lastChannelId
string
Last channel ID to query from (use for pagination)
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"channels": [
{
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 1,
"lastReadAt": 1583914400,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
],
"hasNext": false
}Get User's Hidden Channels
GET https://api.talkplus.io/v1.4/api/users/:userId/channels/hidden
Get list of user's hidden channels
Path Parameters
Name
Type
Description
userId*
string
Query Parameters
Name
Type
Description
lastChannelId
string
Last channel ID to query from (use for pagination)
Headers
Name
Type
Description
app-id*
string
App ID
api-key*
string
App API key
{
"channels": [
{
"id": "channel123",
"name": "MyFirstChannel",
"ownerId": "user123",
"type": "private",
"imageUrl": "image url",
"invitationCode": "",
"isFrozen": false,
"hideMessagesBeforeJoin": false,
"category": "",
"subcategory": "",
"privateTag": "",
"privateData": {},
"memberCount": 2,
"maxMemberCount": 100,
"data": {
"someMetaKey1": "someMetaValue1",
"someMetaKey2": "someMetaValue2"
},
"members": [
{
"id": "user123",
"username": "john",
"profileImageUrl": "http://cnd.test.com/123.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
},
{
"id": "user456",
"username": "james",
"profileImageUrl": "http://cnd.test.com/456.jpg",
"data": {},
"memberInfo": {},
"lastReadAt": 1583924400,
"lastSentAt": 1583924400,
"updatedAt": 1583924400,
"createdAt": 1583921400
}
],
"mutedUsers": [],
"bannedUsers": [],
"bots": [],
"updatedAt": 1583924400,
"createdAt": 1583921400,
"unreadCount": 1,
"lastReadAt": 1583914400,
"lastMessage": {
"id": "sdf2l5s9j",
"channelId": "channel123",
"userId": "user456",
"username": "myUsername",
"profileImageUrl": "http://cdn.test.com/123.jpg",
"type": "message",
"text": "Hello world",
"data": {
"customField": "customData"
},
"parentMessage": {},
"reactions": {"happy": 1},
"createdAt": 1583921400
}
}
],
"hasNext": false
}Last updated