View Channel List

Get Channels

GET https://api.talkplus.io/v1.4/api/channels

Get all channels

Query Parameters

Name	Type	Description
type	string	default: "all" Use one of: - "all" - "all_private" - "all_public" - "all_broadcast" - "private" - "public" - "invitationOnly" - "broadcast" - "super_private" - "super_public" - "super_broadcast"
category	string	category filter
subcategory	string	subcategory filter
lastChannelId	string	Last channel ID to query from (use for pagination)
limit	integer	default: 20, max: 100

Headers

Name	Type	Description
app-id*	string	App ID
api-key*	string	App API key

200

{
  "channels": [
    {
      "id": "channel123",
      "name": "MyFirstChannel",
      "ownerId": "user123",
      "type": "private",
      "imageUrl": "image url",
      "data": {
        "someMetaKey1": "someMetaValue1",
        "someMetaKey2": "someMetaValue2"
      },
      "isFrozen": false,
      "hideMessagesBeforeJoin": false,
      "category": "", 
      "subcategory": "",
      "privateTag": "",
      "privateData": {},
      "memberCount": 2,
      "maxMemberCount": 100,
      "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": 0,
      "lastReadAt": 0,
      "lastMessage": {
        "id": "sdf2l5s9j",
        "channelId": "channel123",
        "userId": "user123",
        "username": "user123",
        "profileImageUrl": "http://cdn.test.com/123.jpg",
        "type": "message",
        "text": "Hello world",
        "data": {
          "customField": "customData"
        },
        "parentMessage": {},
        "reactions": {"happy": 1},
        "createdAt": 1583921400
      }
    }
  ],
  "hasNext": false
}

500 Error Response

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}

Get Channel Summaries

GET https://api.talkplus.io/v1.4/api/channels?summarize=true

Get channel summaries

Query Parameters

Name	Type	Description
type	string	default: "all" Use one of: - "all" - "all_private" - "all_public" - "all_broadcast" - "private" - "public" - "invitationOnly" - "broadcast" - "super_private" - "super_public" - "super_broadcast"
category	string	category filter
subcategory	string	subcategory filter
lastChannelId	string	Last channel ID to query from (use for pagination)
limit	integer	default: 20, max: 100

Headers

Name	Type	Description
app-id*	string	App ID
api-key*	string	App API key

200

{
  "channelSummaries": [
    {
      "id": "channel123",
      "name": "MyFirstChannel",
      "ownerId": "user123",
      "type": "private",
      "imageUrl": "image url",
      "data": {
        "someMetaKey1": "someMetaValue1",
        "someMetaKey2": "someMetaValue2"
      },
      "category": "",
      "subcategory": "",
      "memberCount": 2,
      "maxMemberCount": 100
    }
  ],
  "hasNext": false
}

500 Error Response

{
  "error": true,
  "code": "1006",
  "message": "Unauthorized"
}